com::pcbsys::nirvana::nAdminAPI::nClusterMemberConfiguration Class Reference

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

#include <nClusterMemberConfiguration.h>

Inherits com::pcbsys::nirvana::nAdminAPI::nPkgCloseListener.

Public Member Functions
virtual void	closed (nRealmNode *pNode)
	Called when a realm node is closed, for internal use only. More...
	nClusterMemberConfiguration (nRealmNode *pRealmNode, bool bCanBeMaster=true)
	Constructor using an existing nRealmNode. More...
	nClusterMemberConfiguration (nSessionAttributes *pSessionAttributes, bool bCanBeMaster=true)
	Constructor using the nSessionAttributes to connect to the Nirvana Realm Server. More...
	nClusterMemberConfiguration (nSessionAttributes *pSessionAttributes, bool bCanBeMaster, const std::string &username)
	Constructor using the nSessionAttributes to connect to the Nirvana Realm Server. More...
	nClusterMemberConfiguration (const std::string &rname, bool bCanBeMaster=true)
	Constructor using the nSessionAttributes to connect to the Nirvana Realm Server. More...
	nClusterMemberConfiguration (const std::string &rname, bool bCanBeMaster, const std::string &username)
	Constructor using a Nirvana Realm URL to connect to the Nirvana Realm server. More...

Protected Member Functions
virtual nRealmNode *	getNode ()
	Returns the nRealmNode object of the Nirvana Server. More...

Detailed Description

This object is used to create/modify clusters.

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

Constructor & Destructor Documentation

com::pcbsys::nirvana::nAdminAPI::nClusterMemberConfiguration::nClusterMemberConfiguration	(	nRealmNode *	pRealmNode,
		bool	bCanBeMaster = true
	)

Constructor using an existing nRealmNode.

Parameters

realmNode	realm node object connected to the node to be added.
canBeMaster	boolean if this node can be a master within the cluster.

com::pcbsys::nirvana::nAdminAPI::nClusterMemberConfiguration::nClusterMemberConfiguration	(	nSessionAttributes *	pSessionAttributes,
		bool	bCanBeMaster = true
	)

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

Parameters

sessionAttributes	details of the server to connect to.
canBeMaster	boolean if this node can be a master within the cluster.

Exceptions

nBaseAdminException

if unable to connect to the specified realm.

com::pcbsys::nirvana::nAdminAPI::nClusterMemberConfiguration::nClusterMemberConfiguration	(	nSessionAttributes *	pSessionAttributes,
		bool	bCanBeMaster,
		const std::string &	username
	)

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

Parameters

sessionAttributes	details of the server to connect to.
canBeMaster	boolean if this node can be a master within the cluster.
username	to use to connect to the remote realm with.

Exceptions

nBaseAdminException

if unable to connect to the specified realm.

com::pcbsys::nirvana::nAdminAPI::nClusterMemberConfiguration::nClusterMemberConfiguration	(	const std::string &	rname,
		bool	bCanBeMaster = true
	)

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

Parameters

rname	details of the server to connect to.
canBeMaster	boolean if this node can be a master within the cluster.

Exceptions

nBaseAdminException

if unable to connect to the specified realm.

com::pcbsys::nirvana::nAdminAPI::nClusterMemberConfiguration::nClusterMemberConfiguration	(	const std::string &	rname,
		bool	bCanBeMaster,
		const std::string &	username
	)

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

Parameters

rname	to connect to.
canBeMaster	boolean if this node can be a master within the cluster.
username	to use to connect to the remote realm with.

Exceptions

nIllegalArgumentException	if the rname is not valid.
nBaseAdminException	if unable to connect to the specified realm.

Member Function Documentation

virtual void com::pcbsys::nirvana::nAdminAPI::nClusterMemberConfiguration::closed ( nRealmNode *  pNode )

virtual

Called when a realm node is closed, for internal use only.

Parameters

*pNode

the node which has been closed

virtual nRealmNode* com::pcbsys::nirvana::nAdminAPI::nClusterMemberConfiguration::getNode ( )

protectedvirtual

Returns the nRealmNode object of the Nirvana Server.

Returns

nRealmNode object.