org.jboss.ha.framework.interfaces
Interface FamilyClusterInfo

All Known Implementing Classes:

FamilyClusterInfoImpl

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.

Version:

$Revision: 57188 $

Revisions:

2002/08/23, Sacha Labourey:

• First implementation

Author:

Sacha Labourey.

See Also:

FamilyClusterInfoImpl, ClusteringTargetsRepository

Field Summary

static int

UNINITIALIZED_CURSOR

Method Summary

boolean	currentMembershipInSyncWithViewId()
long	getCurrentViewId()
int	getCursor()
String	getFamilyName()
Object	getObject()
ArrayList	getTargets() Gets the list of targets for this family.
ArrayList	removeDeadTarget(Object target) Remove the given target from the list of targets.
void	resetView() Force a reload of the view at the next invocation.
int	setCursor(int cursor)
Object	setObject(Object whatever)
ArrayList	updateClusterInfo(ArrayList targets, long viewId) Updates the targets and the view id.

Field Detail

UNINITIALIZED_CURSOR

static final int UNINITIALIZED_CURSOR

See Also:

Constant Field Values

Method Detail

getFamilyName

String getFamilyName()

getTargets

ArrayList getTargets()

Gets the list of targets for this family. NOTE: Implementations should synchronize on themselves when executing this method (see JBAS-2071).

getCurrentViewId

long getCurrentViewId()

removeDeadTarget

ArrayList removeDeadTarget(Object target)

Remove the given target from the list of targets. NOTE: Implementations should synchronize on themselves when executing this method (see JBAS-2071).

Parameters:

target - the target

Returns:

the updated list of targets

updateClusterInfo

ArrayList updateClusterInfo(ArrayList targets,
                            long viewId)

Updates the targets and the view id. NOTE: Implementations should synchronize on themselves when executing this method (see JBAS-2071).

currentMembershipInSyncWithViewId

boolean currentMembershipInSyncWithViewId()

resetView

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).

getCursor

int getCursor()

setCursor

int setCursor(int cursor)

getObject

Object getObject()

setObject

Object setObject(Object whatever)