org.ops4j.pax.web.service.spi.config

Interface SessionConfiguration

public interface SessionConfiguration

While some session configuration parameters (those specified in web.xml and SessionCookieConfig) can be specified through WebContainer and during WAR deployment, some server-specific options can be configured only globally through PaxWebConstants.PID.

Global (this) configuration is also used when no context-specific session configuration is defined.

Method Summary

Modifier and Type	Method and Description
javax.servlet.SessionCookieConfig	getDefaultSessionCookieConfig() This method gathers some of individual session configuration parameters and returns ready to use SessionCookieConfig object.
String	getSessionCookieComment() <session-config>/<cookie-config>/<comment>
String	getSessionCookieDomain() <session-config>/<cookie-config>/<domain>
Boolean	getSessionCookieHttpOnly() <session-config>/<cookie-config>/<http-only>
Integer	getSessionCookieMaxAge() <session-config>/<cookie-config>/<max-age>
String	getSessionCookieName() <session-config>/<cookie-config>/<name> - if not specified, defaults to JSESSIONID
String	getSessionCookiePath() <session-config>/<cookie-config>/<path> - if not specified, it will match the context path.
String	getSessionCookieSameSite() No equivalent in web.xml.
Boolean	getSessionCookieSecure() <session-config>/<cookie-config>/<secure>
File	getSessionStoreDirectory() If getSessionStoreDirectoryLocation() returns valid location, this method returns the corresponding File object
String	getSessionStoreDirectoryLocation() All server runtimes allow configuration of file session persistence and with this property we can specify the persistent location (directory) of such session storage.
Integer	getSessionTimeout() <session-config>/<session-timeout> - returns the time in minutes after which an inative settion times out.
String	getSessionUrlPathParameter() Allows configuration of Jetty's SessionHandler.SessionIdPathParameterName.
String	getSessionWorkerName() PAXWEB-144: Allows configuration of Jetty's SessionHandler.SessionIdManager.workerName to assist session affinity in a load balancer.

Method Detail

getSessionTimeout

Integer getSessionTimeout()

<session-config>/<session-timeout> - returns the time in minutes after which an inative settion times out. Defaults to 30 minutes (as in Tomcat).

Returns:

timeout in minutes

getSessionCookieName

String getSessionCookieName()

<session-config>/<cookie-config>/<name> - if not specified, defaults to JSESSIONID

Returns:

getSessionCookieDomain

String getSessionCookieDomain()

<session-config>/<cookie-config>/<domain>

Returns:

getSessionCookiePath

String getSessionCookiePath()

<session-config>/<cookie-config>/<path> - if not specified, it will match the context path.

Returns:

getSessionCookieComment

String getSessionCookieComment()

<session-config>/<cookie-config>/<comment>

Returns:

getSessionCookieHttpOnly

Boolean getSessionCookieHttpOnly()

<session-config>/<cookie-config>/<http-only>

Returns:

getSessionCookieSecure

Boolean getSessionCookieSecure()

<session-config>/<cookie-config>/<secure>

Returns:

getSessionCookieMaxAge

Integer getSessionCookieMaxAge()

<session-config>/<cookie-config>/<max-age>

Returns:

getSessionCookieSameSite

String getSessionCookieSameSite()

No equivalent in web.xml. SameSite attribute for session cookie.

Returns:

getSessionUrlPathParameter

String getSessionUrlPathParameter()

Allows configuration of Jetty's SessionHandler.SessionIdPathParameterName. By default it's jsessionid.

Returns:

getSessionWorkerName

String getSessionWorkerName()

PAXWEB-144: Allows configuration of Jetty's SessionHandler.SessionIdManager.workerName to assist session affinity in a load balancer.

Returns:

getSessionStoreDirectoryLocation

String getSessionStoreDirectoryLocation()

All server runtimes allow configuration of file session persistence and with this property we can specify the persistent location (directory) of such session storage.

Returns:

getSessionStoreDirectory

File getSessionStoreDirectory()

If getSessionStoreDirectoryLocation() returns valid location, this method returns the corresponding File object

Returns:

getDefaultSessionCookieConfig

javax.servlet.SessionCookieConfig getDefaultSessionCookieConfig()

This method gathers some of individual session configuration parameters and returns ready to use SessionCookieConfig object.

Returns: