com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration Class Reference

This object is used to create/modify clusters. More...

Inherits com.pcbsys.nirvana.nAdminAPI.nPkgCloseListener.

Public Member Functions

void close ()
 Close all sessions in the nClusterMemberConfiguration.
 
void closed (nRealmNode node)
 Called when the nRealmNode is closed, for internal use only. More...
 
 nClusterMemberConfiguration (nSessionAttributes sessionAttributes) throws nBaseAdminException
 Constructor using the nSessionAttributes to connect to the Nirvana Realm Server. More...
 
 nClusterMemberConfiguration (String rname) throws nIllegalArgumentException, nBaseAdminException
 Constructor using a Nirvana Realm URL to connect to the Nirvana Realm server. More...
 
 nClusterMemberConfiguration (nRealmNode realmNode)
 Constructor using an exsiting nRealmNode. More...
 
 nClusterMemberConfiguration (nSessionAttributes sessionAttributes, boolean canBeMaster) throws nBaseAdminException
 Constructor using the nSessionAttributes to connect to the Nirvana Realm Server. More...
 
 nClusterMemberConfiguration (String rname, boolean canBeMaster) throws nIllegalArgumentException, nBaseAdminException
 Constructor using a Nirvana Realm URL to connect to the Nirvana Realm server. More...
 
 nClusterMemberConfiguration (nSessionAttributes sessionAttributes, boolean canBeMaster, String username) throws nBaseAdminException
 Constructor using the nSessionAttributes to connect to the Nirvana Realm Server. More...
 
 nClusterMemberConfiguration (String rname, boolean canBeMaster, String username) throws nIllegalArgumentException, nBaseAdminException
 Constructor using a Nirvana Realm URL to connect to the Nirvana Realm server. More...
 
 nClusterMemberConfiguration (nRealmNode realmNode, boolean canBeMaster)
 Constructor using an existing nRealmNode. More...
 

Protected Member Functions

nRealmNode getNode ()
 Returns the nRealmNode object of the Nirvana Server. More...
 

Detailed Description

This object is used to create/modify clusters.

It contains the relavent information regarding a specific node to be added to the cluster.

Constructor & Destructor Documentation

com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration.nClusterMemberConfiguration ( nSessionAttributes  sessionAttributes) throws nBaseAdminException

Constructor using the nSessionAttributes to connect to the Nirvana Realm Server.

Parameters
sessionAttributesdetails of the server to connect to.
Exceptions
nBaseAdminExceptionif unable to connect to the specified realm.
com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration.nClusterMemberConfiguration ( String  rname) throws nIllegalArgumentException, nBaseAdminException

Constructor using a Nirvana Realm URL to connect to the Nirvana Realm server.

Parameters
rnameto connect to.
Exceptions
nIllegalArgumentExceptionif the rname is not valid.
nBaseAdminExceptionif unable to connect to the specified realm.
com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration.nClusterMemberConfiguration ( nRealmNode  realmNode)

Constructor using an exsiting nRealmNode.

Parameters
realmNoderealm node object connected to the node to be added.
com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration.nClusterMemberConfiguration ( nSessionAttributes  sessionAttributes,
boolean  canBeMaster 
) throws nBaseAdminException

Constructor using the nSessionAttributes to connect to the Nirvana Realm Server.

Parameters
sessionAttributesdetails of the server to connect to.
canBeMasterboolean if this node can be a master within the cluster.
Exceptions
nBaseAdminExceptionif unable to connect to the specified realm.
com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration.nClusterMemberConfiguration ( String  rname,
boolean  canBeMaster 
) throws nIllegalArgumentException, nBaseAdminException

Constructor using a Nirvana Realm URL to connect to the Nirvana Realm server.

Parameters
rnameto connect to.
canBeMasterboolean if this node can be a master within the cluster.
Exceptions
nIllegalArgumentExceptionif the rname is not valid.
nBaseAdminExceptionif unable to connect to the specified realm.
com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration.nClusterMemberConfiguration ( nSessionAttributes  sessionAttributes,
boolean  canBeMaster,
String  username 
) throws nBaseAdminException

Constructor using the nSessionAttributes to connect to the Nirvana Realm Server.

Parameters
sessionAttributesdetails of the server to connect to.
canBeMasterboolean if this node can be a master within the cluster.
usernameto use to connect to the remote realm with.
Exceptions
nBaseAdminExceptionif unable to connect to the specified realm.
com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration.nClusterMemberConfiguration ( String  rname,
boolean  canBeMaster,
String  username 
) throws nIllegalArgumentException, nBaseAdminException

Constructor using a Nirvana Realm URL to connect to the Nirvana Realm server.

Parameters
rnameto connect to.
canBeMasterboolean if this node can be a master within the cluster.
usernameto use to connect to the remote realm with.
Exceptions
nIllegalArgumentExceptionif the rname is not valid.
nBaseAdminExceptionif unable to connect to the specified realm.
com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration.nClusterMemberConfiguration ( nRealmNode  realmNode,
boolean  canBeMaster 
)

Constructor using an existing nRealmNode.

Parameters
realmNoderealm node object connected to the node to be added.
canBeMasterboolean if this node can be a master within the cluster.

Member Function Documentation

void com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration.closed ( nRealmNode  node)

Called when the nRealmNode is closed, for internal use only.

Parameters
nodeThe nRealmNode which has been closed.
nRealmNode com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration.getNode ( )
protected

Returns the nRealmNode object of the Nirvana Server.

Returns
nRealmNode object.