org.apache.catalina.cluster
Interface ClusterManager

All Superinterfaces:
Manager
All Known Implementing Classes:
DeltaManager, SimpleTcpReplicationManager

public interface ClusterManager
extends Manager


Method Summary
 java.lang.String[] getInvalidatedSessions()
          When the manager expires session not tied to a request.
 java.lang.String getName()
          Return the name of the manager, typically the context name such as /replicator
 boolean getNotifyListenersOnReplication()
           
 void messageDataReceived(ClusterMessage msg)
          A message was received from another node, this is the callback method to implement if you are interested in receiving replication messages.
 ClusterMessage requestCompleted(java.lang.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.
 void setCluster(CatalinaCluster cluster)
           
 void setExpireSessionsOnShutdown(boolean expireSessionsOnShutdown)
           
 void setName(java.lang.String name)
           
 void setNotifyListenersOnReplication(boolean notifyListenersOnReplication)
           
 void setUseDirtyFlag(boolean useDirtyFlag)
           
 
Methods inherited from interface org.apache.catalina.Manager
add, addPropertyChangeListener, backgroundProcess, createEmptySession, createSession, findSession, findSessions, getActiveSessions, getContainer, getDistributable, getExpiredSessions, getInfo, getMaxActive, getMaxInactiveInterval, getRejectedSessions, getSessionAverageAliveTime, getSessionCounter, getSessionIdLength, getSessionMaxAliveTime, load, remove, removePropertyChangeListener, setContainer, setDistributable, setExpiredSessions, setMaxActive, setMaxInactiveInterval, setRejectedSessions, setSessionAverageAliveTime, setSessionCounter, setSessionIdLength, setSessionMaxAliveTime, unload
 

Method Detail

messageDataReceived

public void messageDataReceived(ClusterMessage msg)
A message was received from another node, this is the callback method to implement if you are interested in receiving replication messages.

Parameters:
msg - - the message received.

requestCompleted

public ClusterMessage requestCompleted(java.lang.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. 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.

Parameters:
sessionId - - the sessionId that just completed.
Returns:
a SessionMessage to be sent,

getInvalidatedSessions

public java.lang.String[] getInvalidatedSessions()
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.

Returns:
String[] The invalidated sessions

getName

public java.lang.String getName()
Return the name of the manager, typically the context name such as /replicator

Returns:
String

setName

public void setName(java.lang.String name)

setExpireSessionsOnShutdown

public void setExpireSessionsOnShutdown(boolean expireSessionsOnShutdown)

setUseDirtyFlag

public void setUseDirtyFlag(boolean useDirtyFlag)

setCluster

public void setCluster(CatalinaCluster cluster)

getNotifyListenersOnReplication

public boolean getNotifyListenersOnReplication()

setNotifyListenersOnReplication

public void setNotifyListenersOnReplication(boolean notifyListenersOnReplication)


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.