Undertow 2.3.12.Final · io.undertow.servlet.spec.SessionCookieConfigImpl

Modifier and Type	Field and Description
private final Map<String, String>	attributes
private static final String	COOKIE_COMMENT_ATTR
private static final String	COOKIE_DOMAIN_ATTR
private static final String	COOKIE_HTTP_ONLY_ATTR
private static final String	COOKIE_MAX_AGE_ATTR
private static final String	COOKIE_PATH_ATTR
private static final String	COOKIE_SECURE_ATTR
private static final boolean	DEFAULT_HTTP_ONLY
private static final int	DEFAULT_MAX_AGE
private static final boolean	DEFAULT_SECURE
private final SessionCookieConfig	delegate
private SessionConfig	fallback
private final ServletContextImpl	servletContext

Access	Constructor and Description
public	SessionCookieConfigImpl(final ServletContextImpl servletContext)

Method Summary

Modifier and Type	Method and Description
public void	clearSession(final HttpServerExchange The exchange exchange, final String The session id sessionId) Implements io.undertow.server.session.SessionConfig.clearSession. Clears this session from the exchange, removing the attachment and making any changes to the response necessary, such as clearing cookies.
public String	findSessionId(final HttpServerExchange The exchange exchange) Implements io.undertow.server.session.SessionConfig.findSessionId. Retrieves a session id of an existing session from an exchange.
public String	getAttribute(final String Name of attribute to return, case insensitive name) Implements jakarta.servlet.SessionCookieConfig.getAttribute. Obtain the value for a given session cookie attribute.
public Map<String, String>	getAttributes() Implements jakarta.servlet.SessionCookieConfig.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	getComment() Implements jakarta.servlet.SessionCookieConfig.getComment. Deprecated With the adoption of support for RFC 6265, this method should no longer be used.
public String	getDomain() Implements jakarta.servlet.SessionCookieConfig.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 SessionConfig	getFallback()
public int	getMaxAge() Implements jakarta.servlet.SessionCookieConfig.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	getName() Implements jakarta.servlet.SessionCookieConfig.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	getPath() Implements jakarta.servlet.SessionCookieConfig.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	isHttpOnly() Implements jakarta.servlet.SessionCookieConfig.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	isSecure() Implements jakarta.servlet.SessionCookieConfig.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 String	rewriteUrl(final String originalUrl, final String sessionid) Implements io.undertow.server.session.SessionConfig.rewriteUrl.
public SessionConfig.SessionCookieSource	sessionCookieSource(HttpServerExchange exchange) Implements io.undertow.server.session.SessionConfig.sessionCookieSource.
public void	setAttribute(final String Name of attribute to set, case insensitive name, final String Value of attribute value) Implements jakarta.servlet.SessionCookieConfig.setAttribute. Sets the value for the given session cookie attribute.
public void	setComment(final String ignore comment) Implements jakarta.servlet.SessionCookieConfig.setComment. Deprecated With the adoption of support for RFC 6265, this method should no longer be used.
public void	setDomain(final String the cookie domain to use domain) Implements jakarta.servlet.SessionCookieConfig.setDomain. 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	setFallback(final SessionConfig fallback)
public void	setHttpOnly(final 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) Implements jakarta.servlet.SessionCookieConfig.setHttpOnly. 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(final 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) Implements jakarta.servlet.SessionCookieConfig.setMaxAge. 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(final String the cookie name to use name) Implements jakarta.servlet.SessionCookieConfig.setName. 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(final String the cookie path to use path) Implements jakarta.servlet.SessionCookieConfig.setPath. 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(final 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) Implements jakarta.servlet.SessionCookieConfig.setSecure. 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.
public void	setSessionId(final HttpServerExchange The exchange exchange, final String The session sessionId) Implements io.undertow.server.session.SessionConfig.setSessionId. Attaches the session to the exchange.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

attributes	back to summary
private final Map<String, String> attributes

DEFAULT_HTTP_ONLY	back to summary
private static final boolean DEFAULT_HTTP_ONLY

DEFAULT_MAX_AGE	back to summary
private static final int DEFAULT_MAX_AGE

DEFAULT_SECURE	back to summary
private static final boolean DEFAULT_SECURE

delegate	back to summary
private final SessionCookieConfig delegate

fallback	back to summary
private SessionConfig fallback

servletContext	back to summary
private final ServletContextImpl servletContext

Method Detail

clearSession	back to summary
public void clearSession(final HttpServerExchange exchange, final String sessionId) Implements io.undertow.server.session.SessionConfig.clearSession. Doc from io.undertow.server.session.SessionConfig.clearSession. Clears this session from the exchange, removing the attachment and making any changes to the response necessary, such as clearing cookies. Parameters exchange:HttpServerExchange The exchange sessionId:String The session id Annotations @Override

clearSession

back to summary

public void clearSession(final HttpServerExchange exchange, final String sessionId)

Implements io.undertow.server.session.SessionConfig.clearSession.

Doc from io.undertow.server.session.SessionConfig.clearSession.

Clears this session from the exchange, removing the attachment and making any changes to the response necessary, such as clearing cookies.

Parameters

exchange:HttpServerExchange: The exchange
sessionId:String: The session id

Annotations

@Override

findSessionId	back to summary
public String findSessionId(final HttpServerExchange exchange) Implements io.undertow.server.session.SessionConfig.findSessionId. Doc from io.undertow.server.session.SessionConfig.findSessionId. Retrieves a session id of an existing session from an exchange. Parameters exchange:HttpServerExchange The exchange Returns:String The session id, or null Annotations @Override

findSessionId

back to summary

public String findSessionId(final HttpServerExchange exchange)

Implements io.undertow.server.session.SessionConfig.findSessionId.

Doc from io.undertow.server.session.SessionConfig.findSessionId.

Retrieves a session id of an existing session from an exchange.

Parameters

exchange:HttpServerExchange: The exchange

Returns:String

The session id, or null

Annotations

@Override

getAttribute	back to summary
public String getAttribute(final String name) Implements jakarta.servlet.SessionCookieConfig.getAttribute. Doc from jakarta.servlet.SessionCookieConfig.getAttribute. 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 Annotations @Override

getAttribute

back to summary

public String getAttribute(final String name)

Implements jakarta.servlet.SessionCookieConfig.getAttribute.

Doc from jakarta.servlet.SessionCookieConfig.getAttribute.

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

Annotations

@Override

getAttributes back to summary

getAttributes	back to summary
public Map<String, String> getAttributes() Implements jakarta.servlet.SessionCookieConfig.getAttributes. Doc from jakarta.servlet.SessionCookieConfig.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. Annotations @Override

public Map<String, String> getAttributes()

Implements jakarta.servlet.SessionCookieConfig.getAttributes.

Doc from jakarta.servlet.SessionCookieConfig.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.

Annotations

@Override

getComment back to summary

getComment	back to summary
public String getComment() Implements jakarta.servlet.SessionCookieConfig.getComment. Doc from jakarta.servlet.SessionCookieConfig.getComment. Deprecated With the adoption of support for RFC 6265, this method should no longer be used. Returns:String Always `null` Annotations @Deprecated

public String getComment()

Implements jakarta.servlet.SessionCookieConfig.getComment.

Doc from jakarta.servlet.SessionCookieConfig.getComment.

Deprecated

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

Returns:String

Always null

Annotations

@Deprecated

getDomain back to summary

getDomain	back to summary
public String getDomain() Implements jakarta.servlet.SessionCookieConfig.getDomain. Doc from jakarta.servlet.SessionCookieConfig.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

public String getDomain()

Implements jakarta.servlet.SessionCookieConfig.getDomain.

Doc from jakarta.servlet.SessionCookieConfig.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

getFallback	back to summary
public SessionConfig getFallback()

getMaxAge back to summary

getMaxAge	back to summary
public int getMaxAge() Implements jakarta.servlet.SessionCookieConfig.getMaxAge. Doc from jakarta.servlet.SessionCookieConfig.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)

public int getMaxAge()

Implements jakarta.servlet.SessionCookieConfig.getMaxAge.

Doc from jakarta.servlet.SessionCookieConfig.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)

getName back to summary

getName	back to summary
public String getName() Implements jakarta.servlet.SessionCookieConfig.getName. Doc from jakarta.servlet.SessionCookieConfig.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

public String getName()

Implements jakarta.servlet.SessionCookieConfig.getName.

Doc from jakarta.servlet.SessionCookieConfig.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

getPath back to summary

getPath	back to summary
public String getPath() Implements jakarta.servlet.SessionCookieConfig.getPath. Doc from jakarta.servlet.SessionCookieConfig.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

public String getPath()

Implements jakarta.servlet.SessionCookieConfig.getPath.

Doc from jakarta.servlet.SessionCookieConfig.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

isHttpOnly back to summary

isHttpOnly	back to summary
public boolean isHttpOnly() Implements jakarta.servlet.SessionCookieConfig.isHttpOnly. Doc from jakarta.servlet.SessionCookieConfig.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

public boolean isHttpOnly()

Implements jakarta.servlet.SessionCookieConfig.isHttpOnly.

Doc from jakarta.servlet.SessionCookieConfig.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

isSecure back to summary

isSecure	back to summary
public boolean isSecure() Implements jakarta.servlet.SessionCookieConfig.isSecure. Doc from jakarta.servlet.SessionCookieConfig.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

public boolean isSecure()

Implements jakarta.servlet.SessionCookieConfig.isSecure.

Doc from jakarta.servlet.SessionCookieConfig.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

rewriteUrl	back to summary
public String rewriteUrl(final String originalUrl, final String sessionid) Implements io.undertow.server.session.SessionConfig.rewriteUrl. Annotations @Override

rewriteUrl

back to summary

public String rewriteUrl(final String originalUrl, final String sessionid)

Implements io.undertow.server.session.SessionConfig.rewriteUrl.

Annotations

@Override

sessionCookieSource

back to summary

public SessionConfig.SessionCookieSource sessionCookieSource(HttpServerExchange exchange)

Implements io.undertow.server.session.SessionConfig.sessionCookieSource.

Annotations

@Override

setAttribute	back to summary
public void setAttribute(final String name, final String value) Implements jakarta.servlet.SessionCookieConfig.setAttribute. Doc from jakarta.servlet.SessionCookieConfig.setAttribute. 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 Annotations @Override

setAttribute

back to summary

public void setAttribute(final String name, final String value)

Implements jakarta.servlet.SessionCookieConfig.setAttribute.

Doc from jakarta.servlet.SessionCookieConfig.setAttribute.

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

Annotations

@Override

setComment	back to summary
public void setComment(final String comment) Implements jakarta.servlet.SessionCookieConfig.setComment. Doc from jakarta.servlet.SessionCookieConfig.setComment. Deprecated 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

setComment

back to summary

public void setComment(final String comment)

Implements jakarta.servlet.SessionCookieConfig.setComment.

Doc from jakarta.servlet.SessionCookieConfig.setComment.

Deprecated

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

setDomain back to summary

setDomain	back to summary
public void setDomain(final String domain) Implements jakarta.servlet.SessionCookieConfig.setDomain. Doc from jakarta.servlet.SessionCookieConfig.setDomain. 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

public void setDomain(final String domain)

Implements jakarta.servlet.SessionCookieConfig.setDomain.

Doc from jakarta.servlet.SessionCookieConfig.setDomain.

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

setFallback	back to summary
public void setFallback(final SessionConfig fallback)

setHttpOnly back to summary

setHttpOnly	back to summary
public void setHttpOnly(final boolean httpOnly) Implements jakarta.servlet.SessionCookieConfig.setHttpOnly. Doc from jakarta.servlet.SessionCookieConfig.setHttpOnly. 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

public void setHttpOnly(final boolean httpOnly)

Implements jakarta.servlet.SessionCookieConfig.setHttpOnly.

Doc from jakarta.servlet.SessionCookieConfig.setHttpOnly.

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

setMaxAge back to summary

setMaxAge	back to summary
public void setMaxAge(final int maxAge) Implements jakarta.servlet.SessionCookieConfig.setMaxAge. Doc from jakarta.servlet.SessionCookieConfig.setMaxAge. 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.

public void setMaxAge(final int maxAge)

Implements jakarta.servlet.SessionCookieConfig.setMaxAge.

Doc from jakarta.servlet.SessionCookieConfig.setMaxAge.

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.

setName back to summary

setName	back to summary
public void setName(final String name) Implements jakarta.servlet.SessionCookieConfig.setName. Doc from jakarta.servlet.SessionCookieConfig.setName. 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

public void setName(final String name)

Implements jakarta.servlet.SessionCookieConfig.setName.

Doc from jakarta.servlet.SessionCookieConfig.setName.

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

setPath back to summary

setPath	back to summary
public void setPath(final String path) Implements jakarta.servlet.SessionCookieConfig.setPath. Doc from jakarta.servlet.SessionCookieConfig.setPath. 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

public void setPath(final String path)

Implements jakarta.servlet.SessionCookieConfig.setPath.

Doc from jakarta.servlet.SessionCookieConfig.setPath.

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

setSecure back to summary

setSecure	back to summary
public void setSecure(final boolean secure) Implements jakarta.servlet.SessionCookieConfig.setSecure. Doc from jakarta.servlet.SessionCookieConfig.setSecure. 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

public void setSecure(final boolean secure)

Implements jakarta.servlet.SessionCookieConfig.setSecure.

Doc from jakarta.servlet.SessionCookieConfig.setSecure.

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

setSessionId back to summary

setSessionId	back to summary
public void setSessionId(final HttpServerExchange exchange, final String sessionId) Implements io.undertow.server.session.SessionConfig.setSessionId. Doc from io.undertow.server.session.SessionConfig.setSessionId. Attaches the session to the exchange. The method should attach the exchange under an attachment key, and should also modify the exchange to allow the session to be re-attached on the next request. Generally this will involve setting a cookie Once a session has been attached it must be possible to retrieve it via `findSessionId(io.undertow.server.HttpServerExchange)` Parameters exchange:HttpServerExchange The exchange sessionId:String The session Annotations @Override

public void setSessionId(final HttpServerExchange exchange, final String sessionId)

Implements io.undertow.server.session.SessionConfig.setSessionId.

Doc from io.undertow.server.session.SessionConfig.setSessionId.

Attaches the session to the exchange. The method should attach the exchange under an attachment key, and should also modify the exchange to allow the session to be re-attached on the next request.

Generally this will involve setting a cookie

Once a session has been attached it must be possible to retrieve it via findSessionId(io.undertow.server.HttpServerExchange)

Parameters

exchange:HttpServerExchange: The exchange
sessionId:String: The session

Annotations

@Override

public Class SessionCookieConfigImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail