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 java::util::Observable.


Public Member Functions

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

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

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.

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.