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

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nClusterStatus:
com.pcbsys.nirvana.client.Observable

Public Member Functions

virtual bool canBeMaster ()
 Indicates whether the cluster member can be selected as master within the cluster. More...
 
virtual string getElectedMaster ()
 The name of the nodes elected master. More...
 
virtual nClusterSite getSite ()
 Returns the site for this realm More...
 
virtual string getState ()
 Returns the realms cluster state. More...
 
virtual nClusterStatusEntry getStatus (string realm)
 Returns nClusterStatusEntry for the specified realm. More...
 
virtual nClusterStatusEntry getStatus (int idx)
 Returns nClusterStatusEntry for the realm at the index specified More...
 
virtual bool hasSite ()
 Indicates whether this realm has a site More...
 
virtual int size ()
 The number of known nodes within the cluster. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.Observable
void addObserver (IObserver o)
 Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. More...
 
int countObservers ()
 Returns the number of observers of this Observable object. More...
 
void deleteObserver (IObserver o)
 Deletes an observer from the set of observers of this object. More...
 
void deleteObservers ()
 Clears the observer list so that this object no longer has any observers. More...
 
bool hasChanged ()
 Tests if this object has changed. More...
 
void notifyObservers ()
 If this object has changed, as indicated by the hasChanged method, then notify all of its observers and then call the clearChanged method to indicate that this object has no longer changed. More...
 
void notifyObservers (Object arg)
 If this object has changed, as indicated by the More...
 
 Observable ()
 Construct an Observable with zero Observers. More...
 

Properties

virtual string Name [get]
 The nameof the realm which these status's are related to. More...
 

Additional Inherited Members

- Protected Member Functions inherited from com.pcbsys.nirvana.client.Observable
void clearChanged ()
 Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the hasChanged method will now return false. More...
 
void setChanged ()
 Marks this Observable object as having been changed; the hasChanged method will now return true. 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

virtual bool com.pcbsys.nirvana.nAdminAPI.nClusterStatus.canBeMaster ( )
virtual

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

Returns
whether the member can be elected master
virtual string com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getElectedMaster ( )
virtual

The name of the nodes elected master.

Returns
the elected master.
virtual nClusterSite com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getSite ( )
virtual

Returns the site for this realm

Returns
This realms site
virtual string com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getState ( )
virtual

Returns the realms cluster state.

Returns
String representing the current state of this node within the cluster.
virtual nClusterStatusEntry com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getStatus ( string  realm)
virtual

Returns nClusterStatusEntry for the specified realm.

Parameters
realmname to get status for.
Returns
status for specified realm.
virtual nClusterStatusEntry com.pcbsys.nirvana.nAdminAPI.nClusterStatus.getStatus ( int  idx)
virtual

Returns nClusterStatusEntry for the realm at the index specified

Parameters
idxto get the status for.
Returns
status object at the requested index.
virtual bool com.pcbsys.nirvana.nAdminAPI.nClusterStatus.hasSite ( )
virtual

Indicates whether this realm has a site

Returns
true if this realm has a site
virtual int com.pcbsys.nirvana.nAdminAPI.nClusterStatus.size ( )
virtual

The number of known nodes within the cluster.

Returns
number of nodes within the cluster.

Property Documentation

virtual string com.pcbsys.nirvana.nAdminAPI.nClusterStatus.Name
get

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

Returns
the name of the realm.