Package cloud.piranha

Class DefaultHttpSessionManager

java.lang.Object

cloud.piranha.DefaultHttpSessionManager

All Implemented Interfaces:

cloud.piranha.api.HttpSessionManager, javax.servlet.SessionCookieConfig

public class DefaultHttpSessionManager
extends java.lang.Object
implements cloud.piranha.api.HttpSessionManager, javax.servlet.SessionCookieConfig

The default HttpSessionManager.

Author:

Manfred Riem ([email protected])

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DefaultHttpSessionManager()	Constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

attributeListeners

protected final java.util.ArrayList<javax.servlet.http.HttpSessionAttributeListener> attributeListeners

Stores the session listeners.

comment

protected java.lang.String comment

Stores the comment.

defaultSessionTrackingModes

protected final java.util.Set<javax.servlet.SessionTrackingMode> defaultSessionTrackingModes

Stores the default session tracking modes.

domain

protected java.lang.String domain

Stores the domain.

httpOnly

protected boolean httpOnly

Stores the HTTP only flag.

idListeners

protected final java.util.ArrayList<javax.servlet.http.HttpSessionIdListener> idListeners

Stores the session id listeners.

maxAge

protected int maxAge

Stores the max age.

name

protected java.lang.String name

Stores the name.

path

protected java.lang.String path

Stores the path.

secure

protected boolean secure

Stores the secure flag.

sessionListeners

protected final java.util.ArrayList<javax.servlet.http.HttpSessionListener> sessionListeners

Stores the session listeners.

sessionTimeout

protected int sessionTimeout

Stores the session timeout (in minutes).

sessionTrackingModes

protected java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes

Stores the session tracking modes.

sessions

protected java.util.Map<java.lang.String,javax.servlet.http.HttpSession> sessions

Stores the sessions.

webApplication

protected cloud.piranha.api.WebApplication webApplication

Stores the web application.

Constructor Detail

DefaultHttpSessionManager

public DefaultHttpSessionManager()

Constructor.

Method Detail

createSession

public javax.servlet.http.HttpSession createSession(cloud.piranha.api.WebApplication webApplication,
                                                    javax.servlet.http.HttpServletRequest request)

Create the session.

Specified by:

createSession in interface cloud.piranha.api.HttpSessionManager

Parameters:

webApplication - the web application.

request - the request.

Returns:

the session.

getSession

public javax.servlet.http.HttpSession getSession(cloud.piranha.api.WebApplication webApplication,
                                                 javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String currentSessionId)

Get the session.

Specified by:

getSession in interface cloud.piranha.api.HttpSessionManager

Parameters:

webApplication - the web application.

request - the request.

currentSessionId - the current session id.

Returns:

the session.

changeSessionId

public java.lang.String changeSessionId(javax.servlet.http.HttpServletRequest request)

Change the session id.

Specified by:

changeSessionId in interface cloud.piranha.api.HttpSessionManager

Parameters:

request - the request.

Returns:

the session id.

addListener

public <T extends java.util.EventListener> void addListener(T listener)

Add a listener.

Specified by:

addListener in interface cloud.piranha.api.HttpSessionManager

Type Parameters:

T - the type.

Parameters:

listener - the listener.

attributeAdded

public void attributeAdded(javax.servlet.http.HttpSession session,
                           java.lang.String name,
                           java.lang.Object value)

Attribute added.

Specified by:

attributeAdded in interface cloud.piranha.api.HttpSessionManager

Parameters:

session - the HTTP session.

name - the name.

value - the value.

attributeReplaced

public void attributeReplaced(javax.servlet.http.HttpSession session,
                              java.lang.String name,
                              java.lang.Object value)

Attribute removed.

Specified by:

attributeReplaced in interface cloud.piranha.api.HttpSessionManager

Parameters:

session - the HTTP session.

name - the name.

value - the value.

attributeRemoved

public void attributeRemoved(javax.servlet.http.HttpSession session,
                             java.lang.String name)

Attributed removed.

Specified by:

attributeRemoved in interface cloud.piranha.api.HttpSessionManager

Parameters:

session - the HTTP session.

name - the name.

destroySession

public void destroySession(javax.servlet.http.HttpSession session)

Destroy the session.

Specified by:

destroySession in interface cloud.piranha.api.HttpSessionManager

Parameters:

session - the session.

encodeRedirectURL

public java.lang.String encodeRedirectURL(javax.servlet.http.HttpServletResponse response,
                                          java.lang.String url)

Encode the redirect URL.

Specified by:

encodeRedirectURL in interface cloud.piranha.api.HttpSessionManager

Parameters:

response - the response.

url - the redirect url.

Returns:

the encoded redirect url.

encodeURL

public java.lang.String encodeURL(javax.servlet.http.HttpServletResponse response,
                                  java.lang.String url)

Encode the URL.

Specified by:

encodeURL in interface cloud.piranha.api.HttpSessionManager

Parameters:

response - the response.

url - the url.

Returns:

the encoded url.

getComment

public java.lang.String getComment()

Get the comment.

Specified by:

getComment in interface javax.servlet.SessionCookieConfig

Returns:

the comment.

getDefaultSessionTrackingModes

public java.util.Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()

Get the default session tracking modes.

Specified by:

getDefaultSessionTrackingModes in interface cloud.piranha.api.HttpSessionManager

Returns:

the default session tracking modes.

getDomain

public java.lang.String getDomain()

Get the domain.

Specified by:

getDomain in interface javax.servlet.SessionCookieConfig

Returns:

the domain.

getEffectiveSessionTrackingModes

public java.util.Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()

Get the effective session tracking modes.

Specified by:

getEffectiveSessionTrackingModes in interface cloud.piranha.api.HttpSessionManager

Returns:

the effective session tracking modes.

getMaxAge

public int getMaxAge()

Get the max age.

Specified by:

getMaxAge in interface javax.servlet.SessionCookieConfig

Returns:

the max age.

getName

public java.lang.String getName()

Get the name.

Specified by:

getName in interface javax.servlet.SessionCookieConfig

Returns:

the name.

getPath

public java.lang.String getPath()

Get the path.

Specified by:

getPath in interface javax.servlet.SessionCookieConfig

Returns:

the path.

getSessionCookieConfig

public javax.servlet.SessionCookieConfig getSessionCookieConfig()

Get the session cookie config.

Specified by:

getSessionCookieConfig in interface cloud.piranha.api.HttpSessionManager

Returns:

the session cookie config.

getSessionTimeout

public int getSessionTimeout()

Get the session timeout (in minutes).

Specified by:

getSessionTimeout in interface cloud.piranha.api.HttpSessionManager

Returns:

the session timeout.

hasSession

public boolean hasSession(java.lang.String sessionId)

Has a session with the given id.

Specified by:

hasSession in interface cloud.piranha.api.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 javax.servlet.SessionCookieConfig

Returns:

true if HTTP only, false otherwise.

isSecure

public boolean isSecure()

Is secure.

Specified by:

isSecure in interface javax.servlet.SessionCookieConfig

Returns:

the secure flag.

setComment

public void setComment(java.lang.String comment)

Set the comment.

Specified by:

setComment in interface javax.servlet.SessionCookieConfig

Parameters:

comment - the comment.

setDomain

public void setDomain(java.lang.String domain)

Set the domain.

Specified by:

setDomain in interface javax.servlet.SessionCookieConfig

Parameters:

domain - the domain

setHttpOnly

public void setHttpOnly(boolean httpOnly)

Set the HTTP only flag.

Specified by:

setHttpOnly in interface javax.servlet.SessionCookieConfig

Parameters:

httpOnly - the HTTP only flag.

setMaxAge

public void setMaxAge(int maxAge)

Set the max age.

Specified by:

setMaxAge in interface javax.servlet.SessionCookieConfig

Parameters:

maxAge - the max age.

setName

public void setName(java.lang.String name)

Set the name.

Specified by:

setName in interface javax.servlet.SessionCookieConfig

Parameters:

name - the name.

setPath

public void setPath(java.lang.String path)

Set the path.

Specified by:

setPath in interface javax.servlet.SessionCookieConfig

Parameters:

path - the path.

setSecure

public void setSecure(boolean secure)

Set the secure flag.

Specified by:

setSecure in interface javax.servlet.SessionCookieConfig

Parameters:

secure - the secure flag.

setSessionTimeout

public void setSessionTimeout(int sessionTimeout)

Set the session timeout.

Specified by:

setSessionTimeout in interface cloud.piranha.api.HttpSessionManager

Parameters:

sessionTimeout - the session timeout.

setSessionTrackingModes

public void setSessionTrackingModes(java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)

Set the session tracking modes.

Specified by:

setSessionTrackingModes in interface cloud.piranha.api.HttpSessionManager

Parameters:

sessionTrackingModes - the session tracking modes.