Jakarta EE 11.0.0 · jakarta.servlet.SessionCookieConfig

Method Summary

Modifier and Type	Method and Description
public String	Returns: Value of specified attribute getAttribute(String Name of attribute to return, case insensitive name) Obtain the value for a given session cookie attribute.
public Map<String, String>	Returns: A read-only Map of attributes to values, excluding version. getAttributes() Obtain the Map (keys are case insensitive) of all attributes and values, including those set via the attribute specific setters, (excluding version) for this `SessionCookieConfig`.
public String	Returns: Always `null` getComment() Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used.
public String	Returns: the cookie domain set via `setDomain`, or `null` if `setDomain` was never called getDomain() Gets the domain name that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired.
public int	Returns: the lifetime (in seconds) of the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired, or `-1` (the default) getMaxAge() Gets the lifetime (in seconds) of the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired.
public String	Returns: the cookie name set via `setName`, or `null` if `setName` was never called getName() Gets the name that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired.
public String	Returns: the cookie path set via `setPath`, or `null` if `setPath` was never called getPath() Gets the path that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired.
public boolean	Returns: true if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired will be marked as HttpOnly, false otherwise isHttpOnly() Checks if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired will be marked as HttpOnly.
public boolean	Returns: true if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired will be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS, and false if they will be marked as secure only if the request that initiated the corresponding session was also secure isSecure() Checks if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired will be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS.
public void	setAttribute(String Name of attribute to set, case insensitive name, String Value of attribute value) Sets the value for the given session cookie attribute.
public void	setComment(String ignore comment) Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used.
public void	setDomain(String the cookie domain to use domain) Sets the domain name that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired.
public void	setHttpOnly(boolean true if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired shall be marked as HttpOnly, false otherwise httpOnly) Marks or unmarks the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired as HttpOnly.
public void	setMaxAge(int the lifetime (in seconds) of the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired. maxAge) Sets the lifetime (in seconds) for the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired.
public void	setName(String the cookie name to use name) Sets the name that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired.
public void	setPath(String the cookie path to use path) Sets the path that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired.
public void	setSecure(boolean true if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired shall be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS, and false if they shall be marked as secure only if the request that initiated the corresponding session was also secure secure) Marks or unmarks the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired as secure.

Method Detail

getAttribute	back to summary
public String getAttribute(String name) Obtain the value for a given session cookie attribute. Values returned from this method must be consistent with the values set and returned by the attribute specific getters and setters in this class. Parameters name:String Name of attribute to return, case insensitive Returns:String Value of specified attribute Since Servlet 6.0

getAttribute

back to summary

public String getAttribute(String name)

Obtain the value for a given session cookie attribute. Values returned from this method must be consistent with the values set and returned by the attribute specific getters and setters in this class.

Parameters

name:String: Name of attribute to return, case insensitive

Returns:String

Value of specified attribute

Since

Servlet 6.0

getAttributes back to summary

getAttributes	back to summary
public Map<String, String> getAttributes() Obtain the Map (keys are case insensitive) of all attributes and values, including those set via the attribute specific setters, (excluding version) for this `SessionCookieConfig`. Returns:Map<String, String> A read-only Map of attributes to values, excluding version. Since Servlet 6.0

public Map<String, String> getAttributes()

Obtain the Map (keys are case insensitive) of all attributes and values, including those set via the attribute specific setters, (excluding version) for this SessionCookieConfig.

Returns:Map<String, String>: A read-only Map of attributes to values, excluding version.
Since: Servlet 6.0

getComment back to summary

getComment	back to summary
public String getComment() Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used. Returns:String Always `null` Annotations @Deprecated since:Servlet 6.0 forRemoval:true See Also `jakarta.servlet.http.Cookie#getComment()`

public String getComment()

Deprecated

for removal since Servlet 6.0.

This is no longer required with RFC 6265

With the adoption of support for RFC 6265, this method should no longer be used.

Returns:String

Always null

Annotations

@Deprecated
since:Servlet 6.0
forRemoval:true

getDomain back to summary

getDomain	back to summary
public String getDomain() Gets the domain name that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired. Returns:String the cookie domain set via `setDomain`, or `null` if `setDomain` was never called See Also `jakarta.servlet.http.Cookie#getDomain()`

public String getDomain()

Gets the domain name that will be assigned to any session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired.

Returns:String: the cookie domain set via setDomain, or null if setDomain was never called
See Also: jakarta.servlet.http.Cookie#getDomain()

getMaxAge back to summary

getMaxAge	back to summary
public int getMaxAge() Gets the lifetime (in seconds) of the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired. By default, `-1` is returned. Returns:int the lifetime (in seconds) of the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired, or `-1` (the default) See Also `jakarta.servlet.http.Cookie#getMaxAge`

public int getMaxAge()

Gets the lifetime (in seconds) of the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired.

By default, -1 is returned.

Returns:int: the lifetime (in seconds) of the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired, or -1 (the default)
See Also: jakarta.servlet.http.Cookie#getMaxAge

getName back to summary

getName	back to summary
public String getName() Gets the name that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired. By default, `JSESSIONID` will be used as the cookie name. Returns:String the cookie name set via `setName`, or `null` if `setName` was never called See Also `jakarta.servlet.http.Cookie#getName()`

public String getName()

Gets the name that will be assigned to any session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired.

By default, JSESSIONID will be used as the cookie name.

Returns:String: the cookie name set via setName, or null if setName was never called
See Also: jakarta.servlet.http.Cookie#getName()

getPath back to summary

getPath	back to summary
public String getPath() Gets the path that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired. By default, the context path of the `ServletContext` from which this `SessionCookieConfig` was acquired will be used. Returns:String the cookie path set via `setPath`, or `null` if `setPath` was never called See Also `jakarta.servlet.http.Cookie#getPath()`

public String getPath()

Gets the path that will be assigned to any session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired.

By default, the context path of the ServletContext from which this SessionCookieConfig was acquired will be used.

Returns:String: the cookie path set via setPath, or null if setPath was never called
See Also: jakarta.servlet.http.Cookie#getPath()

isHttpOnly back to summary

isHttpOnly	back to summary
public boolean isHttpOnly() Checks if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired will be marked as HttpOnly. Returns:boolean true if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired will be marked as HttpOnly, false otherwise See Also `jakarta.servlet.http.Cookie#isHttpOnly()`

public boolean isHttpOnly()

Checks if the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired will be marked as HttpOnly.

Returns:boolean: true if the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired will be marked as HttpOnly, false otherwise
See Also: jakarta.servlet.http.Cookie#isHttpOnly()

isSecure back to summary

isSecure	back to summary
public boolean isSecure() Checks if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired will be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS. Returns:boolean true if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired will be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS, and false if they will be marked as secure only if the request that initiated the corresponding session was also secure See Also `jakarta.servlet.http.Cookie#getSecure()`, `ServletRequest#isSecure()`

public boolean isSecure()

Checks if the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired will be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS.

Returns:boolean: true if the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired will be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS, and false if they will be marked as secure only if the request that initiated the corresponding session was also secure
See Also: jakarta.servlet.http.Cookie#getSecure(), ServletRequest#isSecure()

setAttribute	back to summary
public void setAttribute(String name, String value) Sets the value for the given session cookie attribute. When a value is set via this method, the value returned by the attribute specific getter (if any) must be consistent with the value set via this method. Parameters name:String Name of attribute to set, case insensitive value:String Value of attribute Exceptions IllegalStateException: if the associated ServletContext has already been initialised IllegalArgumentException: If the attribute name is null or contains any characters not permitted for use in Cookie names. NumberFormatException: If the attribute is known to be numerical but the provided value cannot be parsed to a number. Since Servlet 6.0

setAttribute

back to summary

public void setAttribute(String name, String value)

Sets the value for the given session cookie attribute. When a value is set via this method, the value returned by the attribute specific getter (if any) must be consistent with the value set via this method.

Parameters

name:String: Name of attribute to set, case insensitive
value:String: Value of attribute

Exceptions

IllegalStateException:: if the associated ServletContext has already been initialised
IllegalArgumentException:: If the attribute name is null or contains any characters not permitted for use in Cookie names.
NumberFormatException:: If the attribute is known to be numerical but the provided value cannot be parsed to a number.

Since

Servlet 6.0

setComment back to summary

setComment	back to summary
public void setComment(String comment) Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used. If called, this method has no effect. Parameters comment:String ignore Annotations @Deprecated since:Servlet 6.0 forRemoval:true Exceptions IllegalStateException: if the `ServletContext` from which this `SessionCookieConfig` was acquired has already been initialized See Also `jakarta.servlet.http.Cookie#setComment(String)`, `jakarta.servlet.http.Cookie#getVersion`

public void setComment(String comment)

Deprecated

for removal since Servlet 6.0.

This is no longer required with RFC 6265

With the adoption of support for RFC 6265, this method should no longer be used.

If called, this method has no effect.

Parameters

comment:String: ignore

Annotations

@Deprecated
since:Servlet 6.0
forRemoval:true

Exceptions

IllegalStateException:: if the ServletContext from which this SessionCookieConfig was acquired has already been initialized

setDomain back to summary

setDomain	back to summary
public void setDomain(String domain) Sets the domain name that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired. Parameters domain:String the cookie domain to use Exceptions IllegalStateException: if the `ServletContext` from which this `SessionCookieConfig` was acquired has already been initialized See Also `jakarta.servlet.http.Cookie#setDomain(String)`

public void setDomain(String domain)

Sets the domain name that will be assigned to any session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired.

Parameters

domain:String: the cookie domain to use

Exceptions

IllegalStateException:: if the ServletContext from which this SessionCookieConfig was acquired has already been initialized

setHttpOnly back to summary

setHttpOnly	back to summary
public void setHttpOnly(boolean httpOnly) Marks or unmarks the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired as HttpOnly. A cookie is marked as `HttpOnly` by adding the `HttpOnly` attribute to it. HttpOnly cookies are not supposed to be exposed to client-side scripting code, and may therefore help mitigate certain kinds of cross-site scripting attacks. Parameters httpOnly:boolean true if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired shall be marked as HttpOnly, false otherwise Exceptions IllegalStateException: if the `ServletContext` from which this `SessionCookieConfig` was acquired has already been initialized See Also `jakarta.servlet.http.Cookie#setHttpOnly(boolean)`

public void setHttpOnly(boolean httpOnly)

Marks or unmarks the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired as HttpOnly.

A cookie is marked as HttpOnly by adding the HttpOnly attribute to it. HttpOnly cookies are not supposed to be exposed to client-side scripting code, and may therefore help mitigate certain kinds of cross-site scripting attacks.

Parameters

httpOnly:boolean: true if the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired shall be marked as HttpOnly, false otherwise

Exceptions

IllegalStateException:: if the ServletContext from which this SessionCookieConfig was acquired has already been initialized

setMaxAge back to summary

setMaxAge	back to summary
public void setMaxAge(int maxAge) Sets the lifetime (in seconds) for the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired. Parameters maxAge:int the lifetime (in seconds) of the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired. Exceptions IllegalStateException: if the `ServletContext` from which this `SessionCookieConfig` was acquired has already been initialized See Also `jakarta.servlet.http.Cookie#setMaxAge`

public void setMaxAge(int maxAge)

Sets the lifetime (in seconds) for the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired.

Parameters

maxAge:int: the lifetime (in seconds) of the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired.

Exceptions

IllegalStateException:: if the ServletContext from which this SessionCookieConfig was acquired has already been initialized

See Also

jakarta.servlet.http.Cookie#setMaxAge

setName back to summary

setName	back to summary
public void setName(String name) Sets the name that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired. Note Changing the name of session tracking cookies may break other tiers (for example, a load balancing frontend) that assume the cookie name to be equal to the default `JSESSIONID`, and therefore should only be done cautiously. Parameters name:String the cookie name to use Exceptions IllegalStateException: if the `ServletContext` from which this `SessionCookieConfig` was acquired has already been initialized

public void setName(String name)

Sets the name that will be assigned to any session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired.

Note

Changing the name of session tracking cookies may break other tiers (for example, a load balancing frontend) that assume the cookie name to be equal to the default JSESSIONID, and therefore should only be done cautiously.

Parameters

name:String: the cookie name to use

Exceptions

IllegalStateException:: if the ServletContext from which this SessionCookieConfig was acquired has already been initialized

setPath back to summary

setPath	back to summary
public void setPath(String path) Sets the path that will be assigned to any session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired. Parameters path:String the cookie path to use Exceptions IllegalStateException: if the `ServletContext` from which this `SessionCookieConfig` was acquired has already been initialized See Also `jakarta.servlet.http.Cookie#setPath(String)`

public void setPath(String path)

Sets the path that will be assigned to any session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired.

Parameters

path:String: the cookie path to use

Exceptions

IllegalStateException:: if the ServletContext from which this SessionCookieConfig was acquired has already been initialized

setSecure back to summary

setSecure	back to summary
public void setSecure(boolean secure) Marks or unmarks the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired as secure. One use case for marking a session tracking cookie as `secure`, even though the request that initiated the session came over HTTP, is to support a topology where the web container is front-ended by an SSL offloading load balancer. In this case, the traffic between the client and the load balancer will be over HTTPS, whereas the traffic between the load balancer and the web container will be over HTTP. Parameters secure:boolean true if the session tracking cookies created on behalf of the application represented by the `ServletContext` from which this `SessionCookieConfig` was acquired shall be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS, and false if they shall be marked as secure only if the request that initiated the corresponding session was also secure Exceptions IllegalStateException: if the `ServletContext` from which this `SessionCookieConfig` was acquired has already been initialized See Also `jakarta.servlet.http.Cookie#setSecure(boolean)`, `ServletRequest#isSecure()`

public void setSecure(boolean secure)

Marks or unmarks the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired as secure.

One use case for marking a session tracking cookie as secure, even though the request that initiated the session came over HTTP, is to support a topology where the web container is front-ended by an SSL offloading load balancer. In this case, the traffic between the client and the load balancer will be over HTTPS, whereas the traffic between the load balancer and the web container will be over HTTP.

Parameters

secure:boolean: true if the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired shall be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS, and false if they shall be marked as secure only if the request that initiated the corresponding session was also secure

Exceptions

IllegalStateException:: if the ServletContext from which this SessionCookieConfig was acquired has already been initialized

public Interface SessionCookieConfig

Method Summary

Method Detail