Top Description Fields Constructors Methods
io.undertow.servlet.spec

public Class ServletCookieAdaptor

extends Object
implements Cookie
Class Inheritance
All Implemented Interfaces
io.undertow.server.handlers.Cookie, java.lang.Comparable
Imports
java.util.Arrays, .Date, io.undertow.UndertowMessages, io.undertow.server.handlers.Cookie, .CookieSameSiteMode, io.undertow.servlet.UndertowServletLogger, .UndertowServletMessages

Adaptor between and undertow and a servlet cookie
Authors
Stuart Douglas, Richard Opalka

Field Summary

Modifier and TypeField and Description
private final Cookie
private boolean
private String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public final int
compareTo(final Object
the object to be compared.
other
)

Overrides default io.undertow.server.handlers.Cookie.compareTo.

Compares this object with the specified object for order.

public final boolean
equals(final Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String
public String
public Date
public Integer
public String
public String
public String
public String
public int
public final int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
public boolean
public boolean
public boolean
public Cookie
public Cookie
public Cookie
public Cookie
public Cookie
public Cookie
public Cookie
public Cookie
setSameSite(final boolean sameSite)

Overrides default io.undertow.server.handlers.Cookie.setSameSite.

public Cookie
public Cookie
public Cookie
public Cookie
public final String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

sameSiteback to summary
private boolean sameSite
sameSiteModeback to summary
private String sameSiteMode

Constructor Detail

ServletCookieAdaptorback to summary
public ServletCookieAdaptor(final Cookie cookie)

Method Detail

compareToback to summary
public final int compareTo(final Object other)

Overrides default io.undertow.server.handlers.Cookie.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:Object

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public final boolean equals(final Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getCommentback to summary
public String getComment()

Implements io.undertow.server.handlers.Cookie.getComment.

Annotations
@Override
getDomainback to summary
public String getDomain()

Implements io.undertow.server.handlers.Cookie.getDomain.

Annotations
@Override
getExpiresback to summary
public Date getExpires()

Implements io.undertow.server.handlers.Cookie.getExpires.

Annotations
@Override
getMaxAgeback to summary
public Integer getMaxAge()

Implements io.undertow.server.handlers.Cookie.getMaxAge.

Annotations
@Override
getNameback to summary
public String getName()

Implements io.undertow.server.handlers.Cookie.getName.

Annotations
@Override
getPathback to summary
public String getPath()

Implements io.undertow.server.handlers.Cookie.getPath.

Annotations
@Override
getSameSiteModeback to summary
public String getSameSiteMode()

Overrides default io.undertow.server.handlers.Cookie.getSameSiteMode.

Annotations
@Override
getValueback to summary
public String getValue()

Implements io.undertow.server.handlers.Cookie.getValue.

Annotations
@Override
getVersionback to summary
public int getVersion()

Implements io.undertow.server.handlers.Cookie.getVersion.

Annotations
@Override
hashCodeback to summary
public final int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isDiscardback to summary
public boolean isDiscard()

Implements io.undertow.server.handlers.Cookie.isDiscard.

Annotations
@Override
isHttpOnlyback to summary
public boolean isHttpOnly()

Implements io.undertow.server.handlers.Cookie.isHttpOnly.

Annotations
@Override
isSameSiteback to summary
public boolean isSameSite()

Overrides default io.undertow.server.handlers.Cookie.isSameSite.

Annotations
@Override
isSecureback to summary
public boolean isSecure()

Implements io.undertow.server.handlers.Cookie.isSecure.

Annotations
@Override
setCommentback to summary
public Cookie setComment(final String comment)

Implements io.undertow.server.handlers.Cookie.setComment.

Annotations
@Override
setDiscardback to summary
public Cookie setDiscard(final boolean discard)

Implements io.undertow.server.handlers.Cookie.setDiscard.

Annotations
@Override
setDomainback to summary
public Cookie setDomain(final String domain)

Implements io.undertow.server.handlers.Cookie.setDomain.

Annotations
@Override
setExpiresback to summary
public Cookie setExpires(final Date expires)

Implements io.undertow.server.handlers.Cookie.setExpires.

Annotations
@Override
setHttpOnlyback to summary
public Cookie setHttpOnly(final boolean httpOnly)

Implements io.undertow.server.handlers.Cookie.setHttpOnly.

Annotations
@Override
setMaxAgeback to summary
public Cookie setMaxAge(final Integer maxAge)

Implements io.undertow.server.handlers.Cookie.setMaxAge.

Annotations
@Override
setPathback to summary
public Cookie setPath(final String path)

Implements io.undertow.server.handlers.Cookie.setPath.

Annotations
@Override
setSameSiteback to summary
public Cookie setSameSite(final boolean sameSite)

Overrides default io.undertow.server.handlers.Cookie.setSameSite.

Annotations
@Override
setSameSiteModeback to summary
public Cookie setSameSiteMode(final String mode)

Overrides default io.undertow.server.handlers.Cookie.setSameSiteMode.

Annotations
@Override
setSecureback to summary
public Cookie setSecure(final boolean secure)

Implements io.undertow.server.handlers.Cookie.setSecure.

Annotations
@Override
setValueback to summary
public Cookie setValue(final String value)

Implements io.undertow.server.handlers.Cookie.setValue.

Annotations
@Override
setVersionback to summary
public Cookie setVersion(final int version)

Implements io.undertow.server.handlers.Cookie.setVersion.

Annotations
@Override
toStringback to summary
public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override