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. More...
 
String getMountPoint ()
 The MountPoint, if any, for this LinkedNode. More...
 
nRealmNode getRealmNode ()
 Returns the actual nRealmNode to the application. More...
 
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. 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

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
nodeThe nRealmNode which has been closed.
String com.pcbsys.nirvana.nAdminAPI.nLinkNode.getMountPoint ( )

The MountPoint, if any, for this LinkedNode.

Returns
The MountPoint for this Linked Node. If this Linked Node does not have a MountPoint, it will return null.
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
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 will also be removed from the realm before removing it from its parent

Parameters
removeChildrena boolean specifying whether siblings should be removed too
Exceptions
nUnsupportedRemoveExceptionthrown if remove is not supported (e.g. on the namespace root Realm)
nNodeExceptionis thrown if an error occurs in the remove operation
See Also
nLeafNode
nRealmNode

Implements com.pcbsys.nirvana.nAdminAPI.nRemovable.