Package net.officefloor.web.session

Interface HttpSession

public interface HttpSession

HTTP session.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	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.
Instant	getCreationTime()	Obtains the time this HttpSession was created.
Instant	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.
boolean	isNew()	Indicates if this is a new HttpSession.
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(Instant expireTime)	Specifies the time this HttpSession will expire if idle.

Method Details

getSessionId

String getSessionId()
             throws InvalidatedSessionHttpException

Obtains the session Id.

Returns:

Session Id.

Throws:

InvalidatedSessionHttpException - Indicating the HttpSession is invalidated.

getTokenName

String getTokenName()

Obtains the token name.

This is the name of the HttpRequestCookie that contains the session Id.

Returns:

Token name.

isNew

boolean isNew()
       throws InvalidatedSessionHttpException

Indicates if this is a new HttpSession.

Returns:

true if this is a new HttpSession.

Throws:

InvalidatedSessionHttpException - Indicating the HttpSession is invalidated.

getCreationTime

Instant getCreationTime()
                 throws InvalidatedSessionHttpException

Obtains the time this HttpSession was created.

Returns:

Time this HttpSession was created.

Throws:

InvalidatedSessionHttpException - Indicating the HttpSession is invalidated.

getExpireTime

Instant getExpireTime()
               throws InvalidatedSessionHttpException

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

Returns:

Time this HttpSession will be expired.

Throws:

InvalidatedSessionHttpException - Indicating the HttpSession is invalidated.

setExpireTime

void setExpireTime(Instant expireTime)
            throws StoringSessionHttpException,
InvalidatedSessionHttpException

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.

Parameters:

expireTime - Time to expire this HttpSession.

Throws:

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

InvalidatedSessionHttpException - Indicating the HttpSession is invalidated.

getAttribute

Serializable getAttribute(String name)
                   throws InvalidatedSessionHttpException

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

Parameters:

name - Name.

Returns:

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

Throws:

InvalidatedSessionHttpException - Indicating the HttpSession is invalidated.

getAttributeNames

Iterator<String> getAttributeNames()
                            throws InvalidatedSessionHttpException

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

Returns:

Iterator to the names of the bound Object instances.

Throws:

InvalidatedSessionHttpException - Indicating the HttpSession is invalidated.

setAttribute

void setAttribute(String name,
 Serializable object)
           throws StoringSessionHttpException,
InvalidatedSessionHttpException

Binds the Object to the name within this 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:

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

InvalidatedSessionHttpException - Indicating the HttpSession is invalidated.

removeAttribute

void removeAttribute(String name)
              throws StoringSessionHttpException,
InvalidatedSessionHttpException

Removes the bound Object by the name from this HttpSession.

Parameters:

name - Name of bound Object to remove.

Throws:

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

InvalidatedSessionHttpException - Indicating the HttpSession is invalidated.

getHttpSessionAdministration

HttpSessionAdministration getHttpSessionAdministration()

Obtains the HttpSessionAdministration to administer this HttpSession.

Returns:

HttpSessionAdministration to administer this HttpSession.