| org.apache.cocoon.environment.Session
All known Subclasses: org.apache.cocoon.environment.mock.MockSession, org.apache.cocoon.environment.http.HttpSession, org.apache.cocoon.environment.portlet.PortletSession, org.apache.cocoon.environment.commandline.CommandLineSession,
| Session | | public interface Session (Code) | | Provides a way to identify a user across more than one page
request or visit to a Web site and to store information about that user.
Cocoon uses this interface to create a session
between a client and the "cocoon server". The session persists
for a specified time period, across more than one connection or
page request from the user. A session usually corresponds to one
user, who may visit a site many times. The server can maintain a
session in many ways such as using cookies or rewriting URLs.
This interface allows Cocoon to
- View and manipulate information about a session, such as
the session identifier, creation time, and last accessed time
- Bind objects to sessions, allowing user information to persist
across multiple user connections
Session information is scoped only to the current context
(Context), so information stored in one context
will not be directly visible in another.
author:
Carsten Ziegeler
version:
CVS $Id: Session.java 433543 2006-08-22 06:22:54Z crossley $ |
| 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. |
| getAttribute | | Object getAttribute(String name)(Code) | | Returns the object bound with the specified name in this session, or
null if no object is bound under the name.
Parameters:
name - a string specifying the name of the object the object with the specified name
exception:
IllegalStateException - if this method is called on aninvalidated session |
| getAttributeNames | | Enumeration getAttributeNames()(Code) | | Returns an Enumeration of String objects
containing the names of all the objects bound to this session.
an Enumeration ofString objects specifying thenames of all the objects bound tothis session
exception:
IllegalStateException - if this method is called on aninvalidated session |
| getCreationTime | | long getCreationTime()(Code) | | Returns the time when this session was created, measured
in milliseconds since midnight January 1, 1970 GMT.
a long specifyingwhen this session was created,expressed inmilliseconds since 1/1/1970 GMT
exception:
IllegalStateException - if this method is called on aninvalidated session |
| getId | | String getId()(Code) | | Returns a string containing the unique identifier assigned
to this session. The identifier is assigned
by the context container and is implementation dependent.
a string specifying the identifierassigned to this session
exception:
IllegalStateException - if this method is called on aninvalidated session |
| getLastAccessedTime | | long getLastAccessedTime()(Code) | | 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.
a longrepresenting the last timethe client sent a request associatedwith this session, expressed inmilliseconds since 1/1/1970 GMT
exception:
IllegalStateException - if this method is called on aninvalidated session |
| getMaxInactiveInterval | | int getMaxInactiveInterval()(Code) | | 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.
an integer specifying the number ofseconds this session remains openbetween client requests
See Also: Session.setMaxInactiveInterval(int) |
| invalidate | | void invalidate()(Code) | | Invalidates this session
to it.
exception:
IllegalStateException - if this method is called on analready invalidated session |
| isNew | | boolean isNew()(Code) | | 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.
true if theserver has created a session,but the client has not yet joined
exception:
IllegalStateException - if this method is called on analready invalidated session |
| removeAttribute | | void removeAttribute(String name)(Code) | | 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.
Parameters:
name - the name of the object toremove from this session
exception:
IllegalStateException - if this method is called on aninvalidated session |
| setAttribute | | void setAttribute(String name, Object value)(Code) | | 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.
Parameters:
name - the name to which the object is bound;cannot be null
Parameters:
value - the object to be bound; cannot be null
exception:
IllegalStateException - if this method is called on aninvalidated session |
| setMaxInactiveInterval | | void setMaxInactiveInterval(int interval)(Code) | | Specifies the time, in seconds, between client requests before the
contextcontainer will invalidate this session. A negative time
indicates the session should never timeout.
Parameters:
interval - An integer specifying the numberof seconds |
|
|