org.apache.catalina
public interface Session
HttpSession
that is used to maintain state information
between requests for a particular user of a web application.
Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $
Field Summary | |
---|---|
static String | SESSION_ACTIVATED_EVENT
The SessionEvent event type when a session is activated. |
static String | SESSION_CREATED_EVENT
The SessionEvent event type when a session is created. |
static String | SESSION_DESTROYED_EVENT
The SessionEvent event type when a session is destroyed. |
static String | SESSION_PASSIVATED_EVENT
The SessionEvent event type when a session is passivated. |
Method Summary | |
---|---|
void | access()
Update the accessed time information for this session. |
void | addSessionListener(SessionListener listener)
Add a session event listener to this component. |
void | endAccess()
End access to the session. |
void | expire()
Perform the internal processing required to invalidate this session,
without triggering an exception if the session has already expired. |
String | getAuthType()
Return the authentication type used to authenticate our cached
Principal, if any. |
long | getCreationTime()
Return the creation time for this session. |
String | getId()
Return the session identifier for this session. |
String | getIdInternal()
Return the session identifier for this session. |
String | getInfo()
Return descriptive information about this Session implementation and
the corresponding version number, in the format
<description>/<version> . |
long | getLastAccessedTime()
Return the last time the client sent a request associated with this
session, as the number of milliseconds since midnight, January 1, 1970
GMT. |
long | getLastAccessedTimeInternal()
Return the last client access time without invalidation check |
Manager | getManager()
Return the Manager within which this Session is valid. |
int | getMaxInactiveInterval()
Return the maximum time interval, in seconds, between client requests
before the servlet container will invalidate the session. |
Object | getNote(String name)
Return the object bound with the specified name to the internal notes
for this session, or null if no such binding exists.
|
Iterator | getNoteNames()
Return an Iterator containing the String names of all notes bindings
that exist for this session. |
Principal | getPrincipal()
Return the authenticated Principal that is associated with this Session.
|
HttpSession | getSession()
Return the HttpSession for which this object
is the facade. |
boolean | isValid()
Return the isValid flag for this session. |
void | recycle()
Release all object references, and initialize instance variables, in
preparation for reuse of this object. |
void | removeNote(String name)
Remove any object bound to the specified name in the internal notes
for this session.
|
void | removeSessionListener(SessionListener listener)
Remove a session event listener from this component. |
void | setAuthType(String authType)
Set the authentication type used to authenticate our cached
Principal, if any.
|
void | setCreationTime(long time)
Set the creation time for this session. |
void | setId(String id)
Set the session identifier for this session.
|
void | setManager(Manager manager)
Set the Manager within which this Session is valid.
|
void | setMaxInactiveInterval(int interval)
Set the maximum time interval, in seconds, between client requests
before the servlet container will invalidate the session. |
void | setNew(boolean isNew)
Set the isNew flag for this session.
|
void | setNote(String name, Object value)
Bind an object to a specified name in the internal notes associated
with this session, replacing any existing binding for this name.
|
void | setPrincipal(Principal principal)
Set the authenticated Principal that is associated with this Session.
|
void | setValid(boolean isValid)
Set the isValid flag for this session.
|
<description>/<version>
.See Also: .
null
if no such binding exists.
Parameters: name Name of the note to be returned
Authenticator
with a means to cache a
previously authenticated Principal, and avoid potentially expensive
Realm.authenticate()
calls on every request. If there
is no current associated Principal, return null
.HttpSession
for which this object
is the facade.isValid
flag for this session.Parameters: name Name of the note to be removed
Parameters: authType The new cached authentication type
Parameters: time The new creation time
Parameters: id The new session identifier
Parameters: manager The new Manager
Parameters: interval The new maximum interval
isNew
flag for this session.
Parameters: isNew The new value for the isNew
flag
Parameters: name Name to which the object should be bound value Object to be bound to the specified name
Authenticator
with a means to cache a
previously authenticated Principal, and avoid potentially expensive
Realm.authenticate()
calls on every request.
Parameters: principal The new Principal, or null
if none
isValid
flag for this session.
Parameters: isValid The new value for the isValid
flag