Package com.predic8.membrane.core.interceptor.authentication.session

Class SessionManager

java.lang.Object

com.predic8.membrane.core.config.AbstractXmlElement

com.predic8.membrane.core.interceptor.authentication.session.SessionManager

All Implemented Interfaces:

XMLElement, CleanupThread.Cleaner

Direct Known Subclasses:

JwtSessionManager

public class SessionManager
extends AbstractXmlElement
implements CleanupThread.Cleaner

Explanation

The Session Manager identifies users across HTTP requests using a session cookie.

The name of the session cookie can be specified using the cookieName attribute. The default name is "SESSIONID".

The session timeout can be specified in milliseconds using the timeout attribute. The default timeout is 5 minutes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionManager.Session

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	SESSION
protected static final String	SESSION_ID

Constructor Summary

Constructors

Constructor	Description
SessionManager()

Method Summary

Modifier and Type	Method	Description
void	cleanup()
SessionManager.Session	createSession(Exchange exc)
String	getCookieName()
String	getDomain()
SessionManager.Session	getOrCreateSession(Exchange exc)
SessionManager.Session	getSession(Exchange exc)
long	getTimeout()
void	init(Router router)
protected void	parseAttributes(XMLStreamReader token)
void	postProcess(Exchange exc)	Sets the Session Cookie on the response, if necessary (e.g.
void	removeSession(Exchange exc)
void	removeSession(SessionManager.Session s)
void	setCookieName(String cookieName)
void	setDomain(String domain)
void	setTimeout(long timeout)

Methods inherited from class com.predic8.membrane.core.config.AbstractXmlElement

doAfterParsing, getBoolean, getElementName, move2RootElementIfNeeded, parse, parseCharacters, parseChildren, toXml, write, writeIfNotNull

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SESSION_ID

protected static final String SESSION_ID

See Also:

• Constant Field Values

SESSION

protected static final String SESSION

See Also:

• Constant Field Values

Constructor Details

SessionManager

public SessionManager()

Method Details

parseAttributes

protected void parseAttributes(XMLStreamReader token)
                        throws Exception

Overrides:

parseAttributes in class AbstractXmlElement

Throws:

Exception

init

public void init(Router router)

postProcess

public void postProcess(Exchange exc)

Sets the Session Cookie on the response, if necessary (e.g. a session was created)

getOrCreateSession

public SessionManager.Session getOrCreateSession(Exchange exc)

removeSession

public void removeSession(Exchange exc)

removeSession

public void removeSession(SessionManager.Session s)

getSession

public SessionManager.Session getSession(Exchange exc)

createSession

public SessionManager.Session createSession(Exchange exc)

cleanup

public void cleanup()

Specified by:

cleanup in interface CleanupThread.Cleaner

getCookieName

public String getCookieName()

setCookieName

public void setCookieName(String cookieName)

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

getDomain

public String getDomain()

setDomain

public void setDomain(String domain)