com.pcbsys.nirvana.nAdminAPI.nClusterSite Class Reference

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

Public Member Functions
virtual void	addMember (string name)
	Add a realm to this site More...
virtual void	delMember (string realmName)
	Remove a realm as a member of a site More...
bool	Equals (long aLong)
	Required as part of the SortedObject interface. More...
override bool	Equals (object item)
	Used to compares this Object with another to determine sorting position. More...
virtual string	findNode (string name)
	Find a specific member realm in this site More...
virtual IEnumerator	getEnumerator ()
	Returns an iterator of known site member realms More...
virtual int	getNoOfMembers ()
	Return the number of members defined in this site More...
virtual bool	isMember (string name)
	Check if a realm is a member of this site More...
virtual bool	isPrime ()
	Returns if the defined site is regarded as prime More...
virtual bool	lessThan (long aLong)
	Required as part of the SortedObject interface. More...
virtual bool	lessThan (object item)
	Used to compares this Object with another to determine sorting position More...
virtual void	setPrime (bool flag)
	Sets whether this site is defined as prime More...

Properties
virtual string	Name [get]
	Get the name of the defined cluster site More...

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

virtual void com.pcbsys.nirvana.nAdminAPI.nClusterSite.addMember ( string  name )

virtual

Add a realm to this site

Parameters

name	name of the realm to be added

Exceptions

Exception

if the operation could not be completed

virtual void com.pcbsys.nirvana.nAdminAPI.nClusterSite.delMember ( string  realmName )

virtual

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

bool com.pcbsys.nirvana.nAdminAPI.nClusterSite.Equals

(

long

aLong

)

Required as part of the SortedObject interface.

For internal use only

override bool com.pcbsys.nirvana.nAdminAPI.nClusterSite.Equals

(

object

item

)

Used to compares this Object with another to determine sorting position.

For internal use only

Parameters

item	Object to compare

Returns

True if this object is equal to the passed in object

virtual string com.pcbsys.nirvana.nAdminAPI.nClusterSite.findNode ( string  name )

virtual

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

virtual IEnumerator com.pcbsys.nirvana.nAdminAPI.nClusterSite.getEnumerator ( )

virtual

Returns an iterator of known site member realms

Returns

iterator of site member realms

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

virtual

Return the number of members defined in this site

Returns

The number of site members

virtual bool com.pcbsys.nirvana.nAdminAPI.nClusterSite.isMember ( string  name )

virtual

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

virtual bool com.pcbsys.nirvana.nAdminAPI.nClusterSite.isPrime ( )

virtual

Returns if the defined site is regarded as prime

Returns

true if prime

virtual bool com.pcbsys.nirvana.nAdminAPI.nClusterSite.lessThan ( long  aLong )

virtual

Required as part of the SortedObject interface.

For internal use only

virtual bool com.pcbsys.nirvana.nAdminAPI.nClusterSite.lessThan ( object  item )

virtual

Used to compares this Object with another to determine sorting position

Parameters

item	Object to compare

Returns

True if this object is less then the passed in object

virtual void com.pcbsys.nirvana.nAdminAPI.nClusterSite.setPrime ( bool  flag )

virtual

Sets whether this site is defined as prime

Parameters

flag	whether the site is prime

Exceptions

Exception

if the operation could not be completed

Property Documentation

virtual string com.pcbsys.nirvana.nAdminAPI.nClusterSite.Name

get

Get the name of the defined cluster site

Returns

the cluster site name