|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.cocoon.environment.impl.AbstractSession
org.apache.cocoon.environment.portlet.PortletSession
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
.
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 org.apache.cocoon.environment.impl.AbstractSession |
getAttributes |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PortletSession(javax.portlet.PortletSession session, int scope)
Method Detail |
public long getCreationTime()
long
specifying
when this session was created,
expressed in
milliseconds since 1/1/1970 GMT
IllegalStateException
- if this method is called on an
invalidated sessionpublic String getId()
IllegalStateException
- if this method is called on an
invalidated sessionpublic long getLastAccessedTime()
Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.
long
representing the last time
the client sent a request associated
with this session, expressed in
milliseconds since 1/1/1970 GMT
IllegalStateException
- if this method is called on an
invalidated sessionpublic void setMaxInactiveInterval(int interval)
interval
- An integer specifying the number
of secondspublic int getMaxInactiveInterval()
setMaxInactiveInterval
method.
A negative time indicates the session should never timeout.
setMaxInactiveInterval(int)
public Object getAttribute(String name)
null
if no object is bound under the name.
name
- a string specifying the name of the object
IllegalStateException
- if this method is called on an
invalidated sessionpublic Enumeration getAttributeNames()
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
.
Enumeration
of
String
objects specifying the
names of all the objects bound to
this session
IllegalStateException
- if this method is called on an
invalidated sessionpublic void setAttribute(String name, Object value)
name
- the name to which the object is bound;
cannot be nullvalue
- the object to be bound; cannot be null
IllegalStateException
- if this method is called on an
invalidated sessionpublic void removeAttribute(String name)
name
- the name of the object to
remove from this session
IllegalStateException
- if this method is called on an
invalidated sessionpublic void invalidate()
IllegalStateException
- if this method is called on an
already invalidated sessionpublic boolean isNew()
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.
true
if the
server has created a session,
but the client has not yet joined
IllegalStateException
- if this method is called on an
already invalidated session
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |