FileDocCategorySizeDatePackage
ClusterManager.javaAPI DocApache Tomcat 6.0.143656Fri Jul 20 04:20:36 BST 2007org.apache.catalina.ha

ClusterManager

public interface ClusterManager implements org.apache.catalina.Manager
The common interface used by all cluster manager. This is so that we can have a more pluggable way of swapping session managers for different algorithms.
author
Filip Hanik
author
Peter Rossbach

Fields Summary
Constructors Summary
Methods Summary
public org.apache.catalina.ha.ClusterManagercloneFromTemplate()

public booleandoDomainReplication()

return
Manager send only to same cluster domain.
since
5.5.10

public CatalinaClustergetCluster()

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.

return
String[] The invalidated sessions

public java.lang.StringgetName()
Return the name of the manager, at host /context name and at engine hostname+/context.

return
String
since
5.5.10

public org.apache.catalina.tribes.io.ReplicationStreamgetReplicationStream(byte[] data)

public org.apache.catalina.tribes.io.ReplicationStreamgetReplicationStream(byte[] data, int offset, int length)

public booleanisDefaultMode()

since
5.5.10

public booleanisNotifyListenersOnReplication()

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

param
msg - the message received.

public ClusterMessagerequestCompleted(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.

param
sessionId - the sessionId that just completed.
return
a SessionMessage to be sent.

public voidsetCluster(CatalinaCluster cluster)

public voidsetDefaultMode(boolean mode)

param
mode The mode
since
5.5.10

public voidsetDomainReplication(boolean domainReplication)

param
sendClusterDomainOnly Flag value.
since
5.5.10

public voidsetName(java.lang.String name)
Set the name of the manager, at host /context name and at engine hostname+/context

param
name
since
5.5.10