org.apache.catalina.session
public class StandardSession extends Object implements HttpSession, Session, Serializable
IMPLEMENTATION NOTE: An instance of this class represents both the
internal (Session) and application level (HttpSession) view of the session.
However, because the class itself is not declared public, Java logic outside
of the org.apache.catalina.session
package cannot cast an
HttpSession view of this instance back to a Session view.
IMPLEMENTATION NOTE: If you add fields to this class, you must make sure that you carry them over in the read/writeObject methods so that this class is properly serialized.
Version: $Revision: 900131 $ $Date: 2010-01-17 13:46:53 +0100 (Sun, 17 Jan 2010) $
Field Summary | |
---|---|
protected static boolean | ACTIVITY_CHECK |
protected AtomicInteger | accessCount
The access count for this session. |
protected Map | attributes
The collection of user data attributes associated with this Session. |
protected String | authType
The authentication type used to authenticate our cached Principal,
if any. |
protected long | creationTime
The time this session was created, in milliseconds since midnight,
January 1, 1970 GMT. |
protected static String[] | excludedAttributes
Set of attribute names which are not allowed to be persisted. |
protected boolean | expiring
We are currently processing a session expiration, so bypass
certain IllegalStateException tests. |
protected static String[] | EMPTY_ARRAY
Type array. |
protected StandardSessionFacade | facade
The facade associated with this session. |
protected String | id
The session identifier of this Session. |
protected static String | info
Descriptive information describing this Session implementation. |
protected boolean | isNew
Flag indicating whether this session is new or not. |
protected boolean | isValid
Flag indicating whether this session is valid or not. |
protected long | lastAccessedTime
The last accessed time for this Session. |
protected ArrayList | listeners
The session event listeners for this Session. |
protected Manager | manager
The Manager with which this Session is associated. |
protected int | maxInactiveInterval
The maximum time interval, in seconds, between client requests before
the servlet container may invalidate this session. |
protected Map | notes
Internal notes associated with this session by Catalina components
and event listeners. |
protected static String | NOT_SERIALIZED
The dummy attribute value serialized when a NotSerializableException is
encountered in writeObject() . |
protected Principal | principal
The authenticated Principal associated with this session, if any.
|
protected static HttpSessionContext | sessionContext
The HTTP session context associated with this session. |
protected static StringManager | sm
The string manager for this package. |
protected PropertyChangeSupport | support
The property change support for this component. |
protected long | thisAccessedTime
The current accessed time for this session. |
Constructor Summary | |
---|---|
StandardSession(Manager manager)
Construct a new Session associated with the specified Manager.
|
Method Summary | |
---|---|
void | access()
Update the accessed time information for this session. |
void | activate()
Perform internal processing required to activate this
session. |
void | addSessionListener(SessionListener listener)
Add a session event listener to this component. |
void | endAccess()
End the access. |
protected boolean | exclude(String name)
Exclude attribute that cannot be serialized. |
void | expire()
Perform the internal processing required to invalidate this session,
without triggering an exception if the session has already expired. |
void | expire(boolean notify)
Perform the internal processing required to invalidate this session,
without triggering an exception if the session has already expired.
|
protected void | fireContainerEvent(Context context, String type, Object data)
Fire container events if the Context implementation is the
org.apache.catalina.core.StandardContext .
|
void | fireSessionEvent(String type, Object data)
Notify all session event listeners that a particular event has
occurred for this Session. |
Object | getAttribute(String name)
Return the object bound with the specified name in this session, or
null if no object is bound with that name.
|
Enumeration | getAttributeNames()
Return an Enumeration of String objects
containing the names of the objects bound to this session.
|
String | getAuthType()
Return the authentication type used to authenticate our cached
Principal, if any. |
long | getCreationTime()
Return the time when this session was created, in milliseconds since
midnight, January 1, 1970 GMT.
|
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.
|
ServletContext | getServletContext()
Return the ServletContext to which this session belongs. |
HttpSession | getSession()
Return the HttpSession for which this object
is the facade. |
HttpSessionContext | getSessionContext()
Return the session context with which this session is associated.
|
Object | getValue(String name)
Return the object bound with the specified name in this session, or
null if no object is bound with that name.
|
String[] | getValueNames()
Return the set of names of objects bound to this session. |
void | invalidate()
Invalidates this session and unbinds any objects bound to it.
|
boolean | isNew()
Return true if the client does not yet know about the
session, or if the client chooses not to join the session. |
boolean | isValid()
Return the isValid flag for this session. |
protected boolean | isValidInternal()
Return the isValid flag for this session without any expiration
check. |
protected String[] | keys()
Return the names of all currently defined session attributes
as an array of Strings. |
void | passivate()
Perform the internal processing required to passivate
this session. |
void | putValue(String name, Object value)
Bind an object to this session, using the specified name. |
protected void | readObject(ObjectInputStream stream)
Read a serialized version of this session object from the specified
object input stream.
|
void | readObjectData(ObjectInputStream stream)
Read a serialized version of the contents of this session object from
the specified object input stream, without requiring that the
StandardSession itself have been serialized.
|
void | recycle()
Release all object references, and initialize instance variables, in
preparation for reuse of this object. |
void | removeAttribute(String name)
Remove the object bound with the specified name from this session. |
void | removeAttribute(String name, boolean notify)
Remove the object bound with the specified name from this session. |
protected void | removeAttributeInternal(String name, boolean notify)
Remove the object bound with the specified name from this session. |
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 | removeValue(String name)
Remove the object bound with the specified name from this session. |
void | setAttribute(String name, Object value)
Bind an object to this session, using the specified name. |
void | setAttribute(String name, Object value, boolean notify)
Bind an object to this session, using the specified name. |
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.
|
void | tellNew()
Inform the listeners about the new session.
|
String | toString()
Return a string representation of this object. |
protected void | writeObject(ObjectOutputStream stream)
Write a serialized version of this session object to the specified
object output stream.
|
void | writeObjectData(ObjectOutputStream stream)
Write a serialized version of the contents of this session object to
the specified object output stream, without requiring that the
StandardSession itself have been serialized.
|
writeObject()
.Parameters: manager The manager with which this Session is associated
Parameters: name the attribute's name
Parameters: notify Should we notify listeners about the demise of this session?
org.apache.catalina.core.StandardContext
.
Parameters: context Context for which to fire events type Event type data Event data
Throws: Exception occurred during event firing
Parameters: type Event type data Event data
null
if no object is bound with that name.
Parameters: name Name of the attribute to be returned
Throws: IllegalStateException if this method is called on an invalidated session
Enumeration
of String
objects
containing the names of the objects bound to this session.
Throws: IllegalStateException if this method is called on an invalidated session
Throws: IllegalStateException if this method is called on an invalidated 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.Deprecated: As of Version 2.1, this method is deprecated and has no replacement. It will be removed in a future version of the Java Servlet API.
Return the session context with which this session is associated.Deprecated: As of Version 2.2, this method is replaced by
getAttribute()
null
if no object is bound with that name.
Parameters: name Name of the value to be returned
Throws: IllegalStateException if this method is called on an invalidated session
Deprecated: As of Version 2.2, this method is replaced by
getAttributeNames()
Throws: IllegalStateException if this method is called on an invalidated session
Throws: IllegalStateException if this method is called on an invalidated session
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
has disabled the use of cookies, then a session would be new on each
request.
Throws: IllegalStateException if this method is called on an invalidated session
isValid
flag for this session.isValid
flag for this session without any expiration
check.Deprecated: As of Version 2.2, this method is replaced by
setAttribute()
After this method executes, and if the object implements
HttpSessionBindingListener
, the container calls
valueBound()
on the object.
Parameters: name Name to which the object is bound, cannot be null value Object to be bound, cannot be null
Throws: IllegalStateException if this method is called on an invalidated session
IMPLEMENTATION NOTE: The reference to the owning Manager is not restored by this method, and must be set explicitly.
Parameters: stream The input stream to read from
Throws: ClassNotFoundException if an unknown class is specified IOException if an input/output error occurs
Parameters: stream The object input stream to read from
Throws: ClassNotFoundException if an unknown class is specified IOException if an input/output error occurs
After this method executes, and if the object implements
HttpSessionBindingListener
, the container calls
valueUnbound()
on the object.
Parameters: name Name of the object to remove from this session.
Throws: IllegalStateException if this method is called on an invalidated session
After this method executes, and if the object implements
HttpSessionBindingListener
, the container calls
valueUnbound()
on the object.
Parameters: name Name of the object to remove from this session. notify Should we notify interested listeners that this attribute is being removed?
Throws: IllegalStateException if this method is called on an invalidated session
After this method executes, and if the object implements
HttpSessionBindingListener
, the container calls
valueUnbound()
on the object.
Parameters: name Name of the object to remove from this session. notify Should we notify interested listeners that this attribute is being removed?
Parameters: name Name of the note to be removed
Deprecated: As of Version 2.2, this method is replaced by
removeAttribute()
After this method executes, and if the object implements
HttpSessionBindingListener
, the container calls
valueUnbound()
on the object.
Parameters: name Name of the object to remove from this session.
Throws: IllegalStateException if this method is called on an invalidated session
After this method executes, and if the object implements
HttpSessionBindingListener
, the container calls
valueBound()
on the object.
Parameters: name Name to which the object is bound, cannot be null value Object to be bound, cannot be null
Throws: IllegalArgumentException if an attempt is made to add a non-serializable object in an environment marked distributable. IllegalStateException if this method is called on an invalidated session
After this method executes, and if the object implements
HttpSessionBindingListener
, the container calls
valueBound()
on the object.
Parameters: name Name to which the object is bound, cannot be null value Object to be bound, cannot be null notify whether to notify session listeners
Throws: IllegalArgumentException if an attempt is made to add a non-serializable object in an environment marked distributable. IllegalStateException if this method is called on an invalidated session
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
IMPLEMENTATION NOTE: The owning Manager will not be stored
in the serialized representation of this Session. After calling
readObject()
, you must set the associated Manager
explicitly.
IMPLEMENTATION NOTE: Any attribute that is not Serializable
will be unbound from the session, with appropriate actions if it
implements HttpSessionBindingListener. If you do not want any such
attributes, be sure the distributable
property of the
associated Manager is set to true
.
Parameters: stream The output stream to write to
Throws: IOException if an input/output error occurs
Parameters: stream The object output stream to write to
Throws: IOException if an input/output error occurs