FileDocCategorySizeDatePackage
StandardSession.javaAPI DocGlassfish v2 API69278Fri May 04 22:32:20 BST 2007org.apache.catalina.session

StandardSession

public class StandardSession extends Object implements Serializable, HttpSession, org.apache.catalina.Session
Standard implementation of the Session interface. This object is serializable, so that it can be stored in persistent storage or transferred to a different JVM for distributable session support.

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.

author
Craig R. McClanahan
author
Sean Legassick
author
Jon S. Stevens
version
$Revision: 1.34 $ $Date: 2007/05/05 05:32:19 $

Fields Summary
protected static final String[]
EMPTY_ARRAY
Type array.
protected static final String
NOT_SERIALIZED
The dummy attribute value serialized when a NotSerializableException is encountered in writeObject().
protected static final String
SYNC_STRING
The string used in the name for setAttribute and removeAttribute to signify on-demand sync
protected Map
attributes
The collection of user data attributes associated with this Session.
protected transient String
authType
The authentication type used to authenticate our cached Principal, if any. NOTE: This value is not included in the serialized version of this object.
protected transient Method
containerEventMethod
The java.lang.Method for the fireContainerEvent() method of the org.apache.catalina.core.StandardContext method, if our Context implementation is of this class. This value is computed dynamically the first time it is needed, or after a session reload (since it is declared transient).
protected static final Class[]
containerEventTypes
The method signature for the fireContainerEvent method.
protected long
creationTime
The time this session was created, in milliseconds since midnight, January 1, 1970 GMT.
protected transient int
debug
The debugging detail level for this component. NOTE: This value is not included in the serialized version of this object.
private static final String[]
excludedAttributes
Set of attribute names which are not allowed to be persisted.
protected transient boolean
expiring
We are currently processing a session expiration, so bypass certain IllegalStateException tests. NOTE: This value is not included in the serialized version of this object.
protected transient StandardSessionFacade
facade
The facade associated with this session. NOTE: This value is not included in the serialized version of this object.
protected String
id
The session identifier of this Session.
protected static final String
info
Descriptive information describing this Session implementation.
protected long
lastAccessedTime
The last accessed time for this Session.
protected transient ArrayList
listeners
The session event listeners for this Session.
protected transient org.apache.catalina.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. A negative time indicates that the session should never time out.
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 transient Map
notes
Internal notes associated with this session by Catalina components and event listeners. IMPLEMENTATION NOTE: This object is not saved and restored across session serializations!
protected transient Principal
principal
The authenticated Principal associated with this session, if any. // START SJSWS 6371339 // * IMPLEMENTATION NOTE: This object is not saved and // * restored across session serializations! // END SJSWS 6371339
protected static final org.apache.catalina.util.StringManager
sm
The string manager for this package.
protected static HttpSessionContext
sessionContext
The HTTP session context associated with this session.
protected long
thisAccessedTime
The current accessed time for this session.
protected transient int
accessCount
The access count for this session.
protected long
version
The session version, incremented and used by in-memory-replicating session managers
protected transient SessionLock
_sessionLock
Constructors Summary
public StandardSession(org.apache.catalina.Manager manager)
Construct a new Session associated with the specified Manager.

param
manager The manager with which this Session is associated


        super();
        this.manager = manager;
        if (manager instanceof ManagerBase)
            this.debug = ((ManagerBase) manager).getDebug();
Methods Summary
public voidaccess()
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.


        this.lastAccessedTime = this.thisAccessedTime;
        this.thisAccessedTime = System.currentTimeMillis();

	evaluateIfValid();

        accessCount++;
public voidactivate()
Perform internal processing required to activate this session.


        // Notify ActivationListeners
        HttpSessionEvent event = null;
        String keys[] = keys();
        for (int i = 0; i < keys.length; i++) {
            Object attribute = getAttributeInternal(keys[i]);
            if (attribute instanceof HttpSessionActivationListener) {
                if (event == null)
                    event = new HttpSessionEvent(getSession());
                // FIXME: Should we catch throwables?
                ((HttpSessionActivationListener)attribute).sessionDidActivate(event);
            }
        }
public voidaddSessionListener(org.apache.catalina.SessionListener listener)
Add a session event listener to this component.


        synchronized (listeners) {
            listeners.add(listener);
        }
static org.apache.catalina.session.StandardSessiondeserialize(java.io.ObjectInputStream ois, org.apache.catalina.Manager manager)
Creates a StandardSession instance from the given ObjectInputStream, and returns it. If ObjectInputStream does not contain a serialized StandardSession (or one of its subclasses), this method will create an empty session and populate it with the serialized data (this is for backwards compatibility).

param
ois The ObjectInputStream from which to read the serialized session data
param
manager The session manager from which to create an empty session if needed
return
The restored session
exception
ClassNotFoundException If the class for an object being restored cannot be found.
exception
IOException if I/O errors occur


        StandardSession result = null;

        Object obj = ois.readObject();
        if (obj instanceof StandardSession) {
            // New format following standard serialization
            result = (StandardSession) obj;
        } else {
            // Old format, obj is an instance of Long and contains the
            // session's creation time
            result = (StandardSession) manager.createEmptySession();
            result.setCreationTime(((Long) obj).longValue());
            result.readRemainingObject(ois);
        }

        return result;
public voidendAccess()
End the access.


        isNew = false;
        accessCount--;
protected voidevaluateIfValid()

        /*
	 * If this session has expired or is in the process of expiring or
	 * will never expire, return
	 */
        if (!this.isValid || expiring || maxInactiveInterval < 0)
            return;

        isValid();
protected booleanexclude(java.lang.String name)
Exclude attribute that cannot be serialized.

param
name the attribute's name


        for (int i = 0; i < excludedAttributes.length; i++) {
            if (name.equalsIgnoreCase(excludedAttributes[i]))
                return true;
        }

        return false;
public voidexpire()
Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.


        expire(true);
public voidexpire(boolean notify)
Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.

param
notify Should we notify listeners about the demise of this session?

        expire(notify, true);
public voidexpire(boolean notify, boolean persistentRemove)
Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.

param
notify Should we notify listeners about the demise of this session?
param
persistentRemove should we call store to remove the session if available


        // Mark this session as "being expired" if needed
        if (expiring)
            return;

        synchronized (this) {

            if (manager == null)
                return;

            expiring = true;
        
            // Notify interested application event listeners
            // FIXME - Assumes we call listeners in reverse order
            Context context = (Context) manager.getContainer();
            Object listeners[] = context.getApplicationLifecycleListeners();
            if (notify && (listeners != null) && (listeners.length > 0)) {
                HttpSessionEvent event =
                    new HttpSessionEvent(getSession());
                for (int i = 0; i < listeners.length; i++) {
                    int j = (listeners.length - 1) - i;
                    if (!(listeners[j] instanceof HttpSessionListener))
                        continue;
                    HttpSessionListener listener =
                        (HttpSessionListener) listeners[j];
                    try {
                        fireContainerEvent(context,
                                           "beforeSessionDestroyed",
                                           listener);
                        listener.sessionDestroyed(event);
                        fireContainerEvent(context,
                                           "afterSessionDestroyed",
                                           listener);
                    } catch (Throwable t) {
                        try {
                            fireContainerEvent(context,
                                               "afterSessionDestroyed",
                                               listener);
                        } catch (Exception e) {
                            ;
                        }
                        // FIXME - should we do anything besides log these?
                        log(sm.getString("standardSession.sessionEvent"), t);
                    }
                }
            }
            accessCount = 0;
            setValid(false);

            /*
             * Compute how long this session has been alive, and update
             * session manager's related properties accordingly
             */
            long timeNow = System.currentTimeMillis();
            int timeAlive = (int) ((timeNow - creationTime)/1000);
            synchronized (manager) {
                if (timeAlive > manager.getSessionMaxAliveTimeSeconds()) {
                    manager.setSessionMaxAliveTimeSeconds(timeAlive);
                }
                int numExpired = manager.getExpiredSessions();
                numExpired++;
                manager.setExpiredSessions(numExpired);
                int average = manager.getSessionAverageAliveTimeSeconds();
                average = ((average * (numExpired-1)) + timeAlive)/numExpired;
                manager.setSessionAverageAliveTimeSeconds(average);
            }
            
            // Remove this session from our manager's active sessions
            if(persistentRemove) {
                manager.remove(this);
            } else {
                if(manager instanceof PersistentManagerBase) {
                    ((PersistentManagerBase)manager).remove(this, false);
                }
            }            

            /*
             * Mark session as expired *before* removing its attributes, so
             * that its HttpSessionBindingListener objects will get an
             * IllegalStateException when accessing the session attributes
             * from within their valueUnbound() method
             */ 
            expiring = false;

            // Unbind any objects associated with this session
            String keys[] = keys();
            for (int i = 0; i < keys.length; i++)
                removeAttribute(keys[i], notify, false);

            // Notify interested session event listeners
            if (notify) {
                fireSessionEvent(Session.SESSION_DESTROYED_EVENT, null);
            }

        }
protected voidfireContainerEvent(org.apache.catalina.Context context, java.lang.String type, java.lang.Object data)
Fire container events if the Context implementation is the org.apache.catalina.core.StandardContext.

param
context Context for which to fire events
param
type Event type
param
data Event data
exception
Exception occurred during event firing


        if (!(context instanceof StandardContext)) {
            return; // Container events are not supported
        }
        // NOTE:  Race condition is harmless, so do not synchronize
        if (containerEventMethod == null) {
            containerEventMethod =
                context.getClass().getMethod("fireContainerEvent",
                                             containerEventTypes);
        }
        Object containerEventParams[] = new Object[2];
        containerEventParams[0] = type;
        containerEventParams[1] = data;
        containerEventMethod.invoke(context, containerEventParams);
public voidfireSessionEvent(java.lang.String type, java.lang.Object data)
Notify all session event listeners that a particular event has occurred for this Session. The default implementation performs this notification synchronously using the calling thread.

param
type Event type
param
data Event data

        if (listeners.size() < 1)
            return;
        SessionEvent event = new SessionEvent(this, type, data);
        SessionListener list[] = new SessionListener[0];
        synchronized (listeners) {
            list = (SessionListener[]) listeners.toArray(list);
        }

        for (int i = 0; i < list.length; i++){
            ((SessionListener) list[i]).sessionEvent(event);
        }
public java.lang.ObjectgetAttribute(java.lang.String name)
Return the object bound with the specified name in this session, or null if no object is bound with that name.

param
name Name of the attribute to be returned
exception
IllegalStateException if this method is called on an invalidated session


        if (!isValid())
            throw new IllegalStateException
                (sm.getString("standardSession.getAttribute.ise"));

        return (attributes.get(name));
protected java.lang.ObjectgetAttributeInternal(java.lang.String name)
Return the value of an attribute without a check for validity.

        return (attributes.get(name));
public java.util.EnumerationgetAttributeNames()
Return an Enumeration of String objects containing the names of the objects bound to this session.

exception
IllegalStateException if this method is called on an invalidated session


        if (!isValid())
            throw new IllegalStateException
                (sm.getString("standardSession.getAttributeNames.ise"));

        synchronized (attributes) {
            return (new Enumerator(attributes.keySet(), true));
        }
public java.lang.StringgetAuthType()
Return the authentication type used to authenticate our cached Principal, if any.



    // ----------------------------------------------------- Session Properties


                     
       

        return (this.authType);
public longgetCreationTime()
Return the time when this session was created, in milliseconds since midnight, January 1, 1970 GMT.

exception
IllegalStateException if this method is called on an invalidated session


        if (!isValid())
            throw new IllegalStateException
                (sm.getString("standardSession.getCreationTime.ise"));

        return (this.creationTime);
public java.lang.StringgetId()
Return the session identifier for this session.


        return getIdInternal();
public java.lang.StringgetIdInternal()
Return the session identifier for this session.


        return (this.id);
public java.lang.StringgetInfo()
Return descriptive information about this Session implementation and the corresponding version number, in the format <description>/<version>.


        return (this.info);
public booleangetIsValid()

        return this.isValid;
public longgetLastAccessedTime()
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.

        if ( !isValid() ) {
            throw new IllegalStateException
                (sm.getString("standardSession.getLastAccessedTime.ise"));
        }
        return (this.lastAccessedTime);
public longgetLastAccessedTimeInternal()
Same as getLastAccessedTime(), except that there is no call to isValid(), which may expire the session and cause any subsequent session access to throw an IllegalStateException.

        return this.lastAccessedTime;
public org.apache.catalina.ManagergetManager()
Return the Manager within which this Session is valid.


        return (this.manager);
public intgetMaxInactiveInterval()
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.


        return (this.maxInactiveInterval);
public java.lang.ObjectgetNote(java.lang.String name)
Return the object bound with the specified name to the internal notes for this session, or null if no such binding exists.

param
name Name of the note to be returned

        return (notes.get(name));
public java.util.IteratorgetNoteNames()
Return an Iterator containing the String names of all notes bindings that exist for this session.

        return (notes.keySet().iterator());
public java.security.PrincipalgetPrincipal()
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.


        return (this.principal);
public javax.servlet.ServletContextgetServletContext()
Return the ServletContext to which this session belongs.


        if (manager == null)
            return (null);
        Context context = (Context) manager.getContainer();
        if (context == null)
            return (null);
        else
            return (context.getServletContext());
public javax.servlet.http.HttpSessiongetSession()
Return the HttpSession for which this object is the facade.


        if (facade == null){
            if (SecurityUtil.isPackageProtectionEnabled()){
                final StandardSession fsession = this;
                facade = (StandardSessionFacade)AccessController.doPrivileged(new PrivilegedAction(){
                    public Object run(){
                        return new StandardSessionFacade(fsession);
                    }
                });
            } else {
                facade = new StandardSessionFacade(this);
            }
        }
        return (facade);
public javax.servlet.http.HttpSessionContextgetSessionContext()
Return the session context with which this session is associated.

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.


        if (sessionContext == null)
            sessionContext = new StandardSessionContext();
        return (sessionContext);
public SessionLockgetSessionLock()
return the Session lock

        return _sessionLock;
protected booleangetSessionLockForForeground()
get this session locked for foreground if the session is found to be presently background locked; retry logic in a time-decay polling loop waits for background lock to clear after 6 attempts (12.6 seconds) it unlocks the session and acquires the foreground lock

        boolean result = false;
        StandardSession sess = (StandardSession) this;       
        //now lock the session
        //System.out.println("IN LOCK_SESSION_FOR_FOREGROUND: sess =" + sess);        
        long pollTime = 200L;
        int tryNumber = 0;
        int numTries = 7;
        boolean keepTrying = true;
        boolean lockResult = false;
        //System.out.println("locking session: sess =" + sess);
        //try to lock up to numTries (i.e. 7) times
        //poll and wait starting with 200 ms
        while(keepTrying) {
            lockResult = sess.lockForeground();
            if(lockResult) {
                keepTrying = false;
                result = true;
                break;
            }
            tryNumber++;
            if(tryNumber < (numTries - 1) ) {
                pollTime = pollTime * 2L;
            } else {
                //unlock the background so we can take over
                //FIXME: need to log warning for this situation
                sess.unlockBackground();
            }              
        }
        //System.out.println("finished locking session: sess =" + sess);
        //System.out.println("LOCK = " + sess.getSessionLock());
        return result;
public java.lang.ObjectgetValue(java.lang.String name)
Return the object bound with the specified name in this session, or null if no object is bound with that name.

param
name Name of the value to be returned
exception
IllegalStateException if this method is called on an invalidated session
deprecated
As of Version 2.2, this method is replaced by getAttribute()


        return (getAttribute(name));
public java.lang.String[]getValueNames()
Return the set of names of objects bound to this session. If there are no such objects, a zero-length array is returned.

exception
IllegalStateException if this method is called on an invalidated session
deprecated
As of Version 2.2, this method is replaced by getAttributeNames()


        if (!isValid())
            throw new IllegalStateException
                (sm.getString("standardSession.getValueNames.ise"));

        return (keys());
public longgetVersion()
Gets the version number

        return version;
public booleanhasExpired()
Checks whether this Session has expired.

return
true if this Session has expired, false otherwise


        if (maxInactiveInterval >= 0
                && (System.currentTimeMillis() - thisAccessedTime >=
                    maxInactiveInterval * 1000)) {
            return true;
        } else {
            return false;
        }
public voidincrementVersion()
Increments the version number

        version++;
public voidinvalidate()
Invalidates this session and unbinds any objects bound to it.

exception
IllegalStateException if this method is called on an invalidated session HERCULES:modified method


// ------------------------end session locking ---HERCULES:add--------        
    


                                 
       

        if (!isValid)
            throw new IllegalStateException
                (sm.getString("standardSession.invalidate.ise"));
        //make sure foreground locked first
        if(!this.isForegroundLocked()) {
            this.getSessionLockForForeground();
        }
        // Cause this session to expire
        try {
            expire();
        } finally {
            this.unlockForeground();
        }
public booleanisForegroundLocked()
return whether this session is currently foreground locked

        //in this case we are not using locks
        //so just return false
        if(_sessionLock == null)
            return false;        
        synchronized(this) {
            return _sessionLock.isForegroundLocked();
        }
public booleanisNew()
Return 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.

exception
IllegalStateException if this method is called on an invalidated session


        if (!isValid())
            throw new IllegalStateException
                (sm.getString("standardSession.isNew.ise"));

        return (this.isNew);
private booleanisSerializable(java.lang.Object value)
Returns true if the given value may be serialized, false otherwise. A given value is considered serializable if it is an instance of java.io.Serializable or com.sun.enterprise.spi.io.BaseIndirectlySerializable, or if special serialization logic for it exists. For example, in the case of GlassFish, instances of javax.naming.Context are replaced with corresponding instances of SerializableJNDIContext during serialization (this is done by the specialized object outputstream returned by the IOUtilsCaller factory mechanism).

return
true if the given value may be serialized, false otherwise

        if ((value instanceof Serializable)
                || (value instanceof BaseIndirectlySerializable)
                || (value instanceof javax.naming.Context)) {
            return true;
        } else {
            return false;
        }
public booleanisValid()
Return the isValid flag for this session.


        if (this.expiring){
            return true;
        }

        if (!this.isValid ) {
            return false;
        }

        if (accessCount > 0) {
            return true;
        }

        /* SJSAS 6329289
        if (maxInactiveInterval >= 0) { 
            long timeNow = System.currentTimeMillis();
            int timeIdle = (int) ((timeNow - thisAccessedTime) / 1000L);
            if (timeIdle >= maxInactiveInterval) {
                expire(true);
            }
        }
        */
        // START SJSAS 6329289
        if (hasExpired()) {
            expire(true);
        }
        // END SJSAS 6329289

        return (this.isValid);
protected java.lang.String[]keys()
Return the names of all currently defined session attributes as an array of Strings. If there are no defined attributes, a zero-length array is returned.

        if (attributes.size() > 0) {
            return ((String[]) attributes.keySet().toArray(EMPTY_ARRAY));
        } else {
            return EMPTY_ARRAY;
        }
public booleanlockBackground()
lock the session for foreground returns true if successful; false if unsuccessful

        //in this case we are not using locks
        //so just return true
        if(_sessionLock == null)
            return true;
        synchronized(this) {
            return _sessionLock.lockBackground();
        }
public booleanlockForeground()
lock the session for background returns true if successful; false if unsuccessful

        //in this case we are not using locks
        //so just return true
        if(_sessionLock == null)
            return true;
        synchronized(this) {
            return _sessionLock.lockForeground();
        }
protected voidlog(java.lang.String message)
Log a message on the Logger associated with our Manager (if any).

param
message Message to be logged


        if ((manager != null) && (manager instanceof ManagerBase)) {
            ((ManagerBase) manager).log(message);
        } else {
            System.out.println("StandardSession: " + message);
        }
protected voidlog(java.lang.String message, java.lang.Throwable throwable)
Log a message on the Logger associated with our Manager (if any).

param
message Message to be logged
param
throwable Associated exception


        if ((manager != null) && (manager instanceof ManagerBase)) {
            ((ManagerBase) manager).log(message, throwable);
        } else {
            System.out.println("StandardSession: " + message);
            throwable.printStackTrace(System.out);
        }
public voidpassivate()
Perform the internal processing required to passivate this session.


        // Notify ActivationListeners
        HttpSessionEvent event = null;
        String keys[] = keys();
        for (int i = 0; i < keys.length; i++) {
            Object attribute = getAttributeInternal(keys[i]);
            if (attribute instanceof HttpSessionActivationListener) {
                if (event == null)
                    event = new HttpSessionEvent(getSession());
                // FIXME: Should we catch throwables?
                ((HttpSessionActivationListener)attribute).sessionWillPassivate(event);
            }
        }
public voidputValue(java.lang.String name, java.lang.Object value)
Bind an object to this session, using the specified name. If an object of the same name is already bound to this session, the object is replaced.

After this method executes, and if the object implements HttpSessionBindingListener, the container calls valueBound() on the object.

param
name Name to which the object is bound, cannot be null
param
value Object to be bound, cannot be null
exception
IllegalStateException if this method is called on an invalidated session
deprecated
As of Version 2.2, this method is replaced by setAttribute()


        setAttribute(name, value);
private voidreadObject(java.io.ObjectInputStream stream)
Read a serialized version of this session object from the specified object input stream.

IMPLEMENTATION NOTE: The reference to the owning Manager is not restored by this method, and must be set explicitly.

param
stream The input stream to read from
exception
ClassNotFoundException if an unknown class is specified
exception
IOException if an input/output error occurs


        listeners = new ArrayList();
        notes = new Hashtable();

        // Deserialize the scalar instance variables (except Manager)
        authType = null;        // Transient only
        creationTime = ((Long) stream.readObject()).longValue();
        readRemainingObject(stream);
private voidreadRemainingObject(java.io.ObjectInputStream stream)
Reads the serialized session data from the given ObjectInputStream, with the assumption that the session's creation time, which appears first in the serialized data, has already been consumed.

param
stream The ObjectInputStream from which to read the serialized session data
exception
ClassNotFoundException If the class for an object being restored cannot be found.
exception
IOException if I/O errors occur


        lastAccessedTime = ((Long) stream.readObject()).longValue();
        maxInactiveInterval = ((Integer) stream.readObject()).intValue();
        isNew = ((Boolean) stream.readObject()).booleanValue();
        isValid = ((Boolean) stream.readObject()).booleanValue();
        thisAccessedTime = ((Long) stream.readObject()).longValue();
        /* SJSWS 6371339
        principal = null;        // Transient only
        //        setId((String) stream.readObject());
        id = (String) stream.readObject();
        */
        // START SJSWS 6371339
        // Read the next object, if it is of type Principal, then
        // store it in the principal variable
        Object obj = stream.readObject();
        if (obj instanceof Principal) {
            principal = (Principal)obj;
            id = (String) stream.readObject();
        }
        else {
            principal = null;
            id = (String) obj;
        }
        // END SJSWS 6371339
        if (debug >= 2)
            log("readObject() loading session " + id);

        // START PWC 6444754
        obj = stream.readObject();
        int n = 0;
        if (obj instanceof String) {
            authType = (String) obj;
            n = ((Integer) stream.readObject()).intValue();
        } else {
            n = ((Integer) obj).intValue();
        }
        // END PWC 6444754

        // Deserialize the attribute count and attribute values
        if (attributes == null)
            attributes = new Hashtable();
        /* PWC 6444754
        int n = ((Integer) stream.readObject()).intValue();
        */
        boolean isValidSave = isValid;
        isValid = true;
        for (int i = 0; i < n; i++) {
            String name = (String) stream.readObject();
            Object value = (Object) stream.readObject();
            if ((value instanceof String) && (value.equals(NOT_SERIALIZED)))
                continue;
            if (debug >= 2)
                log("  loading attribute '" + name +
                    "' with value '" + value + "'");
            attributes.put(name, value);
        }
        isValid = isValidSave;
public voidrecycle()
Release all object references, and initialize instance variables, in preparation for reuse of this object.


        // Reset the instance variables associated with this Session
        attributes.clear();
        setAuthType(null);
        creationTime = 0L;
        expiring = false;
        id = null;
        lastAccessedTime = 0L;
        maxInactiveInterval = -1;
        accessCount = 0;
        notes.clear();
        setPrincipal(null);
        isNew = false;
        isValid = false;

        listeners.clear();

        manager = null;
public voidremoveAttribute(java.lang.String name)
Remove the object bound with the specified name from this session. If the session does not have an object bound with this name, this method does nothing.

After this method executes, and if the object implements HttpSessionBindingListener, the container calls valueUnbound() on the object.

param
name Name of the object to remove from this session.
exception
IllegalStateException if this method is called on an invalidated session


        removeAttribute(name, true, true);
public voidremoveAttribute(java.lang.String name, boolean notify, boolean checkValid)
Remove the object bound with the specified name from this session. If the session does not have an object bound with this name, this method does nothing.

After this method executes, and if the object implements HttpSessionBindingListener, the container calls valueUnbound() on the object.

param
name Name of the object to remove from this session.
param
notify Should we notify interested listeners that this attribute is being removed?
param
checkValid Indicates whether IllegalStateException must be thrown if session has already been invalidated
exception
IllegalStateException if this method is called on an invalidated session


        // Name must not be null
        if (name == null) {
            throw new IllegalArgumentException
                (sm.getString("standardSession.removeAttribute.namenull"));
        }

        // Validate our current state
        if (!isValid() && checkValid)
            throw new IllegalStateException
                (sm.getString("standardSession.removeAttribute.ise"));

        // Remove this attribute from our collection
        Object value = null;
        value = attributes.remove(name);

        // Do we need to do valueUnbound() and attributeRemoved() notification?
        if (!notify || (value == null)) {
            return;
        }

        // Call the valueUnbound() method if necessary
        HttpSessionBindingEvent event = null;
        if (value instanceof HttpSessionBindingListener) {
            event = new HttpSessionBindingEvent(getSession(), name, value);
            ((HttpSessionBindingListener) value).valueUnbound(event);
        }
        
        // Notify special event listeners on removeAttribute
        //HERCULES:add
        StandardContext stdContext = (StandardContext) manager.getContainer();       
        // fire container event        
        stdContext.fireContainerEvent("sessionRemoveAttributeCalled", event);
        // fire sync container event if name equals SYNC_STRING
        if (SYNC_STRING.equals(name)) {
            stdContext.fireContainerEvent("sessionSync",  (new HttpSessionBindingEvent(getSession(), name)));
        }         
        //END HERCULES:add         

        // Notify interested application event listeners
        Context context = (Context) manager.getContainer();
        Object listeners[] = context.getApplicationEventListeners();
        if (listeners == null)
            return;
        for (int i = 0; i < listeners.length; i++) {
            if (!(listeners[i] instanceof HttpSessionAttributeListener))
                continue;
            HttpSessionAttributeListener listener =
                (HttpSessionAttributeListener) listeners[i];
            try {
                fireContainerEvent(context,
                                   "beforeSessionAttributeRemoved",
                                   listener);
                if (event == null) {
                    event = new HttpSessionBindingEvent(getSession(), name, value);
                }
                listener.attributeRemoved(event);
                fireContainerEvent(context,
                                   "afterSessionAttributeRemoved",
                                   listener);
            } catch (Throwable t) {
                try {
                    fireContainerEvent(context,
                                       "afterSessionAttributeRemoved",
                                       listener);
                } catch (Exception e) {
                    ;
                }
                log(sm.getString("standardSession.attributeEvent"), t);
            }
        }
public voidremoveNote(java.lang.String name)
Remove any object bound to the specified name in the internal notes for this session.

param
name Name of the note to be removed

        notes.remove(name);
public voidremoveSessionListener(org.apache.catalina.SessionListener listener)
Remove a session event listener from this component.


        synchronized (listeners) {
            listeners.remove(listener);
        }
public voidremoveValue(java.lang.String name)
Remove the object bound with the specified name from this session. If the session does not have an object bound with this name, this method does nothing.

After this method executes, and if the object implements HttpSessionBindingListener, the container calls valueUnbound() on the object.

param
name Name of the object to remove from this session.
exception
IllegalStateException if this method is called on an invalidated session
deprecated
As of Version 2.2, this method is replaced by removeAttribute()


        removeAttribute(name);
public voidsetAttribute(java.lang.String name, java.lang.Object value)
Bind an object to this session, using the specified name. If an object of the same name is already bound to this session, the object is replaced.

After this method executes, and if the object implements HttpSessionBindingListener, the container calls valueBound() on the object.

param
name Name to which the object is bound, cannot be null
param
value Object to be bound, cannot be null
exception
IllegalArgumentException if an attempt is made to add a non-serializable object in an environment marked distributable.
exception
IllegalStateException if this method is called on an invalidated session


        // Name cannot be null
        if (name == null)
            throw new IllegalArgumentException
                (sm.getString("standardSession.setAttribute.namenull"));

        // Null value is the same as removeAttribute()
        if (value == null) {
            removeAttribute(name);
            return;
        }

        // Validate our current state
        if (!isValid())
            throw new IllegalStateException
                (sm.getString("standardSession.setAttribute.ise"));
        
        if ((manager != null)
                    && manager.getDistributable()
                    && !isSerializable(value)) {
            	throw new IllegalArgumentException
                	(sm.getString("standardSession.setAttribute.iae")); 
	}

        // Construct an event with the new value
        HttpSessionBindingEvent event = null;

        // Call the valueBound() method if necessary
        if (value instanceof HttpSessionBindingListener) {
            event = new HttpSessionBindingEvent(getSession(), name, value);
            try {
                ((HttpSessionBindingListener) value).valueBound(event);
            } catch (Throwable t){
                log(sm.getString("standardSession.bindingEvent"), t); 
            }
        }

        // Replace or add this attribute
        Object unbound = null;
        unbound = attributes.put(name, value);

        // Call the valueUnbound() method if necessary
        if ((unbound != null) &&
            (unbound instanceof HttpSessionBindingListener)) {
            try {
                ((HttpSessionBindingListener) unbound).valueUnbound
                    (new HttpSessionBindingEvent(getSession(), name));
            } catch (Throwable t) {
                log(sm.getString("standardSession.bindingEvent"), t);
            }
        }
        
        //HERCULES:add
        StandardContext stdCtx = (StandardContext) manager.getContainer();        
        // fire sync container event if name equals SYNC_STRING
        if (SYNC_STRING.equals(name)) {
            stdCtx.fireContainerEvent("sessionSync",  (new HttpSessionBindingEvent(getSession(), name)));
        }
        //end HERCULES:add

        // Notify interested application event listeners
        Context context = (Context) manager.getContainer();
        Object listeners[] = context.getApplicationEventListeners();
        if (listeners == null)
            return;
        for (int i = 0; i < listeners.length; i++) {
            if (!(listeners[i] instanceof HttpSessionAttributeListener))
                continue;
            HttpSessionAttributeListener listener =
                (HttpSessionAttributeListener) listeners[i];
            try {
                if (unbound != null) {
                    fireContainerEvent(context,
                                       "beforeSessionAttributeReplaced",
                                       listener);
                    if (event == null) {
                        event = new HttpSessionBindingEvent
                            (getSession(), name, unbound);
                    }
                    listener.attributeReplaced(event);
                    fireContainerEvent(context,
                                       "afterSessionAttributeReplaced",
                                       listener);
                } else {
                    fireContainerEvent(context,
                                       "beforeSessionAttributeAdded",
                                       listener);
                    if (event == null) {
                        event = new HttpSessionBindingEvent(
                                        getSession(), name, value);
                    }
                    listener.attributeAdded(event);
                    fireContainerEvent(context,
                                       "afterSessionAttributeAdded",
                                       listener);
                }
            } catch (Throwable t) {
                try {
                    if (unbound != null) {
                        fireContainerEvent(context,
                                           "afterSessionAttributeReplaced",
                                           listener);
                    } else {
                        fireContainerEvent(context,
                                           "afterSessionAttributeAdded",
                                           listener);
                    }
                } catch (Exception e) {
                    ;
                }
                log(sm.getString("standardSession.attributeEvent"), t);
            }
        }
public voidsetAuthType(java.lang.String authType)
Set the authentication type used to authenticate our cached Principal, if any.

param
authType The new cached authentication type


        String oldAuthType = this.authType;
        this.authType = authType;
public voidsetCreationTime(long time)
Set the creation time for this session. This method is called by the Manager when an existing Session instance is reused.

param
time The new creation time


        this.creationTime = time;
        this.lastAccessedTime = time;
        this.thisAccessedTime = time;
public voidsetId(java.lang.String id)
Set the session identifier for this session.

param
id The new session identifier


        if ((this.id != null) && (manager != null))
            manager.remove(this);

        this.id = id;

        if (manager != null)
            manager.add(this);
        tellNew();
public voidsetLastAccessedTime(long lastAcessedTime)
Set 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. HERCULES: added method

        this.lastAccessedTime = lastAcessedTime;
public voidsetManager(org.apache.catalina.Manager manager)
Set the Manager within which this Session is valid.

param
manager The new Manager


        this.manager = manager;
public voidsetMaxInactiveInterval(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.

param
interval The new maximum interval


        this.maxInactiveInterval = interval;
        if (isValid && interval == 0) {
            expire();
        }
public voidsetNew(boolean isNew)
Set the isNew flag for this session.

param
isNew The new value for the isNew flag


        this.isNew = isNew;
public voidsetNote(java.lang.String name, java.lang.Object value)
Bind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name.

param
name Name to which the object should be bound
param
value Object to be bound to the specified name

        notes.put(name, value);
public voidsetPrincipal(java.security.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.

param
principal The new Principal, or null if none


        Principal oldPrincipal = this.principal;
        this.principal = principal;
public voidsetSessionLock(SessionLock sessionLock)
set the Session lock

param
sessionLock

        _sessionLock = sessionLock;
public voidsetValid(boolean isValid)
Set the isValid flag for this session.

param
isValid The new value for the isValid flag


        this.isValid = isValid;
        //SJSAS 6406580 START
        if (!isValid && (getManager() instanceof PersistentManagerBase)) {
            ((PersistentManagerBase) getManager()).addToInvalidatedSessions(this.id);            
        }
        //SJSAS 6406580 END
public voidsetVersion(long value)
Sets the version number

        version = value;
public voidtellNew()
Inform the listeners about the new session.


        // Notify interested session event listeners
        fireSessionEvent(Session.SESSION_CREATED_EVENT, null);

        // Notify interested application event listeners
        Context context = (Context) manager.getContainer();
        Object listeners[] = context.getApplicationLifecycleListeners();
        if (listeners != null && (listeners.length > 0)) {
            HttpSessionEvent event =
                new HttpSessionEvent(getSession());
            for (int i = 0; i < listeners.length; i++) {
                if (!(listeners[i] instanceof HttpSessionListener))
                    continue;
                HttpSessionListener listener =
                    (HttpSessionListener) listeners[i];
                try {
                    fireContainerEvent(context,
                                       "beforeSessionCreated",
                                       listener);
                    listener.sessionCreated(event);
                    fireContainerEvent(context,
                                       "afterSessionCreated",
                                       listener);
                } catch (Throwable t) {
                    try {
                        fireContainerEvent(context,
                                           "afterSessionCreated",
                                           listener);
                    } catch (Exception e) {
                        ;
                    }
                    log(sm.getString("standardSession.sessionEvent"), t);
                }
            }
        }
public java.lang.StringtoString()
Return a string representation of this object.


        // STARTS S1AS
        /*
        StringBuffer sb = new StringBuffer();
        sb.append("StandardSession[");
        sb.append(id);
        sb.append("]");
        return (sb.toString());
        */
        // END S1AS
        // START S1AS
        StringBuffer sb = null;

        if(!this.isValid) {
            sb = new StringBuffer();
        } else {
            sb = new StringBuffer(1000);
        }

        sb.append("StandardSession[");
        sb.append(id);
        sb.append("]");
        
        if (this.isValid) {
            Enumeration<String> attrNamesEnum = getAttributeNames();
            while(attrNamesEnum.hasMoreElements()) {
                String nextAttrName = attrNamesEnum.nextElement();
                Object nextAttrValue = getAttribute(nextAttrName);
                sb.append("\n");
                sb.append("attrName = " + nextAttrName);
                sb.append(" : attrValue = " + nextAttrValue);
            }
        }

        return sb.toString();
        // END S1AS
public voidunlockBackground()
unlock the session from background

        //in this case we are not using locks
        //so just return true
        if(_sessionLock == null)
            return;
        synchronized(this) {
            _sessionLock.unlockBackground();
        }
public voidunlockForeground()
unlock the session from foreground

        //in this case we are not using locks
        //so just return true
        if(_sessionLock == null)
            return;
        synchronized(this) {
            _sessionLock.unlockForeground();
        }
public voidunlockForegroundCompletely()
unlock the session completely irregardless of whether it was foreground or background locked

        //in this case we are not using locks
        //so just return true
        if(_sessionLock == null)
            return;
        synchronized(this) {
            _sessionLock.unlockForegroundCompletely();
        }
private voidwriteObject(java.io.ObjectOutputStream stream)
Write a serialized version of this session object to the specified object output stream.

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.

param
stream The output stream to write to
exception
IOException if an input/output error occurs


        // Write the scalar instance variables (except Manager)
        stream.writeObject(Long.valueOf(creationTime));
        stream.writeObject(Long.valueOf(lastAccessedTime));
        stream.writeObject(Integer.valueOf(maxInactiveInterval));
        stream.writeObject(Boolean.valueOf(isNew));
        stream.writeObject(Boolean.valueOf(isValid));
        stream.writeObject(Long.valueOf(thisAccessedTime));
        // START SJSWS 6371339
        // If the principal is serializable, write it out
        // START PWC 6444754
        boolean serialPrincipal = false;
        // END PWC 6444754
        if (principal instanceof java.io.Serializable) {
            // START PWC 6444754
            serialPrincipal = true;
            // END PWC 6444754
            stream.writeObject(principal);
        }
        // END SJSWS 6371339
        stream.writeObject(id);
        if (debug >= 2)
            log("writeObject() storing session " + id);

        // START PWC 6444754
        if (serialPrincipal && authType != null) {
            stream.writeObject(authType);
        }
        // END PWC 6444754

        // Accumulate the names of serializable and non-serializable attributes
        String keys[] = keys();
        ArrayList saveNames = new ArrayList();
        ArrayList saveValues = new ArrayList();
        for (int i = 0; i < keys.length; i++) {
            Object value = null;
            value = attributes.get(keys[i]);

            if (value == null) {
                continue;            

            //HERCULES:mod
            /* original PE code next 4 lines
            else if (value instanceof Serializable) {
                saveNames.add(keys[i]);
                saveValues.add(value);
            }
             */ 
            //original Hercules code was next line
            //else if (value instanceof Serializable || value instanceof javax.ejb.EJBLocalObject || value instanceof javax.naming.Context || value instanceof javax.ejb.EJBLocalHome ) { //Bug 4853798
            //FIXME: IndirectlySerializable includes more than 3 classes in Hercules code
            //need to explore implications of this

            } else if (isSerializable(value)) {    
                saveNames.add(keys[i]);
                saveValues.add(value);
            //end HERCULES:mod             
            } 
        }

        // Serialize the attribute count and the Serializable attributes
        int n = saveNames.size();
        stream.writeObject(Integer.valueOf(n));
        for (int i = 0; i < n; i++) {
            stream.writeObject((String) saveNames.get(i));
            //HERCULES:mod
            /* orignal PE code            
            try {
                stream.writeObject(saveValues.get(i));
                if (debug >= 2)
                    log("  storing attribute '" + saveNames.get(i) +
                        "' with value '" + saveValues.get(i) + "'");
            } catch (NotSerializableException e) {
                log(sm.getString("standardSession.notSerializable",
                                 saveNames.get(i), id), e);
                stream.writeObject(NOT_SERIALIZED);
                if (debug >= 2)
                    log("  storing attribute '" + saveNames.get(i) +
                        "' with value NOT_SERIALIZED");
            }
             *end original PE code
             */ 
            
            //following is replacement code from Hercules
            try {
                stream.writeObject(saveValues.get(i));
                if (debug >= 2)
                    log("  storing attribute '" + saveNames.get(i) +
                        "' with value '" + saveValues.get(i) + "'");
            } catch (NotSerializableException e) {
                log(sm.getString("standardSession.notSerializable",
                                 saveNames.get(i), id), e);
                stream.writeObject(NOT_SERIALIZED);
                if (debug >= 2)
                    log("  storing attribute '" + saveNames.get(i) +
                        "' with value NOT_SERIALIZED");
            } catch (IOException ioe) {
		if ( ioe.getCause() instanceof NotSerializableException ) {
                	log(sm.getString("standardSession.notSerializable",
                       	          saveNames.get(i), id), ioe);
                	stream.writeObject(NOT_SERIALIZED);
                	if (debug >= 2)
                    		log("  storing attribute '" + saveNames.get(i) +
                        	"' with value NOT_SERIALIZED");
		} else 
			throw ioe;
	    }
            //end HERCULES:mod
        }