com.pcbsys.nirvana.nAdminAPI.nLinkNode Class Reference

Since the Nirvana namespace can contain multiple links to Nirvan Realm servers at different parts of the namespace, including namespace loops, this node represents a RealmServer which has been mounted elseware in the namespace. More...

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

com.pcbsys.nirvana.nAdminAPI.nContainer com.pcbsys.nirvana.nAdminAPI.nRemovable com.pcbsys.nirvana.nAdminAPI.nNode

Public Member Functions

void closed (nRealmNode node)
 Called when the nRealmNode is closed, for internal use only.
nRealmNode getRealmNode ()
 Returns the actual nRealmNode to the application.
void remove (boolean removeChildren) throws nUnsupportedRemoveException, nNodeException
 This method enables the removal of the object from the namespace, in this case a RealmNode from the namespace.

Detailed Description

Since the Nirvana namespace can contain multiple links to Nirvan Realm servers at different parts of the namespace, including namespace loops, this node represents a RealmServer which has been mounted elseware in the namespace.

It is basically a placeholder within the namespace and can be used by the application to stop looping through the namespace and to render the node differently or perhaps display a link between this node and the other nRealmNode.

See also:
nRealmNode

Member Function Documentation

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

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

Parameters:
node The nRealmNode which has been closed.

Reimplemented from com.pcbsys.nirvana.nAdminAPI.nContainer.

nRealmNode com.pcbsys.nirvana.nAdminAPI.nLinkNode.getRealmNode (  ) 

Returns the actual nRealmNode to the application.

Returns:
nRealmNode object of the real Realm Server
See also:
nRealmNode

Reimplemented from com.pcbsys.nirvana.nAdminAPI.nContainer.

void com.pcbsys.nirvana.nAdminAPI.nLinkNode.remove ( boolean  removeChildren  )  throws nUnsupportedRemoveException, nNodeException

This method enables the removal of the object from the namespace, in this case a RealmNode from the namespace.

If you specify true, all child nodes, including channels, queues and services will also be removed from the realm before removing it from its parent

Parameters:
removeChildren a boolean specifying whether siblings should be removed too
Exceptions:
nUnsupportedRemoveException thrown if remove is not supported (e.g. on the namespace root Realm)
nNodeException is thrown if an error occurs in the remove operation
See also:
nLeafNode

nRealmNode

Implements com.pcbsys.nirvana.nAdminAPI.nRemovable.