Undertow 2.3.12.Final · io.undertow.server.session.SessionCookieConfig

Modifier and Type	Field and Description
private String	comment
private String	cookieName
public static final String	DEFAULT_SESSION_ID
private boolean	discard
private String	domain
private boolean	httpOnly
private int	maxAge
private String	path
private boolean	secure

Access	Constructor and Description
public	SessionCookieConfig()

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	getComment()
public String	getCookieName()
public String	getDomain()
public int	getMaxAge()
public String	getPath()
public boolean	isDiscard()
public boolean	isHttpOnly()
public boolean	isSecure()
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 SessionCookieConfig	setComment(final String comment)
public SessionCookieConfig	setCookieName(final String cookieName)
public SessionCookieConfig	setDiscard(final boolean discard)
public SessionCookieConfig	setDomain(final String domain)
public SessionCookieConfig	setHttpOnly(final boolean httpOnly)
public SessionCookieConfig	setMaxAge(final int maxAge)
public SessionCookieConfig	setPath(final String path)
public SessionCookieConfig	setSecure(final boolean 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

comment	back to summary
private String comment

DEFAULT_SESSION_ID	back to summary
public static final String DEFAULT_SESSION_ID

discard	back to summary
private boolean discard

domain	back to summary
private String domain

httpOnly	back to summary
private boolean httpOnly

maxAge	back to summary
private int maxAge

path	back to summary
private String path

secure	back to summary
private boolean secure

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

getComment	back to summary
public String getComment()

getCookieName	back to summary
public String getCookieName()

getDomain	back to summary
public String getDomain()

getMaxAge	back to summary
public int getMaxAge()

getPath	back to summary
public String getPath()

isDiscard	back to summary
public boolean isDiscard()

isHttpOnly	back to summary
public boolean isHttpOnly()

isSecure	back to summary
public boolean isSecure()

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

setComment	back to summary
public SessionCookieConfig setComment(final String comment)

setCookieName	back to summary
public SessionCookieConfig setCookieName(final String cookieName)

setDiscard	back to summary
public SessionCookieConfig setDiscard(final boolean discard)

setDomain	back to summary
public SessionCookieConfig setDomain(final String domain)

setHttpOnly	back to summary
public SessionCookieConfig setHttpOnly(final boolean httpOnly)

setMaxAge	back to summary
public SessionCookieConfig setMaxAge(final int maxAge)

setPath	back to summary
public SessionCookieConfig setPath(final String path)

setSecure	back to summary
public SessionCookieConfig setSecure(final boolean 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 SessionCookieConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail