com.pcbsys.nirvana.nAdminAPI.nClusterStatus Class Reference

This class contains the status of the of a realm within the cluster, What state it has, which node is the elected master etc. More...

Inherits Observable.

Public Member Functions
boolean	canBeMaster ()
	Indicates whether the cluster member can be selected as master within the cluster. More...
String	getElectedMaster ()
	The name of the nodes elected master. More...
String	getName ()
	The nameof the realm which these status's are related to. More...
nClusterSite	getSite ()
	Returns the nClusterSite for the cluster. More...
String	getState ()
	Returns the realms cluster state. More...
nClusterStatusEntry	getStatus (String realm)
	Returns nClusterStatusEntry for the specified realm. More...
nClusterStatusEntry	getStatus (int idx)
	Returns nClusterStatusEntry for the realm at the index specified. More...
int	getStatusCounter ()
	Returns the number of times that a realm node is referenced. More...
boolean	hasSite ()
	Returns true if the cluster has a site. More...
int	size ()
	The number of known nodes within the cluster. More...

Detailed Description

This class contains the status of the of a realm within the cluster, What state it has, which node is the elected master etc.

Member Function Documentation

boolean com.pcbsys.nirvana.nAdminAPI.nClusterStatus.canBeMaster

(

)

Indicates whether the cluster member can be selected as master within the cluster.

Returns

whether the member can be elected master

String com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getElectedMaster

(

)

The name of the nodes elected master.

Returns

the elected master.

String com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getName

(

)

The nameof the realm which these status's are related to.

Returns

the name of the realm.

nClusterSite com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getSite

(

)

Returns the nClusterSite for the cluster.

Returns

the nClusterSite for the cluster

See Also

nClusterSite

String com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getState

(

)

Returns the realms cluster state.

Returns

String representing the current state of this node within the cluster.

nClusterStatusEntry com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getStatus

(

String

realm

)

Returns nClusterStatusEntry for the specified realm.

Parameters

realm

name to get status for.

Returns

status for specified realm.

nClusterStatusEntry com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getStatus

(

int

idx

)

Returns nClusterStatusEntry for the realm at the index specified.

Parameters

idx	to get the status for.

Returns

status object at the requested index.

int com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getStatusCounter

(

)

Returns the number of times that a realm node is referenced.

Only when this number is 1 the realm node and the correspondent status can be removed from the cluster node.

Returns

the number of times that a realm node is referenced.

boolean com.pcbsys.nirvana.nAdminAPI.nClusterStatus.hasSite

(

)

Returns true if the cluster has a site.

Returns

true if the cluster has a site.

int com.pcbsys.nirvana.nAdminAPI.nClusterStatus.size

(

)

The number of known nodes within the cluster.

Returns

number of nodes within the cluster.