Package io.undertow.server.session
Class SessionCookieConfig
- java.lang.Object
-
- io.undertow.server.session.SessionCookieConfig
-
- All Implemented Interfaces:
SessionConfig
public class SessionCookieConfig extends Object implements SessionConfig
Encapsulation of session cookie configuration. This removes the need for the session manager to know about cookie configuration.- Author:
- Stuart Douglas, Richard Opalka
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface io.undertow.server.session.SessionConfig
SessionConfig.SessionCookieSource
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_SESSION_ID-
Fields inherited from interface io.undertow.server.session.SessionConfig
ATTACHMENT_KEY
-
-
Constructor Summary
Constructors Constructor Description SessionCookieConfig()
-
Method Summary
-
-
-
Field Detail
-
DEFAULT_SESSION_ID
public static final String DEFAULT_SESSION_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
rewriteUrl
public String rewriteUrl(String originalUrl, String sessionId)
- Specified by:
rewriteUrlin interfaceSessionConfig
-
setSessionId
public void setSessionId(HttpServerExchange exchange, String sessionId)
Description copied from interface:SessionConfigAttaches 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
SessionConfig.findSessionId(io.undertow.server.HttpServerExchange)- Specified by:
setSessionIdin interfaceSessionConfig- Parameters:
exchange- The exchangesessionId- The session
-
clearSession
public void clearSession(HttpServerExchange exchange, String sessionId)
Description copied from interface:SessionConfigClears this session from the exchange, removing the attachment and making any changes to the response necessary, such as clearing cookies.- Specified by:
clearSessionin interfaceSessionConfig- Parameters:
exchange- The exchangesessionId- The session id
-
findSessionId
public String findSessionId(HttpServerExchange exchange)
Description copied from interface:SessionConfigRetrieves a session id of an existing session from an exchange.- Specified by:
findSessionIdin interfaceSessionConfig- Parameters:
exchange- The exchange- Returns:
- The session id, or null
-
sessionCookieSource
public SessionConfig.SessionCookieSource sessionCookieSource(HttpServerExchange exchange)
- Specified by:
sessionCookieSourcein interfaceSessionConfig
-
getCookieName
public String getCookieName()
-
setCookieName
public SessionCookieConfig setCookieName(String cookieName)
-
getPath
public String getPath()
-
setPath
public SessionCookieConfig setPath(String path)
-
getDomain
public String getDomain()
-
setDomain
public SessionCookieConfig setDomain(String domain)
-
isDiscard
public boolean isDiscard()
-
setDiscard
public SessionCookieConfig setDiscard(boolean discard)
-
isSecure
public boolean isSecure()
-
setSecure
public SessionCookieConfig setSecure(boolean secure)
-
isHttpOnly
public boolean isHttpOnly()
-
setHttpOnly
public SessionCookieConfig setHttpOnly(boolean httpOnly)
-
getMaxAge
public int getMaxAge()
-
setMaxAge
public SessionCookieConfig setMaxAge(int maxAge)
-
getComment
public String getComment()
-
setComment
public SessionCookieConfig setComment(String comment)
-
-