Class DeltaSession

    • Field Detail

      • log

        public static final Log log
      • sm

        protected static final StringManager sm
        The string manager for this package.
      • diffLock

        protected final Lock diffLock
    • Constructor Detail

      • DeltaSession

        public DeltaSession()
      • DeltaSession

        public DeltaSession​(Manager manager)
        Construct a new Session associated with the specified Manager.
        Parameters:
        manager - The manager with which this Session is associated
    • Method Detail

      • createRequest

        protected DeltaRequest createRequest​(String sessionId,
                                             boolean recordAllActions)
      • isDirty

        public boolean isDirty()
        Has the object changed since last replication and is not in a locked state
        Specified by:
        isDirty in interface ReplicatedMapEntry
        Returns:
        boolean
      • isDiffable

        public boolean isDiffable()
        If this returns true, the map will extract the diff using getDiff() Otherwise it will serialize the entire object.
        Specified by:
        isDiffable in interface ReplicatedMapEntry
        Returns:
        boolean
      • getDiff

        public byte[] getDiff()
                       throws IOException
        Returns a diff and sets the dirty map to false
        Specified by:
        getDiff in interface ReplicatedMapEntry
        Returns:
        a serialized view of the difference
        Throws:
        IOException - IO error serializing
      • getClassLoaders

        public ClassLoader[] getClassLoaders()
      • resetDiff

        public void resetDiff()
        Resets the current diff state and resets the dirty flag

        This implementation is a NO-OP. The diff is reset in getDiff().

        Specified by:
        resetDiff in interface ReplicatedMapEntry
      • lock

        public void lock()
        Lock during serialization

        This implementation is a NO-OP. Any required locking takes place in the methods that make modifications.

        Specified by:
        lock in interface ReplicatedMapEntry
      • unlock

        public void unlock()
        Unlock after serialization

        This implementation is a NO-OP. Any required unlocking takes place in the methods that make modifications.

        Specified by:
        unlock in interface ReplicatedMapEntry
      • setOwner

        public void setOwner​(Object owner)
        Description copied from interface: ReplicatedMapEntry
        This 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:
        setOwner in interface ReplicatedMapEntry
        Parameters:
        owner - Object
      • isAccessReplicate

        public boolean isAccessReplicate()
        If this returns true, to replicate that an object has been accessed
        Specified by:
        isAccessReplicate in interface ReplicatedMapEntry
        Returns:
        boolean
      • isPrimarySession

        public boolean isPrimarySession()
        returns true if this session is the primary session, if that is the case, the manager can expire it upon timeout.
        Specified by:
        isPrimarySession in interface ClusterSession
        Returns:
        True if this session is primary
      • setPrimarySession

        public void setPrimarySession​(boolean primarySession)
        Sets whether this is the primary session or not.
        Specified by:
        setPrimarySession in interface ClusterSession
        Parameters:
        primarySession - Flag value
      • setId

        public void setId​(String id,
                          boolean notify)
        Set the session identifier for this session and optionally notifies any associated listeners that a new session has been created.
        Specified by:
        setId in interface Session
        Overrides:
        setId in class StandardSession
        Parameters:
        id - The new session identifier
        notify - Should any associated listeners be notified that a new session has been created?
      • setId

        public void setId​(String id)
        Set the session identifier for this session.
        Specified by:
        setId in interface Session
        Overrides:
        setId in class StandardSession
        Parameters:
        id - The new session identifier
      • setMaxInactiveInterval

        public void setMaxInactiveInterval​(int interval,
                                           boolean addDeltaRequest)
      • setNew

        public void setNew​(boolean isNew)
        Set the isNew flag for this session.
        Specified by:
        setNew in interface Session
        Overrides:
        setNew in class StandardSession
        Parameters:
        isNew - The new value for the isNew flag
      • setNew

        public void setNew​(boolean isNew,
                           boolean addDeltaRequest)
      • setPrincipal

        public void setPrincipal​(Principal principal)
        Set the authenticated Principal that is associated with this Session. This provides an Authenticator with a means to cache a previously authenticated Principal, and avoid potentially expensive Realm.authenticate() calls on every request.
        Specified by:
        setPrincipal in interface Session
        Overrides:
        setPrincipal in class StandardSession
        Parameters:
        principal - The new Principal, or null if none
      • setPrincipal

        public void setPrincipal​(Principal principal,
                                 boolean addDeltaRequest)
      • setAuthType

        public void setAuthType​(String authType)
        Set the authentication type used to authenticate our cached Principal, if any.
        Specified by:
        setAuthType in interface Session
        Overrides:
        setAuthType in class StandardSession
        Parameters:
        authType - The new cached authentication type
      • setAuthType

        public void setAuthType​(String authType,
                                boolean addDeltaRequest)
      • isValid

        public boolean isValid()
        Return the isValid flag for this session.
        Specified by:
        isValid in interface Session
        Overrides:
        isValid in class StandardSession
        Returns:
        true if the session is still valid
      • endAccess

        public void endAccess()
        End the access and register to ReplicationValve (crossContext support)
        Specified by:
        endAccess in interface Session
        Overrides:
        endAccess in class StandardSession
      • expire

        public void expire​(boolean notify)
        Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.
        Overrides:
        expire in class StandardSession
        Parameters:
        notify - Should we notify listeners about the demise of this session?
      • expire

        public void expire​(boolean notify,
                           boolean notifyCluster)
      • recycle

        public void recycle()
        Release all object references, and initialize instance variables, in preparation for reuse of this object.
        Specified by:
        recycle in interface Session
        Overrides:
        recycle in class StandardSession
      • addSessionListener

        public void addSessionListener​(SessionListener listener,
                                       boolean addDeltaRequest)
      • removeSessionListener

        public void removeSessionListener​(SessionListener listener,
                                          boolean addDeltaRequest)
      • writeObjectData

        public void writeObjectData​(ObjectOutputStream stream)
                             throws IOException
        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.
        Overrides:
        writeObjectData in class StandardSession
        Parameters:
        stream - The object output stream to write to
        Throws:
        IOException - if an input/output error occurs
      • resetDeltaRequest

        public void resetDeltaRequest()
      • removeAttribute

        public void removeAttribute​(String name,
                                    boolean notify)
        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.

        Overrides:
        removeAttribute in 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?
        Throws:
        IllegalStateException - if this method is called on an invalidated session
      • removeAttribute

        public void removeAttribute​(String name,
                                    boolean notify,
                                    boolean addDeltaRequest)
      • setAttribute

        public void setAttribute​(String name,
                                 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.

        Specified by:
        setAttribute in interface HttpSession
        Overrides:
        setAttribute in class StandardSession
        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
      • setAttribute

        public void setAttribute​(String name,
                                 Object value,
                                 boolean notify,
                                 boolean addDeltaRequest)
      • doWriteObject

        protected void doWriteObject​(ObjectOutputStream stream)
                              throws IOException
        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.

        Overrides:
        doWriteObject in class StandardSession
        Parameters:
        stream - The output stream to write to
        Throws:
        IOException - if an input/output error occurs
      • removeAttributeInternal

        protected void removeAttributeInternal​(String name,
                                               boolean notify,
                                               boolean addDeltaRequest)
      • getVersion

        public long getVersion()
        Description copied from interface: ReplicatedMapEntry
        For 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:
        getVersion in interface ReplicatedMapEntry
        Returns:
        long - the version number or -1 if the data is not versioned
      • setLastTimeReplicated

        public void setLastTimeReplicated​(long lastTimeReplicated)
        Description copied from interface: ReplicatedMapEntry
        Set the last replicate time.
        Specified by:
        setLastTimeReplicated in interface ReplicatedMapEntry
        Parameters:
        lastTimeReplicated - New timestamp
      • setVersion

        public void setVersion​(long version)
        Description copied from interface: ReplicatedMapEntry
        Forces a certain version to a replicated map entry
        Specified by:
        setVersion in interface ReplicatedMapEntry
        Parameters:
        version - long
      • setAccessCount

        protected void setAccessCount​(int count)