org.apache.catalina

Interface Session

Known Implementing Classes:
StandardSession

public interface Session

A Session is the Catalina-internal facade for an HttpSession that is used to maintain state information between requests for a particular user of a web application.

Version:
$Revision: 1.4 $ $Date: 2004/02/27 14:58:39 $

Author:
Craig R. McClanahan

Field Summary

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.

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
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.
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.

Field Details

SESSION_CREATED_EVENT

public static final String SESSION_CREATED_EVENT
The SessionEvent event type when a session is created.


SESSION_DESTROYED_EVENT

public static final String SESSION_DESTROYED_EVENT
The SessionEvent event type when a session is destroyed.

Method Details

access

public void access()
Update the accessed time information for this session. This method should be called by the context when a request comes in for a particular session, even if the application does not reference it.


addSessionListener

public void addSessionListener(SessionListener listener)
Add a session event listener to this component.


endAccess

public void endAccess()
End access to the session.


expire

public void expire()
Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.


getAuthType

public String getAuthType()
Return the authentication type used to authenticate our cached Principal, if any.


getCreationTime

public long getCreationTime()
Return the creation time for this session.


getId

public String getId()
Return the session identifier for this session.


getInfo

public String getInfo()
Return descriptive information about this Session implementation and the corresponding version number, in the format <description>/<version>.


getLastAccessedTime

public 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. Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.


getManager

public Manager getManager()
Return the Manager within which this Session is valid.


getMaxInactiveInterval

public int getMaxInactiveInterval()
Return the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session. A negative time indicates that the session should never time out.


getNote

public 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.

Parameters:
name - Name of the note to be returned


getNoteNames

public Iterator getNoteNames()
Return an Iterator containing the String names of all notes bindings that exist for this session.


getPrincipal

public Principal getPrincipal()
Return the authenticated Principal that is associated with this Session. This provides an 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.


getSession

public HttpSession getSession()
Return the HttpSession for which this object is the facade.


isValid

public boolean isValid()
Return the isValid flag for this session.


recycle

public void recycle()
Release all object references, and initialize instance variables, in preparation for reuse of this object.


removeNote

public void removeNote(String name)
Remove any object bound to the specified name in the internal notes for this session.

Parameters:
name - Name of the note to be removed


removeSessionListener

public void removeSessionListener(SessionListener listener)
Remove a session event listener from this component.


setAuthType

public void setAuthType(String authType)
Set the authentication type used to authenticate our cached Principal, if any.

Parameters:
authType - The new cached authentication type


setCreationTime

public void setCreationTime(long time)
Set the creation time for this session. This method is called by the Manager when an existing Session instance is reused.

Parameters:
time - The new creation time


setId

public void setId(String id)
Set the session identifier for this session.

Parameters:
id - The new session identifier


setManager

public void setManager(Manager manager)
Set the Manager within which this Session is valid.

Parameters:
manager - The new Manager


setMaxInactiveInterval

public void setMaxInactiveInterval(int interval)
Set the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session. A negative time indicates that the session should never time out.

Parameters:
interval - The new maximum interval


setNew

public void setNew(boolean isNew)
Set the isNew flag for this session.

Parameters:
isNew - The new value for the isNew flag


setNote

public 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.

Parameters:
name - Name to which the object should be bound
value - Object to be bound to the specified name


setPrincipal

public void setPrincipal(Principal principal)
Set the authenticated Principal that is associated with this Session. This provides an 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


setValid

public void setValid(boolean isValid)
Set the isValid flag for this session.

Parameters:
isValid - The new value for the isValid flag


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.