Module cloud.piranha.webapp.impl

Package cloud.piranha.webapp.impl

Class DefaultHttpSessionManager

java.lang.Object

cloud.piranha.webapp.impl.DefaultHttpSessionManager

All Implemented Interfaces:

HttpSessionManager, SessionCookieConfig

public class DefaultHttpSessionManager
extends Object
implements HttpSessionManager, SessionCookieConfig

The default HttpSessionManager.

Author:

Manfred Riem ([email protected])

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayList<HttpSessionAttributeListener>	attributeListeners	Stores the session listeners.
protected String	comment	Stores the comment.
protected Set<SessionTrackingMode>	defaultSessionTrackingModes	Stores the default session tracking modes.
protected String	domain	Stores the domain.
protected boolean	httpOnly	Stores the HTTP only flag.
protected ArrayList<HttpSessionIdListener>	idListeners	Stores the session id listeners.
protected int	maxAge	Stores the max age.
protected String	name	Stores the name.
protected String	path	Stores the path.
protected boolean	secure	Stores the secure flag.
protected ArrayList<HttpSessionListener>	sessionListeners	Stores the session listeners.
protected Map<String,HttpSession>	sessions	Stores the sessions.
protected int	sessionTimeout	Stores the session timeout (in minutes).
protected Set<SessionTrackingMode>	sessionTrackingModes	Stores the session tracking modes.
protected WebApplication	webApplication	Stores the web application.

Constructor Summary

Constructors

Constructor	Description
DefaultHttpSessionManager()	Constructor.

Method Summary

Modifier and Type	Method	Description
<T extends EventListener> void	addListener(T listener)	Add a listener.
void	attributeAdded(HttpSession session, String name, Object value)	Attribute added.
void	attributeRemoved(HttpSession session, String name, Object value)	Attribute removed.
void	attributeReplaced(HttpSession session, String name, Object oldValue, Object newValue)	Attribute replaced.
String	changeSessionId(HttpServletRequest request)	Change the session id.
HttpSession	createSession(HttpServletRequest request)	Create a session.
void	destroySession(HttpSession session)	Destroy the session.
String	encodeRedirectURL(HttpServletResponse response, String url)	Encode the redirect URL.
String	encodeURL(HttpServletResponse response, String url)	Encode the URL.
String	getComment()	Returns the comment.
Set<SessionTrackingMode>	getDefaultSessionTrackingModes()	Returns the default session tracking modes.
String	getDomain()	Returns the domain.
Set<SessionTrackingMode>	getEffectiveSessionTrackingModes()	Returns the effective session tracking modes.
int	getMaxAge()	Returns the max age.
String	getName()	Returns the name.
String	getPath()	Returns the path.
HttpSession	getSession(HttpServletRequest request, String currentSessionId)	Returns the session.
SessionCookieConfig	getSessionCookieConfig()	Returns the session cookie config.
int	getSessionTimeout()	Get the session timeout (in minutes).
boolean	hasSession(String sessionId)	Has a session with the given id.
boolean	isHttpOnly()	Is HTTP only?
boolean	isSecure()	Is secure.
void	setComment(String comment)	Set the comment.
void	setDomain(String domain)	Set the domain.
void	setHttpOnly(boolean httpOnly)	Set the HTTP-only flag.
void	setMaxAge(int maxAge)	Set the max age.
void	setName(String name)	Set the name.
void	setPath(String path)	Set the path.
void	setSecure(boolean secure)	Set the secure flag.
void	setSessionTimeout(int sessionTimeout)	Set the session timeout.
void	setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes)	Set the session tracking modes.
void	setWebApplication(WebApplication webApplication)	Set the web application.

Methods inherited from class java.lang.Object

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

Field Details

attributeListeners

protected final ArrayList<HttpSessionAttributeListener> attributeListeners

Stores the session listeners.

comment

protected String comment

Stores the comment.

defaultSessionTrackingModes

protected final Set<SessionTrackingMode> defaultSessionTrackingModes

Stores the default session tracking modes.

domain

protected String domain

Stores the domain.

httpOnly

protected boolean httpOnly

Stores the HTTP only flag.

idListeners

protected final ArrayList<HttpSessionIdListener> idListeners

Stores the session id listeners.

maxAge

protected int maxAge

Stores the max age.

name

protected String name

Stores the name.

path

protected String path

Stores the path.

secure

protected boolean secure

Stores the secure flag.

sessionListeners

protected final ArrayList<HttpSessionListener> sessionListeners

Stores the session listeners.

sessionTimeout

protected int sessionTimeout

Stores the session timeout (in minutes).

sessionTrackingModes

protected Set<SessionTrackingMode> sessionTrackingModes

Stores the session tracking modes.

sessions

protected Map<String,HttpSession> sessions

Stores the sessions.

webApplication

protected WebApplication webApplication

Stores the web application.

Constructor Details

DefaultHttpSessionManager

public DefaultHttpSessionManager()

Constructor.

Method Details

createSession

public HttpSession createSession(HttpServletRequest request)

Description copied from interface: HttpSessionManager

Create a session.

Specified by:

createSession in interface HttpSessionManager

Parameters:

request - the request.

Returns:

the session.

getSession

public HttpSession getSession(HttpServletRequest request,
 String currentSessionId)

Description copied from interface: HttpSessionManager

Returns the session.

Specified by:

getSession in interface HttpSessionManager

Parameters:

request - the request.

currentSessionId - the current session id.

Returns:

the session

changeSessionId

public String changeSessionId(HttpServletRequest request)

Change the session id.

Specified by:

changeSessionId in interface HttpSessionManager

Parameters:

request - the request.

Returns:

the session id.

addListener

public <T extends EventListener> void addListener(T listener)

Add a listener.

Specified by:

addListener in interface HttpSessionManager

Type Parameters:

T - the type.

Parameters:

listener - the listener.

attributeAdded

public void attributeAdded(HttpSession session,
 String name,
 Object value)

Attribute added.

Specified by:

attributeAdded in interface HttpSessionManager

Parameters:

session - the HTTP session.

name - the name.

value - the value.

attributeReplaced

public void attributeReplaced(HttpSession session,
 String name,
 Object oldValue,
 Object newValue)

Attribute replaced.

Specified by:

attributeReplaced in interface HttpSessionManager

Parameters:

session - the HTTP session.

name - the name.

oldValue - the old value.

newValue - the new value.

attributeRemoved

public void attributeRemoved(HttpSession session,
 String name,
 Object value)

Description copied from interface: HttpSessionManager

Attribute removed.

Specified by:

attributeRemoved in interface HttpSessionManager

Parameters:

session - the HTTP session.

name - the name.

value - the value.

destroySession

public void destroySession(HttpSession session)

Destroy the session.

Specified by:

destroySession in interface HttpSessionManager

Parameters:

session - the session.

encodeRedirectURL

public String encodeRedirectURL(HttpServletResponse response,
 String url)

Encode the redirect URL.

Specified by:

encodeRedirectURL in interface HttpSessionManager

Parameters:

response - the response.

url - the redirect url.

Returns:

the encoded redirect url.

encodeURL

public String encodeURL(HttpServletResponse response,
 String url)

Encode the URL.

Specified by:

encodeURL in interface HttpSessionManager

Parameters:

response - the response.

url - the url.

Returns:

the encoded url.

getComment

public String getComment()

Returns the comment.

Specified by:

getComment in interface SessionCookieConfig

Returns:

the comment

getDefaultSessionTrackingModes

public Set<SessionTrackingMode> getDefaultSessionTrackingModes()

Returns the default session tracking modes.

Specified by:

getDefaultSessionTrackingModes in interface HttpSessionManager

Returns:

the default session tracking modes

getDomain

public String getDomain()

Returns the domain.

Specified by:

getDomain in interface SessionCookieConfig

Returns:

the domain

getEffectiveSessionTrackingModes

public Set<SessionTrackingMode> getEffectiveSessionTrackingModes()

Returns the effective session tracking modes.

Specified by:

getEffectiveSessionTrackingModes in interface HttpSessionManager

Returns:

the effective session tracking modes

getMaxAge

public int getMaxAge()

Returns the max age.

Specified by:

getMaxAge in interface SessionCookieConfig

Returns:

the max age

getName

public String getName()

Returns the name.

Specified by:

getName in interface SessionCookieConfig

Returns:

the name

getPath

public String getPath()

Returns the path.

Specified by:

getPath in interface SessionCookieConfig

Returns:

the path

getSessionCookieConfig

public SessionCookieConfig getSessionCookieConfig()

Returns the session cookie config.

Specified by:

getSessionCookieConfig in interface HttpSessionManager

Returns:

the session cookie config

getSessionTimeout

public int getSessionTimeout()

Get the session timeout (in minutes).

Specified by:

getSessionTimeout in interface HttpSessionManager

Returns:

the session timeout.

hasSession

public boolean hasSession(String sessionId)

Has a session with the given id.

Specified by:

hasSession in interface HttpSessionManager

Parameters:

sessionId - the session id.

Returns:

true if there is one, false otherwise.

isHttpOnly

public boolean isHttpOnly()

Is HTTP only?

Specified by:

isHttpOnly in interface SessionCookieConfig

Returns:

true if HTTP only, false otherwise.

isSecure

public boolean isSecure()

Is secure.

Specified by:

isSecure in interface SessionCookieConfig

Returns:

the secure flag.

setComment

public void setComment(String comment)

Description copied from interface: SessionCookieConfig

Set the comment.

Specified by:

setComment in interface SessionCookieConfig

Parameters:

comment - the comment.

setDomain

public void setDomain(String domain)

Description copied from interface: SessionCookieConfig

Set the domain.

Specified by:

setDomain in interface SessionCookieConfig

Parameters:

domain - the domain.

setHttpOnly

public void setHttpOnly(boolean httpOnly)

Description copied from interface: SessionCookieConfig

Set the HTTP-only flag.

Specified by:

setHttpOnly in interface SessionCookieConfig

Parameters:

httpOnly - the HTTP-only flag.

setMaxAge

public void setMaxAge(int maxAge)

Description copied from interface: SessionCookieConfig

Set the max age.

Specified by:

setMaxAge in interface SessionCookieConfig

Parameters:

maxAge - the max age.

setName

public void setName(String name)

Description copied from interface: SessionCookieConfig

Set the name.

Specified by:

setName in interface SessionCookieConfig

Parameters:

name - the name.

setPath

public void setPath(String path)

Description copied from interface: SessionCookieConfig

Set the path.

Specified by:

setPath in interface SessionCookieConfig

Parameters:

path - the path.

setSecure

public void setSecure(boolean secure)

Description copied from interface: SessionCookieConfig

Set the secure flag.

Specified by:

setSecure in interface SessionCookieConfig

Parameters:

secure - the secure flag.

setSessionTimeout

public void setSessionTimeout(int sessionTimeout)

Set the session timeout.

Specified by:

setSessionTimeout in interface HttpSessionManager

Parameters:

sessionTimeout - the session timeout.

setSessionTrackingModes

public void setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes)

Set the session tracking modes.

Specified by:

setSessionTrackingModes in interface HttpSessionManager

Parameters:

sessionTrackingModes - the session tracking modes.

setWebApplication

public void setWebApplication(WebApplication webApplication)

Set the web application.

Specified by:

setWebApplication in interface HttpSessionManager

Parameters:

webApplication - the web application.