Module org.eclipse.jetty.session

Package org.eclipse.jetty.session

Interface SessionConfig

All Known Subinterfaces:

SessionConfig.Mutable, SessionManager

All Known Implementing Classes:

AbstractSessionManager, SessionHandler

public interface SessionConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SessionConfig.Mutable

Field Summary

Fields

Modifier and Type	Field	Description
static final String	__CheckRemoteSessionEncodingProperty
static final String	__DefaultSessionCookie
static final String	__DefaultSessionDomain
static final String	__DefaultSessionIdPathParameterName
static final String	__MaxAgeProperty	Session Max Age.
static final String	__SessionCookieProperty	Session cookie name.
static final String	__SessionDomainProperty	Session Domain.
static final String	__SessionIdPathParameterNameProperty	Session id path parameter name.
static final String	__SessionPathProperty	Session Path.

Method Summary

Modifier and Type	Method	Description
int	getMaxCookieAge()
int	getMaxInactiveInterval()
int	getRefreshCookieAge()
org.eclipse.jetty.http.HttpCookie.SameSite	getSameSite()
String	getSessionComment()
String	getSessionCookie()
String	getSessionDomain()
String	getSessionIdPathParameterName()
String	getSessionIdPathParameterNamePrefix()
String	getSessionPath()
boolean	isCheckingRemoteSessionIdEncoding()
boolean	isHttpOnly()
boolean	isPartitioned()
boolean	isSecureCookies()
boolean	isSecureRequestOnly()
boolean	isUsingCookies()
boolean	isUsingUriParameters()

Field Details

__SessionCookieProperty

static final String __SessionCookieProperty

Session cookie name. Defaults to JSESSIONID, but can be set with the org.eclipse.jetty.session.SessionCookie context init parameter.

See Also:

• Constant Field Values

__DefaultSessionCookie

static final String __DefaultSessionCookie

See Also:

• Constant Field Values

__SessionIdPathParameterNameProperty

static final String __SessionIdPathParameterNameProperty

Session id path parameter name. Defaults to jsessionid, but can be set with the org.eclipse.jetty.session.SessionIdPathParameterName context init parameter. If context init param is "none", or setSessionIdPathParameterName is called with null or "none", no URL rewriting will be done.

See Also:

• Constant Field Values

__DefaultSessionIdPathParameterName

static final String __DefaultSessionIdPathParameterName

See Also:

• Constant Field Values

__CheckRemoteSessionEncodingProperty

static final String __CheckRemoteSessionEncodingProperty

See Also:

• Constant Field Values

__SessionDomainProperty

static final String __SessionDomainProperty

Session Domain. If this property is set as a ServletContext InitParam, then it is used as the domain for session cookies. If it is not set, then no domain is specified for the session cookie.

See Also:

• Constant Field Values

__DefaultSessionDomain

static final String __DefaultSessionDomain

__SessionPathProperty

static final String __SessionPathProperty

Session Path. If this property is set as a ServletContext InitParam, then it is used as the path for the session cookie. If it is not set, then the context path is used as the path for the cookie.

See Also:

• Constant Field Values

__MaxAgeProperty

static final String __MaxAgeProperty

Session Max Age. If this property is set as a ServletContext InitParam, then it is used as the max age for the session cookie. If it is not set, then a max age of -1 is used.

See Also:

• Constant Field Values

Method Details

getMaxCookieAge

@ManagedAttribute("if greater the zero, the time in seconds a session cookie will last for")
int getMaxCookieAge()

getMaxInactiveInterval

@ManagedAttribute("default maximum time a session may be idle for (in s)")
int getMaxInactiveInterval()

getRefreshCookieAge

@ManagedAttribute("time before a session cookie is re-set (in s)")
int getRefreshCookieAge()

getSameSite

@ManagedAttribute("the session cookie sameSite mode")
org.eclipse.jetty.http.HttpCookie.SameSite getSameSite()

getSessionComment

@ManagedAttribute("the cookie comment to use when setting session tracking cookies")
String getSessionComment()

getSessionCookie

@ManagedAttribute("the cookie name used to track sessions with cookies")
String getSessionCookie()

getSessionDomain

@ManagedAttribute("domain of the session cookie, or null for the default")
String getSessionDomain()

getSessionIdPathParameterName

@ManagedAttribute("parameter name to use for URL session tracking")
String getSessionIdPathParameterName()

getSessionIdPathParameterNamePrefix

String getSessionIdPathParameterNamePrefix()

getSessionPath

@ManagedAttribute("path of the session cookie, or null for default")
String getSessionPath()

isCheckingRemoteSessionIdEncoding

@ManagedAttribute("check remote session id encoding")
boolean isCheckingRemoteSessionIdEncoding()

isHttpOnly

@ManagedAttribute("true if cookies use the http only flag")
boolean isHttpOnly()

isPartitioned

@ManagedAttribute("true if cookies have the Partitioned attribute")
boolean isPartitioned()

isSecureCookies

@ManagedAttribute("if true, secure cookie flag is set on session cookies")
boolean isSecureCookies()

isSecureRequestOnly

@ManagedAttribute("true if ???? TODO")
boolean isSecureRequestOnly()

isUsingCookies

@ManagedAttribute("true if sessions are tracked with cookies")
boolean isUsingCookies()

isUsingUriParameters

@ManagedAttribute("true if sessions are tracked with URLs")
boolean isUsingUriParameters()