com.pcbsys.nirvana.nAdminAPI.nClusterSite Class Reference

This class defines a collection of realms within a cluster into a physical site / location. More...

Inherits com::pcbsys::foundation::collections::SortedObject.


Public Member Functions

void addMember (String name) throws Exception
 Add a realm to this site.
void delMember (String realmName) throws Exception
 Remove a realm as a member of a site.
boolean equals (Object item)
 Compares this object with the passed object.
boolean equals (long aLong)
 Compares this object with the passed object.
String findNode (String name)
 Find a specific member realm in this site.
Iterator getIterator ()
 Returns an iterator of known site member realms.
String getName ()
 Get the name of the defined cluster site.
Enumeration getNodes ()
 Return the members defined in this site.
int getNoOfMembers ()
 Return the number of members defined in this site.
boolean isMember (String name)
 Check if a realm is a member of this site.
boolean isPrime ()
 Returns if the defined site is regarded as prime.
boolean lessThan (Object item)
 Compares this object with the passed object.
boolean lessThan (long aLong)
 Compares this object with the passed object.
void setPrime (boolean flag) throws Exception
 Sets whether this site is defined as prime.

Detailed Description

This class defines a collection of realms within a cluster into a physical site / location.

A site can be given prime status, which means that in failover with 2 sites defined, the prime site will receive and additional vote enabling the remaining cluster realms to achieve quorum

Member Function Documentation

void com.pcbsys.nirvana.nAdminAPI.nClusterSite.addMember ( String  name  )  throws Exception

Add a realm to this site.

Parameters:
name name of the realm to be added
Exceptions:
Exception if the operation could not be completed

void com.pcbsys.nirvana.nAdminAPI.nClusterSite.delMember ( String  realmName  )  throws Exception

Remove a realm as a member of a site.

Parameters:
realmName the realm to delete from the site
Exceptions:
Exception if the operation could not be completed

boolean com.pcbsys.nirvana.nAdminAPI.nClusterSite.equals ( Object  item  ) 

Compares this object with the passed object.

For internal use only

Parameters:
item Object to compare against
Returns:
True if this object is equal to the passed object

boolean com.pcbsys.nirvana.nAdminAPI.nClusterSite.equals ( long  aLong  ) 

Compares this object with the passed object.

For internal use only

Parameters:
aLong long to compare against
Returns:
True if this object is equal to the passed long

String com.pcbsys.nirvana.nAdminAPI.nClusterSite.findNode ( String  name  ) 

Find a specific member realm in this site.

Parameters:
name name of the realm you wish to find in the members
Returns:
the name of the realm or null if not found

Iterator com.pcbsys.nirvana.nAdminAPI.nClusterSite.getIterator (  ) 

Returns an iterator of known site member realms.

Returns:
iterator of site member realms

String com.pcbsys.nirvana.nAdminAPI.nClusterSite.getName (  ) 

Get the name of the defined cluster site.

Returns:
the cluster site name

Enumeration com.pcbsys.nirvana.nAdminAPI.nClusterSite.getNodes (  ) 

Return the members defined in this site.

Returns:
The site members
Deprecated:
Please use getIterator

int com.pcbsys.nirvana.nAdminAPI.nClusterSite.getNoOfMembers (  ) 

Return the number of members defined in this site.

Returns:
The number of site members

boolean com.pcbsys.nirvana.nAdminAPI.nClusterSite.isMember ( String  name  ) 

Check if a realm is a member of this site.

Parameters:
name of the realm to check
Returns:
true / false whether the realm is a member

boolean com.pcbsys.nirvana.nAdminAPI.nClusterSite.isPrime (  ) 

Returns if the defined site is regarded as prime.

Returns:
true if prime

boolean com.pcbsys.nirvana.nAdminAPI.nClusterSite.lessThan ( Object  item  ) 

Compares this object with the passed object.

For internal use only

Parameters:
item Object to compare against
Returns:
True if this object is less than the passed object

boolean com.pcbsys.nirvana.nAdminAPI.nClusterSite.lessThan ( long  aLong  ) 

Compares this object with the passed object.

For internal use only

Parameters:
aLong long to compare against
Returns:
True if this object is less than the passed long

void com.pcbsys.nirvana.nAdminAPI.nClusterSite.setPrime ( boolean  flag  )  throws Exception

Sets whether this site is defined as prime.

Parameters:
flag whether the site is prime
Exceptions:
Exception if the operation could not be completed