This project has retired. For details please refer to its Attic page.

org.apache.cocoon.environment.portlet
Class PortletSession

java.lang.Object
  org.apache.cocoon.environment.portlet.PortletSession

All Implemented Interfaces:

Session

public final class PortletSession
extends Object
implements Session

Provides access to the JSR-168 (Portlet) environment session.

Portlet scope and application scope session attributes are differentiated using attribute name prefix, PortletEnvironment.SESSION_APPLICATION_SCOPE.

Version:

CVS $Id: PortletSession.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Alex Rudnev, Vadim Gritsenko

See Also:

PortletSession

Constructor Summary

PortletSession(javax.portlet.PortletSession session, int scope)
Construct a new session from an PortletSession

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.
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.
int	getMaxInactiveInterval() Returns the maximum time interval, in seconds, that the context container will keep this session open between client accesses.
void	invalidate() Invalidates this session to it.
boolean	isNew() Returns true if the client does not yet know about the session or if the client chooses not to join the session.
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 interval) Specifies the time, in seconds, between client requests before the contextcontainer will invalidate this session.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletSession

public PortletSession(javax.portlet.PortletSession session,
                      int scope)

Construct a new session from an PortletSession

Method Detail

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 Session

Returns:

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

Throws:

IllegalStateException - if this method is called on an invalidated session

getId

public String getId()

Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the context container and is implementation dependent.

Specified by:

getId in interface Session

Returns:

a string specifying the identifier assigned to this session

Throws:

IllegalStateException - if this method is called on an invalidated session

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.

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 Session

Returns:

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

Throws:

IllegalStateException - if this method is called on an invalidated session

setMaxInactiveInterval

public void setMaxInactiveInterval(int interval)

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

Specified by:

setMaxInactiveInterval in interface Session

Parameters:

interval - An integer specifying the number of seconds

getMaxInactiveInterval

public int getMaxInactiveInterval()

Returns the maximum time interval, in seconds, that the context container will keep this session open between client accesses. After this interval, the context 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 Session

Returns:

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

See Also:

setMaxInactiveInterval(int)

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 Session

Parameters:

name - a string specifying the name of the object

Returns:

the object with the specified name

Throws:

IllegalStateException - if this method is called on an invalidated session

getAttributeNames

public Enumeration getAttributeNames()

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

Objects' names in portlet session scope will be prefixed with PortletEnvironment.SESSION_PORTLET_SCOPE, and names in application scope will be prefixed with PortletEnvironment.SESSION_APPLICATION_SCOPE.

Specified by:

getAttributeNames in interface Session

Returns:

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

Throws:

IllegalStateException - if this method is called on an invalidated session

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.

Specified by:

setAttribute in interface Session

Parameters:

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

value - the object to be bound; cannot be null

Throws:

IllegalStateException - if this method is called on an invalidated session

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 Session

Parameters:

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

Throws:

IllegalStateException - if this method is called on an invalidated session

invalidate

public void invalidate()

Invalidates this session to it.

Specified by:

invalidate in interface Session

Throws:

IllegalStateException - if this method is called on an already invalidated session

isNew

public boolean isNew()

Returns true if the client does not yet know about the session or if the client chooses not to join the session. For example, if the server used only cookie-based sessions, and the client had disabled the use of cookies, then a session would be new on each request.

Specified by:

isNew in interface Session

Returns:

true if the server has created a session, but the client has not yet joined

Throws:

IllegalStateException - if this method is called on an already invalidated session