Package org.apache.catalina.ha.session
Class BackupManager
java.lang.Object
org.apache.catalina.util.LifecycleBase
org.apache.catalina.util.LifecycleMBeanBase
org.apache.catalina.session.ManagerBase
org.apache.catalina.ha.session.ClusterManagerBase
org.apache.catalina.ha.session.BackupManager
- All Implemented Interfaces:
- MBeanRegistration,- DistributedManager,- ClusterManager,- JmxEnabled,- Lifecycle,- Manager,- AbstractReplicatedMap.MapOwner
public class BackupManager
extends ClusterManagerBase
implements AbstractReplicatedMap.MapOwner, DistributedManager
- 
Nested Class SummaryNested classes/interfaces inherited from class org.apache.catalina.session.ManagerBaseManagerBase.SessionTimingNested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected static final longprotected StringThe name of this managerprotected static final StringManagerThe string manager for this package.Fields inherited from class org.apache.catalina.ha.session.ClusterManagerBaseclusterFields inherited from class org.apache.catalina.session.ManagerBaseduplicates, expiredSessions, maxActive, maxActiveSessions, processExpiresFrequency, processingTime, rejectedSessions, secureRandomAlgorithm, secureRandomClass, secureRandomProvider, sessionCounter, sessionCreationTiming, sessionExpirationTiming, sessionIdGenerator, sessionIdGeneratorClass, sessionMaxAliveTime, sessions, support, TIMING_STATS_CACHE_SIZEFields inherited from interface org.apache.catalina.LifecycleAFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionGet a session from the recycled ones or create a new empty one.longintReturns the total session count for primary, backup and proxy.String[]When the manager expires session not tied to a request.intreturns the SendOptions as a comma separated list of namesgetName()Return the name of the manager, at host /context name and at engine hostname+/context.longReturns the list of all sessions IDS (primary, backup and proxy).booleanvoidA message was received from another node, this is the callback method to implement if you are interested in receiving replication messages.voidobjectMadePrimary(Object key, Object value) requestCompleted(String sessionId) 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.voidsetAccessTimeout(long accessTimeout) voidsetMapSendOptions(int mapSendOptions) voidsetMapSendOptions(String mapSendOptions) voidSet the name of the manager, at host /context name and at engine hostname+/contextvoidsetRpcTimeout(long rpcTimeout) voidsetTerminateOnStartFailure(boolean terminateOnStartFailure) protected voidStart this component and implement the requirements ofLifecycleBase.startInternal().protected voidStop this component and implement the requirements ofLifecycleBase.stopInternal().Methods inherited from class org.apache.catalina.ha.session.ClusterManagerBaseclone, getClassLoaders, getClassLoaders, getCluster, getDeltaRequestPool, getReplicationStream, getReplicationStream, isNotifyListenersOnReplication, isRecordAllActions, load, registerSessionAtReplicationValve, setCluster, setNotifyListenersOnReplication, setRecordAllActions, unloadMethods inherited from class org.apache.catalina.session.ManagerBaseadd, addPropertyChangeListener, backgroundProcess, changeSessionId, changeSessionId, createSession, expireSession, findSession, findSessions, generateSessionId, getActiveSessions, getClassName, getContext, getCreationTime, getCreationTimestamp, getDomainInternal, getDuplicates, getEngine, getExpiredSessions, getJvmRoute, getLastAccessedTime, getLastAccessedTimestamp, getMaxActive, getMaxActiveSessions, getNewSession, getNotifyAttributeListenerOnUnchangedValue, getNotifyBindingListenerOnUnchangedValue, getObjectNameKeyProperties, getPersistAuthentication, getProcessExpiresFrequency, getProcessingTime, getRejectedSessions, getSecureRandomAlgorithm, getSecureRandomClass, getSecureRandomProvider, getSession, getSessionActivityCheck, getSessionAttribute, getSessionAttributeNameFilter, getSessionAttributeNamePattern, getSessionAttributeValueClassNameFilter, getSessionAttributeValueClassNamePattern, getSessionAverageAliveTime, getSessionCounter, getSessionCreateRate, getSessionExpireRate, getSessionIdGenerator, getSessionLastAccessAtStart, getSessionMaxAliveTime, getThisAccessedTime, getThisAccessedTimestamp, getWarnOnSessionAttributeFilterFailure, initInternal, listSessionIds, processExpires, remove, remove, removePropertyChangeListener, rotateSessionId, setContext, setDuplicates, setExpiredSessions, setMaxActive, setMaxActiveSessions, setNotifyAttributeListenerOnUnchangedValue, setNotifyBindingListenerOnUnchangedValue, setPersistAuthentication, setProcessExpiresFrequency, setProcessingTime, setSecureRandomAlgorithm, setSecureRandomClass, setSecureRandomProvider, setSessionActivityCheck, setSessionAttributeNameFilter, setSessionAttributeValueClassNameFilter, setSessionCounter, setSessionIdGenerator, setSessionLastAccessAtStart, setSessionMaxAliveTime, setWarnOnSessionAttributeFilterFailure, toString, updateSessionMaxAliveTime, willAttributeDistributeMethods inherited from class org.apache.catalina.util.LifecycleMBeanBasedestroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregisterMethods inherited from class org.apache.catalina.util.LifecycleBaseaddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stopMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.catalina.Manageradd, addPropertyChangeListener, backgroundProcess, changeSessionId, createSession, findSession, findSessions, getActiveSessions, getContext, getExpiredSessions, getMaxActive, getNotifyAttributeListenerOnUnchangedValue, getNotifyBindingListenerOnUnchangedValue, getRejectedSessions, getSessionActivityCheck, getSessionAverageAliveTime, getSessionCounter, getSessionCreateRate, getSessionExpireRate, getSessionIdGenerator, getSessionLastAccessAtStart, getSessionMaxAliveTime, remove, remove, removePropertyChangeListener, rotateSessionId, setContext, setExpiredSessions, setMaxActive, setNotifyAttributeListenerOnUnchangedValue, setNotifyBindingListenerOnUnchangedValue, setSessionActivityCheck, setSessionCounter, setSessionIdGenerator, setSessionLastAccessAtStart, setSessionMaxAliveTime, willAttributeDistribute
- 
Field Details- 
smThe string manager for this package.
- 
DEFAULT_REPL_TIMEOUTprotected static final long DEFAULT_REPL_TIMEOUT- See Also:
 
- 
nameThe name of this manager
 
- 
- 
Constructor Details- 
BackupManagerpublic BackupManager()Constructor, just calls super()
 
- 
- 
Method Details- 
messageDataReceivedDescription copied from interface:ClusterManagerA message was received from another node, this is the callback method to implement if you are interested in receiving replication messages.- Specified by:
- messageDataReceivedin interface- ClusterManager
- Parameters:
- msg- - the message received.
 
- 
requestCompletedDescription copied from interface:ClusterManagerWhen 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:
- requestCompletedin interface- ClusterManager
- Parameters:
- sessionId- - the sessionId that just completed.
- Returns:
- a SessionMessage to be sent.
 
- 
objectMadePrimary- Specified by:
- objectMadePrimaryin interface- AbstractReplicatedMap.MapOwner
 
- 
createEmptySessionDescription copied from interface:ManagerGet 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:
- createEmptySessionin interface- Manager
- Overrides:
- createEmptySessionin class- ManagerBase
- Returns:
- An empty Session object
 
- 
getNameDescription copied from interface:ClusterManagerReturn the name of the manager, at host /context name and at engine hostname+/context.- Specified by:
- getNamein interface- ClusterManager
- Overrides:
- getNamein class- ManagerBase
- Returns:
- The descriptive short name of this Manager implementation.
 
- 
startInternalStart this component and implement the requirements ofLifecycleBase.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:
- startInternalin class- ClusterManagerBase
- Throws:
- LifecycleException- if this component detects a fatal error that prevents this component from being used
 
- 
getMapName
- 
stopInternalStop this component and implement the requirements ofLifecycleBase.stopInternal(). This will disconnect the cluster communication channel and stop the listener thread.- Overrides:
- stopInternalin class- ClusterManagerBase
- Throws:
- LifecycleException- if this component detects a fatal error that prevents this component from being used
 
- 
setNameDescription copied from interface:ClusterManagerSet the name of the manager, at host /context name and at engine hostname+/context- Specified by:
- setNamein interface- ClusterManager
- Parameters:
- name- The manager name
 
- 
setMapSendOptionspublic void setMapSendOptions(int mapSendOptions) 
- 
setMapSendOptions
- 
getMapSendOptionspublic int getMapSendOptions()
- 
getMapSendOptionsNamereturns the SendOptions as a comma separated list of names- Returns:
- a comma separated list of the option names
 
- 
setRpcTimeoutpublic void setRpcTimeout(long rpcTimeout) 
- 
getRpcTimeoutpublic long getRpcTimeout()
- 
setTerminateOnStartFailurepublic void setTerminateOnStartFailure(boolean terminateOnStartFailure) 
- 
isTerminateOnStartFailurepublic boolean isTerminateOnStartFailure()
- 
getAccessTimeoutpublic long getAccessTimeout()
- 
setAccessTimeoutpublic void setAccessTimeout(long accessTimeout) 
- 
getInvalidatedSessionsDescription copied from interface:ClusterManagerWhen 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:
- getInvalidatedSessionsin interface- ClusterManager
- Returns:
- String[] The invalidated sessions
 
- 
cloneFromTemplate- Specified by:
- cloneFromTemplatein interface- ClusterManager
 
- 
getActiveSessionsFullpublic int getActiveSessionsFull()Description copied from interface:DistributedManagerReturns the total session count for primary, backup and proxy.- Specified by:
- getActiveSessionsFullin interface- DistributedManager
- Returns:
- The total session count across the cluster.
 
- 
getSessionIdsFullDescription copied from interface:DistributedManagerReturns the list of all sessions IDS (primary, backup and proxy).- Specified by:
- getSessionIdsFullin interface- DistributedManager
- Returns:
- The complete set of sessions IDs across the cluster.
 
 
-