Represents a Zone container node. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nZoneNode:

Public Member Functions
void	add (nNode node) throws nBaseAdminException, nBaseClientException
	Adds a member node to this container object. More...

void	delete (nNode node) throws nBaseAdminException, nBaseClientException
	Removes a member node from this container object. More...

int	getNumberOfClusters ()

nZone	getZone ()
	Zone accessor. More...

boolean	hasMember (final Object node)
	Indicates zone membership. More...

boolean	isClusterNode ()

	nZoneNode (nZone zone, nNode parent, ArrayList< nRealmNode > members) throws nBaseAdminException
	Constructor for nZoneNode. More...

	nZoneNode (ArrayList< nClusterNode > members, nZone zone, nNode parent) throws nBaseAdminException
	Constructor for nZoneNode. More...

	nZoneNode (nZone zone, nNode parent, nNode node) throws nBaseAdminException
	Constructor for nZoneNode. More...

Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nContainer
void	addACLEntries (nACL acl) throws nAdminIllegalArgumentException, nBaseAdminException
	Adds a list acl entry to all nodes. More...

void	addACLEntries (nACL acl, nNode[] nodes) throws nAdminIllegalArgumentException, nBaseAdminException
	Adds a list acl entry to all nodes contained with in the array of nNodes. More...

void	addACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Adds a specific acl entry to all known nodes within the nContainer node. More...

void	addACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Adds a specific acl entry to all known nodes within the nContainer node. More...

void	addACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Adds a specific acl entry to all known nodes within the nContainer node. More...

void	addACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices, boolean realm) throws nBaseAdminException
	Adds a specific acl entry to all known nodes within the nContainer node. More...

void	addACLEntry (boolean realmLevel, nACLEntry entry, boolean allChannels, boolean allQueues) throws nBaseAdminException
	Adds a specific acl entry to all known nodes within the nContainer node. More...

void	closed (nRealmNode node)
	Called when the nRealmNode is closed, for internal use only. More...

nNode	findNode (String name) throws nAdminIllegalArgumentException
	Given a name of the form /container/container/name this function will locate the name object and return it, or null if that object can not be found. More...

nNode	findNode (nNode node) throws nAdminIllegalArgumentException
	Given a name of the form /container/container/name this function will locate the nNode object and return it, or null if that can not be found. More...

nNode	findNode (nNode node, boolean searchChildren) throws nAdminIllegalArgumentException
	Given a name of the form /container/container/name this function will locate the name object and return it, or null if that can not be found. More...

nNode	getNextSibling ()
	Method to return the next sibling from this node's parent. More...

Enumeration	getNodes ()
	Returns an Enumeration of all the nodes under this container. More...

nRealmNode	getRealmAt (String name) throws nAdminIllegalArgumentException
	Given a mount point this function will return a realm if one exists at the specified mount point. More...

nRealmNode	getRealmNode ()
	Get the realm node at the root of this container node. More...

int	getSize ()
	Returns the number of nodes under this container. More...

int	getTotalNodes ()
	Returns the total number of nodes within this container and all subsequent children by traversing the entire structure beneath this container node. More...

boolean	hasRealmAt (String name) throws nAdminIllegalArgumentException
	Given a mount point this function will determine if this container contains a mounted realm at the specified mount point. More...

void	modACLEntries (nACL acl) throws nAdminIllegalArgumentException, nBaseAdminException
	Modifies a list of acl entry to all known nodes within the nContainer node. More...

void	modACLEntries (nACL acl, nNode[] nodes) throws nAdminIllegalArgumentException, nBaseAdminException
	Modifies a list of acl entry to all nodes contained with in the array of nNodes. More...

void	modACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	modifies a specific acl entry's permissions for all known nodes within the nContainer node. More...

void	modACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	modifies a specific acl entry's permissions for all known nodes within the nContainer node. More...

void	modACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	modifies a specific acl entry's permissions for all known nodes within the nContainer node. More...

void	modACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices, boolean realm) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	modifies a specific acl entry's permissions for all known nodes within the nContainer node. More...

void	modACLEntry (boolean realmLevel, nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	modifies a specific acl entry's permissions for all known nodes within the nContainer node. More...

void	removeACLEntries (nACL acl) throws nAdminIllegalArgumentException, nBaseAdminException
	Removes a list of acl entries from all known nodes within the nContainer node. More...

void	removeACLEntries (nACL acl, nNode[] nodes) throws nAdminIllegalArgumentException, nBaseAdminException
	Removes a list of acl entries from all nodes contained with in the array of nNodes. More...

void	removeACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	removes a specific acl entry from all known nodes within the nContainer node. More...

void	removeACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	removes a specific acl entry from all known nodes within the nContainer node. More...

void	removeACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	removes a specific acl entry from all known nodes within the nContainer node. More...

void	removeACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices, boolean realm) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Removes a specific acl entry from all known nodes within the nContainer node. More...

void	removeACLEntry (boolean realmLevel, nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Removes a specific acl entry from all known nodes within the nContainer node. More...

void	setACL (nACL acl) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Changes the entire ACL entries for all nodes within this container node. More...

void	setACL (nACL acl, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Changes the entire ACL entries for the selected nodes with the new ACL passed in. More...

void	setACL (nACL acl, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Changes the entire ACL entries for the selected nodes with the new ACL passed in. More...

Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nNode
boolean	equals (long aLong)
	Needed as part of the SortedObject interface.

synchronized String	getAbsolutePath ()
	This function walks the tree to the root to generate a fully qualified name for this node. More...

String	getName ()
	Returns the generic name of this node within the namespace. More...

nNode	getParent ()
	Returns this nodes parent node. More...

String	getRelativePath (nNode top) throws nAdminIllegalArgumentException
	This method returns the relative path from this node to the nNode passed. More...

boolean	isMatch (Object item)
	Compares this object with the passed object. More...

boolean	lessThan (long aLong)
	Needed as part of the SortedObject interface.

boolean	lessThan (Object item)
	Compares this object with the passed object. More...

Detailed Description

Represents a Zone container node.

Constructor & Destructor Documentation

com.pcbsys.nirvana.nAdminAPI.nZoneNode.nZoneNode	(	nZone	zone,
		nNode	parent,
		ArrayList< nRealmNode >	members
	)		throws nBaseAdminException

Constructor for nZoneNode.

Parameters

zone,:	The zone this container object represents
parent,:	Parent node of this container object
members,:	Initial members of this zone

com.pcbsys.nirvana.nAdminAPI.nZoneNode.nZoneNode	(	ArrayList< nClusterNode >	members,
		nZone	zone,
		nNode	parent
	)		throws nBaseAdminException

Constructor for nZoneNode.

Parameters

zone,:	The zone this container object represents
parent,:	Parent node of this container object
members,:	Initial members of this zone

com.pcbsys.nirvana.nAdminAPI.nZoneNode.nZoneNode	(	nZone	zone,
		nNode	parent,
		nNode	node
	)		throws nBaseAdminException

Constructor for nZoneNode.

Parameters

zone,:	The zone this container object represents
parent,:	Parent node of this container object
node,:	Initial member of this zone

Member Function Documentation

void com.pcbsys.nirvana.nAdminAPI.nZoneNode.add ( nNode node ) throws nBaseAdminException, nBaseClientException

Adds a member node to this container object.

Parameters

node,: The member node to add.

void com.pcbsys.nirvana.nAdminAPI.nZoneNode.delete ( nNode node ) throws nBaseAdminException, nBaseClientException

Removes a member node from this container object.

Parameters

node,: The member node to remove.

int com.pcbsys.nirvana.nAdminAPI.nZoneNode.getNumberOfClusters ( )

Returns: The size of the cluster this container object was initialised with, or zero if non-clustered.

nZone com.pcbsys.nirvana.nAdminAPI.nZoneNode.getZone ( )

Zone accessor.

Returns: The zone this container object represents

boolean com.pcbsys.nirvana.nAdminAPI.nZoneNode.hasMember ( final Object node )

Indicates zone membership.

Parameters

node,: The node to be queried.

Returns: True if node is a zone member, else False

boolean com.pcbsys.nirvana.nAdminAPI.nZoneNode.isClusterNode ( )

Returns: True if this container object was initialised with clustered members.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation