org.xlightweb.server
Class HttpSession

java.lang.Object
  org.xlightweb.server.HttpSession

All Implemented Interfaces:

Serializable, IHttpSession

public final class HttpSession
extends Object
implements IHttpSession, Serializable

HttpSession. A HttpSession will be managed by the ISessionManager

See Also:

Serialized Form

Method Summary

Object	getAttribute(String name) Returns the object bound with the specified name in this session, or null if no object is bound under the name.
Enumeration	getAttributeNames() Returns an Enumeration of String objects containing the names of all the objects bound to this session.
Set<String>	getAttributeNameSet() Returns an Set of String objects containing the names of all the objects bound to this session.
long	getChangeVersion() returns the object change version.
long	getCreationTime() Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
String	getId() Returns a string containing the unique identifier assigned to this session.
long	getLastAccessedTime() Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.
int	getMaxInactiveInterval() Returns the maximum time interval, in seconds, that the container will keep this session open between client accesses.
void	invalidate() Invalidates this session then unbinds any objects bound to it.
boolean	isValid() returns if the session is valid
void	removeAttribute(String name) Removes the object bound with the specified name from this session.
void	setAttribute(String name, Object value) Binds an object to this session, using the name specified.
void	setMaxInactiveInterval(int maxInactiveIntervalSec) Specifies the time, in seconds, between client requests before the container will invalidate this session.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Returns a string containing the unique identifier assigned to this session.

Specified by:

getId in interface IHttpSession

Returns:

a string specifying the identifier assigned to this session

getCreationTime

public long getCreationTime()

Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.

Specified by:

getCreationTime in interface IHttpSession

Returns:

a long specifying when this session was created, expressed in milliseconds since 1/1/1970 GMT

getLastAccessedTime

public long getLastAccessedTime()

Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.

Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.

Specified by:

getLastAccessedTime in interface IHttpSession

Returns:

a long representing the last time the client sent a request associated with this session, expressed in milliseconds since 1/1/1970 GMT

getAttribute

public Object getAttribute(String name)

Returns the object bound with the specified name in this session, or null if no object is bound under the name.

Specified by:

getAttribute in interface IHttpSession

Parameters:

name - a string specifying the name of the object

Returns:

the object with the specified name

setAttribute

public void setAttribute(String name,
                         Object value)

Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.

If the value passed in is null, this has the same effect as calling removeAttribute().

Specified by:

setAttribute in interface IHttpSession

Parameters:

name - the name to which the object is bound; cannot be null

value - the object to be bound

removeAttribute

public void removeAttribute(String name)

Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.

Specified by:

removeAttribute in interface IHttpSession

Parameters:

name - the name of the object to remove from this session

invalidate

public void invalidate()

Invalidates this session then unbinds any objects bound to it.

Specified by:

invalidate in interface IHttpSession

isValid

public boolean isValid()

returns if the session is valid

Specified by:

isValid in interface IHttpSession

Returns:

true, if the session is valid

getAttributeNames

public Enumeration getAttributeNames()

Returns an Enumeration of String objects containing the names of all the objects bound to this session.

Specified by:

getAttributeNames in interface IHttpSession

Returns:

an Enumeration of String objects specifying the names of all the objects bound to this session

getAttributeNameSet

public Set<String> getAttributeNameSet()

Returns an Set of String objects containing the names of all the objects bound to this session.

Specified by:

getAttributeNameSet in interface IHttpSession

Returns:

an Set of String objects specifying the names of all the objects bound to this session

setMaxInactiveInterval

public void setMaxInactiveInterval(int maxInactiveIntervalSec)

Specifies the time, in seconds, between client requests before the container will invalidate this session. A negative time indicates the session should never timeout.

Specified by:

setMaxInactiveInterval in interface IHttpSession

Parameters:

maxInactiveIntervalSec - An integer specifying the number of seconds

getMaxInactiveInterval

public int getMaxInactiveInterval()

Returns the maximum time interval, in seconds, that the container will keep this session open between client accesses. After this interval, the container will invalidate the session. The maximum time interval can be set with the setMaxInactiveInterval method. A negative time indicates the session should never timeout.

Specified by:

getMaxInactiveInterval in interface IHttpSession

Returns:

an integer specifying the number of seconds this session remains open between client requests

getChangeVersion

public long getChangeVersion()

returns the object change version. The change version can be used to check if the session is modified

Returns:

the change version

toString

public String toString()

Overrides:

toString in class Object