File	Doc	Category	Size	Date	Package
DistributedReplicantManager.java	API Doc	JBoss 4.2.1	5486	Fri Jul 13 20:52:38 BST 2007	org.jboss.ha.framework.interfaces

DistributedReplicantManager

Fields Summary

Constructors Summary

Methods Summary
public void	add(java.lang.String key, java.io.Serializable replicant) Add a replicant, it will be attached to this cluster node param key Replicant name. All replicas around the cluster must use the same key name. param replicant Local data of the replicant, that is, any serializable data throws Exception Thrown if a cluster communication problem occurs
public java.util.Collection	getAllServices() Return a list of all services that have a least one replicant. return A collection of services names (String)
public int	getReplicantsViewId(java.lang.String key) Returns an id corresponding to the current view of this set of replicants. param key The replicant name return A view id (doesn't grow sequentially)
public boolean	isMasterReplica(java.lang.String key) Indicates if the current node is the master replica for this given key. param key The replicant name return True if this node is the master
public java.io.Serializable	lookupLocalReplicant(java.lang.String key) Lookup the replicant attached to this cluster node param key The name of the replicant return The local replicant for the give key name
public java.util.List	lookupReplicants(java.lang.String key) Return a list of all replicants. param key The replicant name return An list of serialized replicants available around the cluster for the given key. This list will be in the same order in all nodes in the cluster.
public java.util.List	lookupReplicantsNodeNames(java.lang.String key) Return a list of all replicants node names. param key The replicant name return A list the node names of cluster nodes that have made available a replicant for the given key. This list will be in the same order in all nodes in the cluster.
public void	registerListener(java.lang.String key, org.jboss.ha.framework.interfaces.DistributedReplicantManager$ReplicantListener subscriber) Subscribe a new listener {@link ReplicantListener} for replicants change param key Name of the replicant, must be identical cluster-wide for all identical replicants param subscriber The subsribing {@link ReplicantListener}
public void	remove(java.lang.String key) Remove the entire key from the ReplicationService param key Name of the replicant throws Exception Thrown if a cluster communication problem occurs
public void	unregisterListener(java.lang.String key, org.jboss.ha.framework.interfaces.DistributedReplicantManager$ReplicantListener subscriber) Unsubscribe a listener {@link ReplicantListener} that had subscribed for replicants changes param key Name of the replicant, must be identical cluster-wide for all identical replicants param subscriber The unsubscribing {@link ReplicantListener}