- com
- pcbsys
- nirvana
- nAdminAPI
- nDataGroupNode
This class is an Admin API wrapper for a Data Group object (nDataGroup) More...
Public Member Functions | |
void | addListener (nDataGroupListener listener) |
Add an nDataGroup listener to this node. More... | |
nNode | findNode (String name) |
Given a name of the DataGroup, this function will locate the data group object and return it, or null if that can not be found. More... | |
float | getConsumedRate () |
The number of events consumed per second. More... | |
nDataGroup | getDataGroup () |
Get the client API nDataGroup object represented by this node. More... | |
float | getFanoutTime () |
The total number of milliseconds it takes to fanout each event to all consumers. More... | |
long | getLastEID () |
Returns the last EID that was used for the data group. More... | |
float | getPublishRate () |
The number of events published per second. More... | |
long | getStreamCount () |
Returns the current number of streams that have been added to this data group. More... | |
long | getTotalConsumed () |
Returns the total number of events that this data group has delivered to listeners. More... | |
long | getTotalPublished () |
Returns the total number of events published to this data group since the realm has started. More... | |
long | getTotalStreamCount () |
Returns the total number of streams that have been added to this data group. More... | |
void | removeListener (nDataGroupListener listener) |
Remove the listener from the list of listeners. 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 | 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 | 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 | 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... | |
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... | |
This class is an Admin API wrapper for a Data Group object (nDataGroup)
void com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.addListener | ( | nDataGroupListener | listener | ) |
Add an nDataGroup listener to this node.
This allows multiple listeners to be added to an instance of the nDataGroup object this node represents
listener | the listener to notify when groups or streams are added/removed from this group |
nNode com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.findNode | ( | String | name | ) |
Given a name of the DataGroup, this function will locate the data group object and return it, or null if that can not be found.
The search is performed on the current container and children containers too respectively.
name | The name of the node to locate as a String |
float com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getConsumedRate | ( | ) |
The number of events consumed per second.
nDataGroup com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getDataGroup | ( | ) |
Get the client API nDataGroup object represented by this node.
float com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getFanoutTime | ( | ) |
The total number of milliseconds it takes to fanout each event to all consumers.
long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getLastEID | ( | ) |
Returns the last EID that was used for the data group.
float com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getPublishRate | ( | ) |
The number of events published per second.
long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getStreamCount | ( | ) |
Returns the current number of streams that have been added to this data group.
long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getTotalConsumed | ( | ) |
Returns the total number of events that this data group has delivered to listeners.
long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getTotalPublished | ( | ) |
Returns the total number of events published to this data group since the realm has started.
long com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.getTotalStreamCount | ( | ) |
Returns the total number of streams that have been added to this data group.
void com.pcbsys.nirvana.nAdminAPI.nDataGroupNode.removeListener | ( | nDataGroupListener | listener | ) |
Remove the listener from the list of listeners.
listener | the listener to remove |