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...

#include <nDataGroupsContainer.h>

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

Public Member Functions

virtual nNodefindNode (const std::string name)
 This method will return a matching nDataGroupNode if one exists. More...
 
std::list< nDataStream * > * getAllStreams ()
 Get all nDataStream objects connected to the Nirvana realm. More...
 
float getConsumedRate ()
 The number of events consumed per second across all nDataGroup objects. More...
 
nDataGroupNodegetDefaulDataGroup ()
 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 current number of nDataStream objects connected. More...
 
longlong getTotalConsumed ()
 Returns the total number of events that delivered to listeners across all nDataGroup objects. More...
 
longlong getTotalPublished ()
 Returns the total number of events published to this all data groups since the realm has started. More...
 
longlong 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 *pAcl, nNode **ppNodes=NULL, int numNode=0)
 Adds an acl to the list of nodes. More...
 
virtual void addACLEntry (nACLEntry *pEntry, bool bAllChannels=true, bool bAllQueues=true, bool bAllServices=true)
 Adds a specific acl entry to all known nodes within the nContainer node. More...
 
virtual void closed (nRealmNode *pNode)
 Called when a realm node is closed, for internal use only. More...
 
virtual nNodefindNode (nNode *pNode)
 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...
 
virtual nNodefindNode (nNode *pNode, bool searchChildren)
 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...
 
virtual nNodegetNextSibling (int idx=0)
 In findnode we were calling getNextSibling and occassionally hitting an nDataStreamNode. More...
 
virtual fSortedList
< std::string, nNode * > & 
getNodes ()
 Returns an fSortedList of all the nodes under this container. More...
 
virtual nRealmNodegetRealmAt (std::string name)
 Given a mount point this function will return a realm if one exists at the specified mount point. More...
 
virtual 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...
 
virtual int getType ()
 Returns the type of this object, for internal use only. More...
 
virtual bool hasRealmAt (std::string name)
 Given a mount point this function will determine if this container contains a mounted realm at the specified mount point. More...
 
void modACLEntries (nACL *pAcl, nNode **ppNodes=NULL, int numNode=0)
 Modifies an existing acl for the list of nodes. More...
 
virtual void modACLEntry (nACLEntry *pEntry, bool bAllChannels=true, bool bAllQueues=true, bool bAllServices=true)
 modifies a specific acl entry's permissions for all known nodes within the nContainer node. More...
 
void removeACLEntries (nACL *pAcl, nNode **ppNodes=NULL, int numNode=0)
 Removes the contents of an acl list from the list of nodes. More...
 
virtual void removeACLEntry (nACLEntry *pEntry, bool bAllChannels=true, bool bAllQueues=true, bool bAllServices=true)
 removes a specific acl entry from all known nodes within the nContainer node. More...
 
virtual void setACL (nACL *pAcl, bool allChannels=true, bool allQueues=true, bool allServices=true)
 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
virtual BitArray * convertLong (longlong priv)
 Converts from a long to a bitArray used to specify ACL properties. More...
 
virtual nACLEntrycreateACLEntry (const std::string &subject, BitArray *pBs)
 Adds a specific acl entry to the leaf node acl. More...
 
virtual nACLEntrycreateACLEntry (nSecurityGroup *grp, BitArray *pBs)
 Adds a specific security group to the leaf node acl. More...
 
virtual bool Equals (nNode *pItem)
 Check if this nNode is the same as the nNode passed in. More...
 
virtual bool Equals (const std::string &item)
 Check if the string passed in matches the name of this nNode. More...
 
virtual const std::string & getAbsolutePath ()
 This function walks the tree to the root to generate a fully qualified name for this node. More...
 
const std::string & getInternalName ()
 Returns the name of this nNode. More...
 
const std::string & getName ()
 Returns the name of the node. More...
 
virtual nNodegetParent ()
 Returns this nodes parent node. More...
 
virtual std::string getRelativePath (nNode *pTop)
 This method returns the relative path from this node to the nNode passed. More...
 
virtual bool IsRemovable ()
 Returns true if this nNode can be removed. 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

virtual nNode* com::pcbsys::nirvana::nAdminAPI::nDataGroupsContainer::findNode ( const std::string  name)
virtual

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
Exceptions
nAdminIllegalArgumentException

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

std::list<nDataStream*>* com::pcbsys::nirvana::nAdminAPI::nDataGroupsContainer::getAllStreams ( )

Get all nDataStream objects connected to the Nirvana realm.

Returns
an IEnumerable of all nDataStream objects
float com::pcbsys::nirvana::nAdminAPI::nDataGroupsContainer::getConsumedRate ( )

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

Returns
the rate at which events are being consumed
nDataGroupNode* com::pcbsys::nirvana::nAdminAPI::nDataGroupsContainer::getDefaulDataGroup ( )

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
the rate at which events are being written to the groups
int com::pcbsys::nirvana::nAdminAPI::nDataGroupsContainer::getStreamCount ( )

Get the current number of nDataStream objects connected.

Returns
the current number of connected nDataStream objects
longlong com::pcbsys::nirvana::nAdminAPI::nDataGroupsContainer::getTotalConsumed ( )

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

Returns
total number of events consumed since the realm started
longlong com::pcbsys::nirvana::nAdminAPI::nDataGroupsContainer::getTotalPublished ( )

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

Returns
total number of events published since the realm started
longlong 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
total number of streams