com::pcbsys::nirvana::nAdminAPI::nServiceNode Class Reference

This class provides a mechanism to get information about P2P services on a particular realm. More...

#include <nServiceNode.h>

Inheritance diagram for com::pcbsys::nirvana::nAdminAPI::nServiceNode:
com::pcbsys::nirvana::nAdminAPI::nNode

Public Member Functions

void addACLEntries (nACL *pEntries)
 Adds a specific acl entry to the leaf node acl. More...
 
void addACLEntry (nACLEntry *pEntry)
 Adds a specific acl entry to the leaf node acl. More...
 
virtual void addListener (nAPIConnectionListener *pListener)
 Adds a listener to this service. More...
 
virtual void closed (nRealmNode *pNode)
 Called when the nRealmNode is closed. 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 acl entry to the given security group. More...
 
virtual nACLgetACLs ()
 Returns the ACLS associated with this Node. More...
 
virtual const std::string & getName ()
 Returns the name of the service. 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 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 provides a mechanism to get information about P2P services on a particular realm.

Member Function Documentation

void com::pcbsys::nirvana::nAdminAPI::nServiceNode::addACLEntries ( nACL pEntries)

Adds a specific acl entry to the leaf node acl.

Parameters
*pEntriesAn nACL list containing the subjects and permissions to add to the leaf node acl
Exceptions
nInsufficientPrivilegesExceptionIf the user is not permissioned to perform this operation
nNodeExceptionif the ACLs being set are invalid
nBaseAdminExceptionif unable to perform the operation, check the message for further information
void com::pcbsys::nirvana::nAdminAPI::nServiceNode::addACLEntry ( nACLEntry pEntry)

Adds a specific acl entry to the leaf node acl.

Parameters
*pEntryAn nACL entry containing the subject and permissions to add to the leaf node acl
Exceptions
nInsufficientPrivilegesExceptionIf the user is not permissioned to perform this operation
nNodeExceptionif the ACLs being set are invalid
nBaseAdminExceptionif unable to perform the operation, check the message for further information
virtual void com::pcbsys::nirvana::nAdminAPI::nServiceNode::addListener ( nAPIConnectionListener pListener)
virtual

Adds a listener to this service.

When connections to the service are added or removed the listener will be notified asynchronously

Parameters
listenernConnectionListener to use
See Also
nConnectionListener
virtual void com::pcbsys::nirvana::nAdminAPI::nServiceNode::closed ( nRealmNode pNode)
virtual

Called when the nRealmNode is closed.

Parameters
*pNodeThe nRealmNode which has been closed. Ê
virtual nACLEntry* com::pcbsys::nirvana::nAdminAPI::nServiceNode::createACLEntry ( const std::string &  subject,
BitArray *  pBs 
)
virtual

Adds a specific acl entry to the leaf node acl.

Parameters
*pEntriesAn nACL list containing the subjects and permissions to add to the leaf node acl
Exceptions
nInsufficientPrivilegesExceptionIf the user is not permissioned to perform this operation
nNodeExceptionif the ACLs being set are invalid
nBaseAdminExceptionif unable to perform the operation, check the message for further information

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

virtual nACLEntry* com::pcbsys::nirvana::nAdminAPI::nServiceNode::createACLEntry ( nSecurityGroup grp,
BitArray *  pBs 
)
virtual

Adds a specific acl entry to the given security group.

Parameters
grpthe security group to create the ACL for
*pBsthe BitArray representing the ACL settings to use.
Exceptions
nInsufficientPrivilegesExceptionIf the user is not permissioned to perform this operation
nNodeExceptionif the ACLs being set are invalid
nBaseAdminExceptionif unable to perform the operation, check the message for further information

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

virtual nACL* com::pcbsys::nirvana::nAdminAPI::nServiceNode::getACLs ( )
virtual

Returns the ACLS associated with this Node.

Returns
nACL* the ACLs associated with this node
virtual const std::string& com::pcbsys::nirvana::nAdminAPI::nServiceNode::getName ( )
virtual

Returns the name of the service.

Returns
String name