Top Inners Fields Methods

org.eclipse.jetty.session

public Interface SessionConfig

Known Direct Subinterfaces: org.eclipse.jetty.session.SessionConfig.Mutable, org.eclipse.jetty.session.SessionManager
Imports: org.eclipse.jetty.http.HttpCookie, org.eclipse.jetty.util.annotation.ManagedAttribute

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	SessionConfig.Mutable

Field Summary

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

Method Summary

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

Field Detail

__CheckRemoteSessionEncodingProperty	back to summary
public static final String __CheckRemoteSessionEncodingProperty

__DefaultSessionCookie	back to summary
public static final String __DefaultSessionCookie

__DefaultSessionDomain	back to summary
public static final String __DefaultSessionDomain

__DefaultSessionIdPathParameterName	back to summary
public static final String __DefaultSessionIdPathParameterName

__MaxAgeProperty	back to summary
public 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.

__SessionCookieProperty	back to summary
public static final String __SessionCookieProperty Session cookie name. Defaults to `JSESSIONID`, but can be set with the `org.eclipse.jetty.session.SessionCookie` context init parameter.

__SessionDomainProperty	back to summary
public 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.

__SessionIdPathParameterNameProperty	back to summary
public 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.

__SessionPathProperty	back to summary
public 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.

Method Detail

getMaxCookieAge	back to summary
public int getMaxCookieAge() Annotations @ManagedAttribute:if greater the zero, the time in seconds a session cookie will last for

getMaxInactiveInterval	back to summary
public int getMaxInactiveInterval() Annotations @ManagedAttribute:default maximum time a session may be idle for (in s)

getRefreshCookieAge	back to summary
public int getRefreshCookieAge() Annotations @ManagedAttribute:time before a session cookie is re-set (in s)

getSameSite	back to summary
public HttpCookie.SameSite getSameSite() Annotations @ManagedAttribute:the session cookie sameSite mode

getSessionComment	back to summary
public String getSessionComment() Annotations @ManagedAttribute:the cookie comment to use when setting session tracking cookies

getSessionCookie	back to summary
public String getSessionCookie() Annotations @ManagedAttribute:the cookie name used to track sessions with cookies

getSessionDomain	back to summary
public String getSessionDomain() Annotations @ManagedAttribute:domain of the session cookie, or null for the default

getSessionIdPathParameterName	back to summary
public String getSessionIdPathParameterName() Annotations @ManagedAttribute:parameter name to use for URL session tracking

getSessionIdPathParameterNamePrefix	back to summary
public String getSessionIdPathParameterNamePrefix()

getSessionPath	back to summary
public String getSessionPath() Annotations @ManagedAttribute:path of the session cookie, or null for default

isCheckingRemoteSessionIdEncoding	back to summary
public boolean isCheckingRemoteSessionIdEncoding() Annotations @ManagedAttribute:check remote session id encoding

isHttpOnly	back to summary
public boolean isHttpOnly() Annotations @ManagedAttribute:true if cookies use the http only flag

isPartitioned	back to summary
public boolean isPartitioned() Annotations @ManagedAttribute:true if cookies have the Partitioned attribute

isSecureCookies	back to summary
public boolean isSecureCookies() Annotations @ManagedAttribute:if true, secure cookie flag is set on session cookies

isSecureRequestOnly	back to summary
public boolean isSecureRequestOnly() Annotations @ManagedAttribute:true if ???? TODO

isUsingCookies	back to summary
public boolean isUsingCookies() Annotations @ManagedAttribute:true if sessions are tracked with cookies

isUsingUriParameters	back to summary
public boolean isUsingUriParameters() Annotations @ManagedAttribute:true if sessions are tracked with URLs

org.eclipse.jetty.session back to summary

public Interface SessionConfig.Mutable

Known Direct Implementers: org.eclipse.jetty.session.AbstractSessionManager

Field Summary

Inherited from org.eclipse.jetty.session.SessionConfig:: __CheckRemoteSessionEncodingProperty __DefaultSessionCookie __DefaultSessionDomain __DefaultSessionIdPathParameterName __MaxAgeProperty __SessionCookieProperty __SessionDomainProperty __SessionIdPathParameterNameProperty __SessionPathProperty

Method Summary

Modifier and Type	Method and Description
public void	setCheckingRemoteSessionIdEncoding(boolean value)
public void	setHttpOnly(boolean value)
public void	setMaxCookieAge(int value)
public void	setMaxInactiveInterval(int value)
public void	setPartitioned(boolean value)
public void	setRefreshCookieAge(int value)
public void	setSameSite(HttpCookie.SameSite sameSite)
public void	setSecureCookies(boolean value)
public void	setSecureRequestOnly(boolean value)
public void	setSessionCache(SessionCache cache)
public void	setSessionComment(String sessionComment)
public void	setSessionCookie(String value)
public void	setSessionDomain(String value)
public void	setSessionIdManager(SessionIdManager sessionIdManager)
public void	setSessionIdPathParameterName(String value)
public void	setSessionPath(String value)
public void	setUsingCookies(boolean value)
public void	setUsingUriParameters(boolean value)

Inherited from org.eclipse.jetty.session.SessionConfig:: getMaxCookieAge getMaxInactiveInterval getRefreshCookieAge getSameSite getSessionComment getSessionCookie getSessionDomain getSessionIdPathParameterName getSessionIdPathParameterNamePrefix getSessionPath isCheckingRemoteSessionIdEncoding isHttpOnly isPartitioned isSecureCookies isSecureRequestOnly isUsingCookies isUsingUriParameters

Method Detail

setCheckingRemoteSessionIdEncoding	back to summary
public void setCheckingRemoteSessionIdEncoding(boolean value)

setHttpOnly	back to summary
public void setHttpOnly(boolean value)

setMaxCookieAge	back to summary
public void setMaxCookieAge(int value)

setMaxInactiveInterval	back to summary
public void setMaxInactiveInterval(int value)

setPartitioned	back to summary
public void setPartitioned(boolean value)

setRefreshCookieAge	back to summary
public void setRefreshCookieAge(int value)

setSameSite	back to summary
public void setSameSite(HttpCookie.SameSite sameSite)

setSecureCookies	back to summary
public void setSecureCookies(boolean value)

setSecureRequestOnly	back to summary
public void setSecureRequestOnly(boolean value)

setSessionCache	back to summary
public void setSessionCache(SessionCache cache)

setSessionComment	back to summary
public void setSessionComment(String sessionComment)

setSessionCookie	back to summary
public void setSessionCookie(String value)

setSessionDomain	back to summary
public void setSessionDomain(String value)

setSessionIdManager	back to summary
public void setSessionIdManager(SessionIdManager sessionIdManager)

setSessionIdPathParameterName	back to summary
public void setSessionIdPathParameterName(String value)

setSessionPath	back to summary
public void setSessionPath(String value)

setUsingCookies	back to summary
public void setUsingCookies(boolean value)

setUsingUriParameters	back to summary
public void setUsingUriParameters(boolean value)