com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer Class Reference

This class is an Admin API wrapper for all configured Data Group objects (nDataGroup) This class also can also be used to obtain all known nDataStream objects, that have been added to the default data group. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer:
com.pcbsys.nirvana.nAdminAPI.nContainer com.pcbsys.nirvana.nAdminAPI.nNode

Public Member Functions

nNode findNode (String name) throws nAdminIllegalArgumentException
 This method will return a matching nDataGroupNode if one exists. More...
 
Iterator< nDataStreamgetAllStreams ()
 Get all nDataStream objects connected to the Nirvana realm. More...
 
float getConsumedRate ()
 The number of events consumed per second across all nDataGroup objects. More...
 
nDataGroupNode getDefaultDataGroup ()
 Obtain the default nDataGroup object. More...
 
int getGroupCount ()
 Get the number of known nDataGroup objects. More...
 
float getPublishRate ()
 The number of events published per second across all nDataGroup objects. More...
 
int getStreamCount ()
 Get the number of nDataStream objects currently connected. More...
 
long getTotalConsumed ()
 Returns the total number of events that delivered to listeners across all nDataGroup objects. More...
 
long getTotalPublished ()
 Returns the total number of events published to this all data groups since the realm has started. More...
 
long getTotalStreamCount ()
 Returns the total number of streams that have been added to all data groups since the realm last started. 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

This class is an Admin API wrapper for all configured Data Group objects (nDataGroup) This class also can also be used to obtain all known nDataStream objects, that have been added to the default data group.

See Also
com.pcbsys.nirvana.client.nDataGroup
com.pcbsys.nirvana.client.nDataStream

Member Function Documentation

nNode com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.findNode ( String  name) throws nAdminIllegalArgumentException

This method will return a matching nDataGroupNode if one exists.

Parameters
namethe name of the node to locate as a String
Returns
the matching nDataGroupNode or null if it does not exist
Iterator<nDataStream> com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getAllStreams ( )

Get all nDataStream objects connected to the Nirvana realm.

Returns
an Iterator of all nDataStream objects
float com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getConsumedRate ( )

The number of events consumed per second across all nDataGroup objects.

Returns
float the rate at which events are being consumed on the data group
nDataGroupNode com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getDefaultDataGroup ( )

Obtain the default nDataGroup object.

Returns
default nDataGroup
int com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getGroupCount ( )

Get the number of known nDataGroup objects.

Returns
the total number of nDataGroup objects
float com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getPublishRate ( )

The number of events published per second across all nDataGroup objects.

Returns
float the rate at which events are being written to the data group
int com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getStreamCount ( )

Get the number of nDataStream objects currently connected.

Returns
the total number of nDataStream objects
long com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getTotalConsumed ( )

Returns the total number of events that delivered to listeners across all nDataGroup objects.

Returns
long the total number of consumed events
long com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getTotalPublished ( )

Returns the total number of events published to this all data groups since the realm has started.

Returns
long the total number of published events
long com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer.getTotalStreamCount ( )

Returns the total number of streams that have been added to all data groups since the realm last started.

Returns
long the total number of streams contained in the data group