net.officefloor.plugin.servlet.web.http.session

Class ServletHttpSession

java.lang.Object

net.officefloor.plugin.servlet.web.http.session.ServletHttpSession

All Implemented Interfaces:

HttpSession, HttpSessionAdministration

public class ServletHttpSession
extends Object
implements HttpSession, HttpSessionAdministration

HttpSession implementation backed by Servlet HttpSession.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
ServletHttpSession(javax.servlet.http.HttpSession session, Clock clock, String tokenName) Initiate.

Method Summary

Modifier and Type	Method and Description
Serializable	getAttribute(String name) Obtains the Object that is bound to the name for this HttpSession.
Iterator<String>	getAttributeNames() Obtains an Iterator to the names of the bound Object instances.
long	getCreationTime() Obtains the time this HttpSession was created.
long	getExpireTime() Obtains the time this HttpSession will be expired should it be idle.
HttpSessionAdministration	getHttpSessionAdministration() Obtains the HttpSessionAdministration to administer this HttpSession.
String	getSessionId() Obtains the session Id.
String	getTokenName() Obtains the token name.
void	invalidate(boolean isRequireNewSession) Triggers invalidating the HttpSession.
boolean	isNew() Indicates if this is a new HttpSession.
boolean	isOperationComplete() Indicates if the invalidate or store operation are complete.
void	removeAttribute(String name) Removes the bound Object by the name from this HttpSession.
void	setAttribute(String name, Serializable object) Binds the Object to the name within this HttpSession.
void	setExpireTime(long expireTime) Specifies the time this HttpSession will expire if idle.
void	store() Triggers storing the HttpSession.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletHttpSession

public ServletHttpSession(javax.servlet.http.HttpSession session,
                          Clock clock,
                          String tokenName)

Initiate.

Parameters:

session - HttpSession.

clock - Clock.

tokenName - Token name.

Method Detail

getSessionId

public String getSessionId()
                    throws InvalidatedHttpSessionException

Description copied from interface: HttpSession

Obtains the session Id.

Specified by:

getSessionId in interface HttpSession

Returns:

Session Id.

Throws:

InvalidatedHttpSessionException - Indicating the HttpSession is invalidated.

getTokenName

public String getTokenName()

Description copied from interface: HttpSession

Obtains the token name.

This is the name of the cookie or parameter that contains the session Id.

Specified by:

getTokenName in interface HttpSession

Returns:

Token name.

isNew

public boolean isNew()
              throws InvalidatedHttpSessionException

Description copied from interface: HttpSession

Indicates if this is a new HttpSession.

Specified by:

isNew in interface HttpSession

Returns:

true if this is a new HttpSession.

Throws:

InvalidatedHttpSessionException - Indicating the HttpSession is invalidated.

getCreationTime

public long getCreationTime()
                     throws InvalidatedHttpSessionException

Description copied from interface: HttpSession

Obtains the time this HttpSession was created.

Specified by:

getCreationTime in interface HttpSession

Returns:

Time this HttpSession was created.

Throws:

InvalidatedHttpSessionException - Indicating the HttpSession is invalidated.

getExpireTime

public long getExpireTime()
                   throws InvalidatedHttpSessionException

Description copied from interface: HttpSession

Obtains the time this HttpSession will be expired should it be idle.

Specified by:

getExpireTime in interface HttpSession

Returns:

Time this HttpSession will be expired.

Throws:

InvalidatedHttpSessionException - Indicating the HttpSession is invalidated.

setExpireTime

public void setExpireTime(long expireTime)
                   throws StoringHttpSessionException,
                          InvalidatedHttpSessionException

Description copied from interface: HttpSession

Specifies the time this HttpSession will expire if idle.

The HttpSessionStore may increment this time on further requests to keep the HttpSession active over a long conversation.

Specified by:

setExpireTime in interface HttpSession

Parameters:

expireTime - Time to expire this HttpSession.

Throws:

StoringHttpSessionException - Indicating the HttpSession is currently being stored and can not be altered.

InvalidatedHttpSessionException - Indicating the HttpSession is invalidated.

getAttribute

public Serializable getAttribute(String name)
                          throws InvalidatedHttpSessionException

Description copied from interface: HttpSession

Obtains the Object that is bound to the name for this HttpSession.

Specified by:

getAttribute in interface HttpSession

Parameters:

name - Name.

Returns:

Object bound to the name or null if no Object bound by the name.

Throws:

InvalidatedHttpSessionException - Indicating the HttpSession is invalidated.

getAttributeNames

public Iterator<String> getAttributeNames()
                                   throws InvalidatedHttpSessionException

Description copied from interface: HttpSession

Obtains an Iterator to the names of the bound Object instances.

Specified by:

getAttributeNames in interface HttpSession

Returns:

Iterator to the names of the bound Object instances.

Throws:

InvalidatedHttpSessionException - Indicating the HttpSession is invalidated.

setAttribute

public void setAttribute(String name,
                         Serializable object)
                  throws StoringHttpSessionException,
                         InvalidatedHttpSessionException

Description copied from interface: HttpSession

Binds the Object to the name within this HttpSession.

Specified by:

setAttribute in interface HttpSession

Parameters:

name - Name.

object - Object. Must be Serializable as the attributes of this HttpSession may be serialised to larger, cheaper memory stores or for clustered HttpSession management sent over the network.

Throws:

StoringHttpSessionException - Indicating the HttpSession is currently being stored and can not be altered.

InvalidatedHttpSessionException - Indicating the HttpSession is invalidated.

removeAttribute

public void removeAttribute(String name)
                     throws StoringHttpSessionException,
                            InvalidatedHttpSessionException

Description copied from interface: HttpSession

Removes the bound Object by the name from this HttpSession.

Specified by:

removeAttribute in interface HttpSession

Parameters:

name - Name of bound Object to remove.

Throws:

StoringHttpSessionException - Indicating the HttpSession is currently being stored and can not be altered.

InvalidatedHttpSessionException - Indicating the HttpSession is invalidated.

getHttpSessionAdministration

public HttpSessionAdministration getHttpSessionAdministration()

Description copied from interface: HttpSession

Obtains the HttpSessionAdministration to administer this HttpSession.

Specified by:

getHttpSessionAdministration in interface HttpSession

Returns:

HttpSessionAdministration to administer this HttpSession.

invalidate

public void invalidate(boolean isRequireNewSession)
                throws Throwable

Description copied from interface: HttpSessionAdministration

Triggers invalidating the HttpSession.

Specified by:

invalidate in interface HttpSessionAdministration

Parameters:

isRequireNewSession - true to have a new HttpSession created.

Throws:

Throwable - If immediate failure in invalidating the HttpSession.

isOperationComplete

public boolean isOperationComplete()
                            throws Throwable

Description copied from interface: HttpSessionAdministration

Indicates if the invalidate or store operation are complete.

As is an AsynchronousManagedObject, the next time a new Task is run the operation should be complete. This method enables determining if completed immediately and there were no failures of the operation.

Specified by:

isOperationComplete in interface HttpSessionAdministration

Returns:

true if the invalidate or store operation is complete.

Throws:

Throwable - Possible failure in invalidating or storing the HttpSession.

store

public void store()
           throws Throwable

Description copied from interface: HttpSessionAdministration

Triggers storing the HttpSession.

Specified by:

store in interface HttpSessionAdministration

Throws:

Throwable - If immediate failure in storing the HttpSession.