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

FamilyClusterInfo

public interface FamilyClusterInfo

Maintain information for a given proxy family. Proxies can statically reference objects implementing this interface: only the content will change as the cluster topology changes, not the FamilyClusterInfo object itself. Proxies or LoadBalancing policy implementations can use the cursor and object attribute to store arbitrary data that is then shared accross all proxies belonging to the same family. Initial access to this object is done through the ClusteringTargetsRepository singleton.

see

org.jboss.ha.framework.interfaces.FamilyClusterInfoImpl

see

org.jboss.ha.framework.interfaces.ClusteringTargetsRepository

author

Sacha Labourey.

version

$Revision: 57188 $

Revisions:

2002/08/23, Sacha Labourey:

First implementation

Fields Summary
public static final int
UNINITIALIZED_CURSOR
Constructors Summary
Methods Summary
public boolean currentMembershipInSyncWithViewId()
public long getCurrentViewId()
public int getCursor()
public java.lang.String getFamilyName()
public java.lang.Object getObject()
public java.util.ArrayList getTargets()
Gets the list of targets for this family. NOTE: Implementations should synchronize on themselves when executing this method (see JBAS-2071).
public java.util.ArrayList removeDeadTarget(java.lang.Object target)
Remove the given target from the list of targets. NOTE: Implementations should synchronize on themselves when executing this method (see JBAS-2071).
param
target the target
return
the updated list of targets
public void resetView()
Force a reload of the view at the next invocation. NOTE: Implementations should synchronize on themselves when executing this method (see JBAS-2071).
public int setCursor(int cursor)
public java.lang.Object setObject(java.lang.Object whatever)
public java.util.ArrayList updateClusterInfo(java.util.ArrayList targets, long viewId)
Updates the targets and the view id. NOTE: Implementations should synchronize on themselves when executing this method (see JBAS-2071).