Class DeltaSession
- All Implemented Interfaces:
- Externalizable,- Serializable,- HttpSession,- ClusterSession,- Session,- ReplicatedMapEntry
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected final Lockstatic final Logprotected static final StringManagerThe string manager for this package.Fields inherited from class org.apache.catalina.session.StandardSessionaccessCount, ACTIVITY_CHECK, attributes, authType, creationTime, EMPTY_ARRAY, expiring, facade, id, isNew, isValid, LAST_ACCESS_AT_START, lastAccessedTime, listeners, manager, maxInactiveInterval, notes, principal, sessionContext, STRICT_SERVLET_COMPLIANCE, support, thisAccessedTimeFields inherited from interface org.apache.catalina.SessionSESSION_ACTIVATED_EVENT, SESSION_CREATED_EVENT, SESSION_DESTROYED_EVENT, SESSION_PASSIVATED_EVENT
- 
Constructor SummaryConstructorsConstructorDescriptionDeltaSession(Manager manager) Construct a new Session associated with the specified Manager.
- 
Method SummaryModifier and TypeMethodDescriptionvoidAccess to an existing object.voidaddSessionListener(SessionListener listener) Add a session event listener to this component.voidaddSessionListener(SessionListener listener, boolean addDeltaRequest) voidapplyDiff(byte[] diff, int offset, int length) Applies a diff to an existing object.protected DeltaRequestcreateRequest(String sessionId, boolean recordAllActions) protected voiddeserializeAndExecuteDeltaRequest(byte[] delta) protected voiddoReadObject(ObjectInputStream stream) Read a serialized version of this session object from the specified object input stream.protected voiddoWriteObject(ObjectOutputStream stream) Write a serialized version of this session object to the specified object output stream.voidEnd access to the session.voidexpire(boolean notify) Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.voidexpire(boolean notify, boolean notifyCluster) Deprecated.Unused.byte[]getDiff()Returns a diff and sets the dirty map to falselonglongFor accuracy checking, a serialized attribute can contain a version number This number increases as modifications are made to the data.booleanIf this returns true, to replicate that an object has been accessedbooleanIf this returns true, the map will extract the diff using getDiff() Otherwise it will serialize the entire object.booleanisDirty()Has the object changed since last replication and is not in a locked statebooleanreturns true if this session is the primary session, if that is the case, the manager can expire it upon timeout.booleanisValid()voidlock()Lock during serializationvoidvoidreadObjectData(ObjectInput stream) voidreadObjectData(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.voidrecycle()Release all object references, and initialize instance variables, in preparation for reuse of this object.voidremoveAttribute(String name, boolean notify) Remove the object bound with the specified name from this session.voidremoveAttribute(String name, boolean notify, boolean addDeltaRequest) protected voidremoveAttributeInternal(String name, boolean notify, boolean addDeltaRequest) voidremoveNote(String name) Remove any object bound to the specified name in the internal notes for this session.voidremoveNote(String name, boolean addDeltaRequest) voidremoveSessionListener(SessionListener listener) Remove a session event listener from this component.voidremoveSessionListener(SessionListener listener, boolean addDeltaRequest) voidvoidResets the current diff state and resets the dirty flagprotected voidsetAccessCount(int count) voidsetAttribute(String name, Object value) Binds an object to this session, using the name specified.voidsetAttribute(String name, Object value, boolean notify, boolean addDeltaRequest) voidsetAuthType(String authType) Set the authentication type used to authenticate our cached Principal, if any.voidsetAuthType(String authType, boolean addDeltaRequest) voidSet the session identifier for this session and notifies any associated listeners that a new session has been created.voidSet the session identifier for this session and optionally notifies any associated listeners that a new session has been created.voidsetLastTimeReplicated(long lastTimeReplicated) Set the last replicate time.voidsetMaxInactiveInterval(int interval) Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.voidsetMaxInactiveInterval(int interval, boolean addDeltaRequest) voidsetNew(boolean isNew) Set theisNewflag for this session.voidsetNew(boolean isNew, boolean addDeltaRequest) voidBind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name.voidvoidThis method is called after the object has been created on a remote map.voidsetPrimarySession(boolean primarySession) Sets whether this is the primary session or not.voidsetPrincipal(Principal principal) Set the authenticated Principal that is associated with this Session.voidsetPrincipal(Principal principal, boolean addDeltaRequest) voidsetVersion(long version) Forces a certain version to a replicated map entrytoString()voidunlock()Unlock after serializationvoidvoidwriteObjectData(ObjectOutput stream) voidwriteObjectData(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.Methods inherited from class org.apache.catalina.session.StandardSessionaccess, activate, exclude, expire, fireSessionEvent, getAttribute, getAttributeNames, getAuthType, getCreationTime, getCreationTimeInternal, getId, getIdInternal, getIdleTime, getIdleTimeInternal, getLastAccessedTime, getLastAccessedTimeInternal, getManager, getMaxInactiveInterval, getNote, getNoteNames, getPrincipal, getServletContext, getSession, getSessionContext, getThisAccessedTime, getThisAccessedTimeInternal, getValue, getValueNames, invalidate, isAttributeDistributable, isNew, isValidInternal, keys, passivate, putValue, removeAttribute, removeAttributeInternal, removeValue, setAttribute, setCreationTime, setManager, setValid, tellChangedSessionId, tellNewMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface javax.servlet.http.HttpSessiongetAttribute, getAttributeNames, getCreationTime, getId, getLastAccessedTime, getMaxInactiveInterval, getServletContext, getSessionContext, getValue, getValueNames, invalidate, isNew, putValue, removeAttribute, removeValueMethods inherited from interface org.apache.catalina.Sessionaccess, expire, getAuthType, getCreationTime, getCreationTimeInternal, getId, getIdInternal, getIdleTime, getIdleTimeInternal, getLastAccessedTime, getLastAccessedTimeInternal, getManager, getMaxInactiveInterval, getNote, getNoteNames, getPrincipal, getSession, getThisAccessedTime, getThisAccessedTimeInternal, isAttributeDistributable, setCreationTime, setManager, setValid, tellChangedSessionId
- 
Field Details- 
log
- 
smThe string manager for this package.
- 
diffLock
 
- 
- 
Constructor Details- 
DeltaSessionpublic DeltaSession()
- 
DeltaSessionConstruct a new Session associated with the specified Manager.- Parameters:
- manager- The manager with which this Session is associated
 
 
- 
- 
Method Details- 
createRequest
- 
isDirtypublic boolean isDirty()Description copied from interface:ReplicatedMapEntryHas the object changed since last replication and is not in a locked state- Specified by:
- isDirtyin interface- ReplicatedMapEntry
- Returns:
- boolean
 
- 
isDiffablepublic boolean isDiffable()Description copied from interface:ReplicatedMapEntryIf this returns true, the map will extract the diff using getDiff() Otherwise it will serialize the entire object.- Specified by:
- isDiffablein interface- ReplicatedMapEntry
- Returns:
- boolean
 
- 
getDiffDescription copied from interface:ReplicatedMapEntryReturns a diff and sets the dirty map to false- Specified by:
- getDiffin interface- ReplicatedMapEntry
- Returns:
- Serialized diff data
- Throws:
- IOException- IO error serializing
 
- 
getClassLoaders
- 
applyDiffpublic void applyDiff(byte[] diff, int offset, int length) throws IOException, ClassNotFoundException Description copied from interface:ReplicatedMapEntryApplies a diff to an existing object.- Specified by:
- applyDiffin interface- ReplicatedMapEntry
- Parameters:
- diff- Serialized diff data
- offset- Array offset
- length- Array length
- Throws:
- IOException- IO error deserializing
- ClassNotFoundException- Serialization error
 
- 
resetDiffpublic void resetDiff()Resets the current diff state and resets the dirty flagThis implementation is a NO-OP. The diff is reset in getDiff().- Specified by:
- resetDiffin interface- ReplicatedMapEntry
 
- 
lockpublic void lock()Lock during serializationThis implementation is a NO-OP. Any required locking takes place in the methods that make modifications. - Specified by:
- lockin interface- ReplicatedMapEntry
 
- 
unlockpublic void unlock()Unlock after serializationThis implementation is a NO-OP. Any required unlocking takes place in the methods that make modifications. - Specified by:
- unlockin interface- ReplicatedMapEntry
 
- 
setOwnerDescription copied from interface:ReplicatedMapEntryThis method is called after the object has been created on a remote map. On this method, the object can initialize itself for any data that wasn't- Specified by:
- setOwnerin interface- ReplicatedMapEntry
- Parameters:
- owner- Object
 
- 
isAccessReplicatepublic boolean isAccessReplicate()Description copied from interface:ReplicatedMapEntryIf this returns true, to replicate that an object has been accessed- Specified by:
- isAccessReplicatein interface- ReplicatedMapEntry
- Returns:
- boolean
 
- 
accessEntrypublic void accessEntry()Description copied from interface:ReplicatedMapEntryAccess to an existing object.- Specified by:
- accessEntryin interface- ReplicatedMapEntry
 
- 
isPrimarySessionpublic boolean isPrimarySession()Description copied from interface:ClusterSessionreturns true if this session is the primary session, if that is the case, the manager can expire it upon timeout.- Specified by:
- isPrimarySessionin interface- ClusterSession
- Returns:
- True if this session is primary
 
- 
setPrimarySessionpublic void setPrimarySession(boolean primarySession) Description copied from interface:ClusterSessionSets whether this is the primary session or not.- Specified by:
- setPrimarySessionin interface- ClusterSession
- Parameters:
- primarySession- Flag value
 
- 
setIdDescription copied from interface:SessionSet the session identifier for this session and optionally notifies any associated listeners that a new session has been created.- Specified by:
- setIdin interface- Session
- Overrides:
- setIdin class- StandardSession
- Parameters:
- id- The new session identifier
- notify- Should any associated listeners be notified that a new session has been created?
 
- 
setIdDescription copied from interface:SessionSet the session identifier for this session and notifies any associated listeners that a new session has been created.- Specified by:
- setIdin interface- Session
- Overrides:
- setIdin class- StandardSession
- Parameters:
- id- The new session identifier
 
- 
setMaxInactiveIntervalpublic void setMaxInactiveInterval(int interval) Description copied from interface:javax.servlet.http.HttpSessionSpecifies the time, in seconds, between client requests before the servlet container will invalidate this session. A zero or negative time indicates that the session should never timeout.- Specified by:
- setMaxInactiveIntervalin interface- HttpSession
- Specified by:
- setMaxInactiveIntervalin interface- Session
- Overrides:
- setMaxInactiveIntervalin class- StandardSession
- Parameters:
- interval- An integer specifying the number of seconds
 
- 
setMaxInactiveIntervalpublic void setMaxInactiveInterval(int interval, boolean addDeltaRequest) 
- 
setNewpublic void setNew(boolean isNew) Description copied from interface:SessionSet theisNewflag for this session.- Specified by:
- setNewin interface- Session
- Overrides:
- setNewin class- StandardSession
- Parameters:
- isNew- The new value for the- isNewflag
 
- 
setNewpublic void setNew(boolean isNew, boolean addDeltaRequest) 
- 
setPrincipalDescription copied from interface:SessionSet the authenticated Principal that is associated with this Session. This provides anAuthenticatorwith a means to cache a previously authenticated Principal, and avoid potentially expensiveRealm.authenticate()calls on every request.- Specified by:
- setPrincipalin interface- Session
- Overrides:
- setPrincipalin class- StandardSession
- Parameters:
- principal- The new Principal, or- nullif none
 
- 
setPrincipal
- 
setAuthTypeDescription copied from interface:SessionSet the authentication type used to authenticate our cached Principal, if any.- Specified by:
- setAuthTypein interface- Session
- Overrides:
- setAuthTypein class- StandardSession
- Parameters:
- authType- The new cached authentication type
 
- 
setAuthType
- 
isValidpublic boolean isValid()- Specified by:
- isValidin interface- Session
- Overrides:
- isValidin class- StandardSession
- Returns:
- trueif the session is still valid
 
- 
endAccesspublic void endAccess()Description copied from interface:SessionEnd access to the session.- Specified by:
- endAccessin interface- Session
- Overrides:
- endAccessin class- StandardSession
 
- 
expirepublic void expire(boolean notify) Description copied from class:StandardSessionPerform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.- Overrides:
- expirein class- StandardSession
- Parameters:
- notify- Should we notify listeners about the demise of this session?
 
- 
expirepublic void expire(boolean notify, boolean notifyCluster) 
- 
recyclepublic void recycle()Description copied from interface:SessionRelease all object references, and initialize instance variables, in preparation for reuse of this object.- Specified by:
- recyclein interface- Session
- Overrides:
- recyclein class- StandardSession
 
- 
toString- Overrides:
- toStringin class- StandardSession
 
- 
addSessionListenerDescription copied from interface:SessionAdd a session event listener to this component.- Specified by:
- addSessionListenerin interface- Session
- Overrides:
- addSessionListenerin class- StandardSession
- Parameters:
- listener- the SessionListener instance that should be notified for session events
 
- 
addSessionListener
- 
removeSessionListenerDescription copied from interface:SessionRemove a session event listener from this component.- Specified by:
- removeSessionListenerin interface- Session
- Overrides:
- removeSessionListenerin class- StandardSession
- Parameters:
- listener- remove the session listener, which will no longer be notified
 
- 
removeSessionListener
- 
readExternal- Specified by:
- readExternalin interface- Externalizable
- Throws:
- IOException
- ClassNotFoundException
 
- 
readObjectDataDescription copied from class:StandardSessionRead 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.- Overrides:
- readObjectDatain class- StandardSession
- Parameters:
- stream- The object input stream to read from
- Throws:
- ClassNotFoundException- if an unknown class is specified
- IOException- if an input/output error occurs
 
- 
readObjectData- Throws:
- ClassNotFoundException
- IOException
 
- 
writeObjectDataDescription copied from class:StandardSessionWrite 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.- Overrides:
- writeObjectDatain class- StandardSession
- Parameters:
- stream- The object output stream to write to
- Throws:
- IOException- if an input/output error occurs
 
- 
writeObjectData- Throws:
- IOException
 
- 
resetDeltaRequestpublic void resetDeltaRequest()
- 
getDeltaRequestDeprecated.Unused. This method will be removed in Tomcat 12.Get the request.- Returns:
- the request
 
- 
deserializeAndExecuteDeltaRequestprotected void deserializeAndExecuteDeltaRequest(byte[] delta) throws IOException, ClassNotFoundException - Throws:
- IOException
- ClassNotFoundException
 
- 
removeAttributeDescription copied from class:StandardSessionRemove 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 callsvalueUnbound()on the object.- Overrides:
- removeAttributein class- StandardSession
- Parameters:
- name- Name of the object to remove from this session.
- notify- Should we notify interested listeners that this attribute is being removed?
 
- 
removeAttribute
- 
setAttributeDescription copied from interface:javax.servlet.http.HttpSessionBinds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.After this method executes, and if the new object implements HttpSessionBindingListener, the container callsHttpSessionBindingListener.valueBound. The container then notifies anyHttpSessionAttributeListeners in the web application.If an object was already bound to this session of this name that implements HttpSessionBindingListener, itsHttpSessionBindingListener.valueUnboundmethod is called.If the value passed in is null, this has the same effect as calling removeAttribute().- Specified by:
- setAttributein interface- HttpSession
- Overrides:
- setAttributein class- StandardSession
- Parameters:
- name- the name to which the object is bound; cannot be null
- value- the object to be bound
 
- 
setAttribute
- 
removeNoteDescription copied from interface:SessionRemove any object bound to the specified name in the internal notes for this session.- Specified by:
- removeNotein interface- Session
- Overrides:
- removeNotein class- StandardSession
- Parameters:
- name- Name of the note to be removed
 
- 
removeNote
- 
setNoteDescription copied from interface:SessionBind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name.- Specified by:
- setNotein interface- Session
- Overrides:
- setNotein class- StandardSession
- Parameters:
- name- Name to which the object should be bound
- value- Object to be bound to the specified name
 
- 
setNote
- 
doReadObjectDescription copied from class:StandardSessionRead 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. - Overrides:
- doReadObjectin class- StandardSession
- Parameters:
- stream- The input stream to read from
- Throws:
- ClassNotFoundException- if an unknown class is specified
- IOException- if an input/output error occurs
 
- 
writeExternal- Specified by:
- writeExternalin interface- Externalizable
- Throws:
- IOException
 
- 
doWriteObjectDescription copied from class:StandardSessionWrite 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 distributableproperty of the associated Manager is set totrue.- Overrides:
- doWriteObjectin class- StandardSession
- Parameters:
- stream- The output stream to write to
- Throws:
- IOException- if an input/output error occurs
 
- 
removeAttributeInternal
- 
getLastTimeReplicatedpublic long getLastTimeReplicated()- Specified by:
- getLastTimeReplicatedin interface- ReplicatedMapEntry
- Returns:
- the last replicate time.
 
- 
getVersionpublic long getVersion()Description copied from interface:ReplicatedMapEntryFor accuracy checking, a serialized attribute can contain a version number This number increases as modifications are made to the data. The replicated map can use this to ensure accuracy on a periodic basis- Specified by:
- getVersionin interface- ReplicatedMapEntry
- Returns:
- long - the version number or -1 if the data is not versioned
 
- 
setLastTimeReplicatedpublic void setLastTimeReplicated(long lastTimeReplicated) Description copied from interface:ReplicatedMapEntrySet the last replicate time.- Specified by:
- setLastTimeReplicatedin interface- ReplicatedMapEntry
- Parameters:
- lastTimeReplicated- New timestamp
 
- 
setVersionpublic void setVersion(long version) Description copied from interface:ReplicatedMapEntryForces a certain version to a replicated map entry- Specified by:
- setVersionin interface- ReplicatedMapEntry
- Parameters:
- version- long
 
- 
setAccessCountprotected void setAccessCount(int count) 
 
-