|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.cocoon.environment.http.HttpSession
public final class HttpSession
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
Session information is scoped only to the current context
(Context
), so information stored in one context
will not be directly visible in another.
Constructor Summary | |
---|---|
HttpSession(HttpSession session)
Construct a new session from an HttpSession |
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 |
---|
public HttpSession(HttpSession session)
Method Detail |
---|
public long getCreationTime()
getCreationTime
in interface Session
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()
getId
in interface Session
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.
getLastAccessedTime
in interface Session
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)
setMaxInactiveInterval
in interface Session
interval
- An integer specifying the number
of secondspublic int getMaxInactiveInterval()
setMaxInactiveInterval
method.
A negative time indicates the session should never timeout.
getMaxInactiveInterval
in interface Session
setMaxInactiveInterval(int)
public Object getAttribute(String name)
null
if no object is bound under the name.
getAttribute
in interface Session
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.
getAttributeNames
in interface Session
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)
setAttribute
in interface Session
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)
removeAttribute
in interface Session
name
- the name of the object to
remove from this session
IllegalStateException
- if this method is called on an
invalidated sessionpublic void invalidate()
invalidate
in interface Session
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.
isNew
in interface Session
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 |