Package org.apache.catalina.ha.session

Class BackupManager

    • Field Detail

      • sm

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

      • DEFAULT_REPL_TIMEOUT

        protected static final long DEFAULT_REPL_TIMEOUT
        Default replication timeout in milliseconds.
        See Also:
        Constant Field Values

      • name

        protected java.lang.String name
        The name of this manager

    • Constructor Detail

      • BackupManager

        public BackupManager()
        Constructor, just calls super()

    • Method Detail

      • messageDataReceived

        public void messageDataReceived​(ClusterMessage msg)
        Description copied from interface: ClusterManager
        A message was received from another node, this is the callback method to implement if you are interested in receiving replication messages.
        Specified by:
        messageDataReceived in interface ClusterManager
        Parameters:
        msg - - the message received.

      • requestCompleted

        public ClusterMessage requestCompleted​(java.lang.String sessionId)
        Description copied from interface: ClusterManager
        When the request has been completed, the replication valve will notify the manager, and the manager will decide whether any replication is needed or not. If there is a need for replication, the manager will create a session message and that will be replicated. The cluster determines where it gets sent.
        Specified by:
        requestCompleted in interface ClusterManager
        Parameters:
        sessionId - - the sessionId that just completed.
        Returns:
        a SessionMessage to be sent.

      • createEmptySession

        public Session createEmptySession()
        Description copied from interface: Manager
        Get a session from the recycled ones or create a new empty one. The PersistentManager manager does not need to create session data because it reads it from the Store.
        Specified by:
        createEmptySession in interface Manager
        Overrides:
        createEmptySession in class ManagerBase
        Returns:
        An empty Session object

      • getName

        public java.lang.String getName()
        Description copied from class: ManagerBase
        Returns the descriptive short name of this Manager implementation.
        Specified by:
        getName in interface ClusterManager
        Overrides:
        getName in class ManagerBase
        Returns:
        The descriptive short name of this Manager implementation.

      • startInternal

        protected void startInternal()
                      throws LifecycleException
        Start this component and implement the requirements of LifecycleBase.startInternal(). Starts the cluster communication channel, this will connect with the other nodes in the cluster, and request the current session state to be transferred to this node.
        Overrides:
        startInternal in class ClusterManagerBase
        Throws:
        LifecycleException - if this component detects a fatal error that prevents this component from being used

      • getMapName

        public java.lang.String getMapName()
        Returns the name of the replication map.
        Returns:
        the map name

      • setName

        public void setName​(java.lang.String name)
        Description copied from interface: ClusterManager
        Set the name of the manager, at host /context name and at engine hostname+/context
        Specified by:
        setName in interface ClusterManager
        Parameters:
        name - The manager name

      • setMapSendOptions

        public void setMapSendOptions​(int mapSendOptions)
        Sets the channel send options for the replication map.
        Parameters:
        mapSendOptions - the send options as an integer flag

      • setMapSendOptions

        public void setMapSendOptions​(java.lang.String mapSendOptions)
        Sets the channel send options for the replication map from a string.
        Parameters:
        mapSendOptions - the send options as a comma-separated string

      • getMapSendOptions

        public int getMapSendOptions()
        Returns the channel send options for the replication map.
        Returns:
        the send options as an integer flag

      • getMapSendOptionsName

        public java.lang.String getMapSendOptionsName()
        returns the SendOptions as a comma separated list of names
        Returns:
        a comma separated list of the option names

      • setRpcTimeout

        public void setRpcTimeout​(long rpcTimeout)
        Sets the RPC timeout for replication messages.
        Parameters:
        rpcTimeout - the timeout in milliseconds

      • getRpcTimeout

        public long getRpcTimeout()
        Returns the RPC timeout for replication messages.
        Returns:
        the timeout in milliseconds

      • setTerminateOnStartFailure

        public void setTerminateOnStartFailure​(boolean terminateOnStartFailure)
        Sets whether to terminate the map on start failure.
        Parameters:
        terminateOnStartFailure - true to terminate on start failure

      • isTerminateOnStartFailure

        public boolean isTerminateOnStartFailure()
        Returns whether the map will terminate on start failure.
        Returns:
        true if the map will terminate on start failure

      • getAccessTimeout

        public long getAccessTimeout()
        Returns the access timeout for the replication map.
        Returns:
        the access timeout in milliseconds

      • setAccessTimeout

        public void setAccessTimeout​(long accessTimeout)
        Sets the access timeout for the replication map.
        Parameters:
        accessTimeout - the access timeout in milliseconds

      • getInvalidatedSessions

        public java.lang.String[] getInvalidatedSessions()
        Description copied from interface: ClusterManager
        When the manager expires session not tied to a request. The cluster will periodically ask for a list of sessions that should expire and that should be sent across the wire.
        Specified by:
        getInvalidatedSessions in interface ClusterManager
        Returns:
        String[] The invalidated sessions

      • getActiveSessionsFull

        public int getActiveSessionsFull()
        Description copied from interface: DistributedManager
        Returns the total session count for primary, backup and proxy.
        Specified by:
        getActiveSessionsFull in interface DistributedManager
        Returns:
        The total session count across the cluster.

      • getSessionIdsFull

        public java.util.Set<java.lang.String> getSessionIdsFull()
        Description copied from interface: DistributedManager
        Returns the list of all sessions IDS (primary, backup and proxy).
        Specified by:
        getSessionIdsFull in interface DistributedManager
        Returns:
        The complete set of sessions IDs across the cluster.