This class provides a mechanism to get information about P2P services on a particular realm. More...
Public Member Functions | |
void | addACLEntries (nACL entries) |
Adds a list of acl entries to the service nodes acl More... | |
void | addACLEntry (nACLEntry entry) |
Adds an nACLEntry to this service nodes acl More... | |
virtual void | addListener (nConnectionListener listener) |
Adds a listener to this service. More... | |
virtual void | closed (nRealmNode node) |
Called when the nRealmNode is closed, for internal use only. More... | |
virtual void | delListener () |
Removes the registered listener for this service. More... | |
virtual nACL | getACLs () |
Returns a nACL object containing a list of nServiceACLEntry More... | |
virtual float | getConnectionRate () |
The number of subscriptions made to this store per second More... | |
virtual float | getConsumedRate () |
The number of events published per second More... | |
virtual int | getCurrentNoOfConnections () |
Returns the number of current connections this service is handling More... | |
virtual long | getCurrentNumberOfEvents () |
Returns the number of events within the channel/queue More... | |
virtual nServiceInfo | getInformation () |
Returns a nServiceInfo containing information about the service More... | |
virtual string | getLocalName () |
Returns the local name without folder information for this service. More... | |
virtual float | getPublishRate () |
The number of events published per second More... | |
virtual nRealmNode | getRealm () |
Returns the Realm Node this leaf node is associated with. More... | |
virtual long | getTotalConsumed () |
Returns the total number of events that this channel has delivered to subscribers More... | |
virtual long | getTotalNoOfConnections () |
Returns the total number of connections that this channel has had since the realm started More... | |
virtual long | getTotalPublished () |
Returns the total number of events published/pushed to this channel/queue since the realm has started More... | |
virtual long | getUsedSpace () |
Returns the number of bytes that this channel/queue consumes on the server More... | |
virtual bool | isActive () |
This function returns true if the nServerService is still active. More... | |
void | modACLEntries (nACL entry) |
Modifies the acl entries for the service nodes ACL More... | |
void | modACLEntry (nACLEntry entry) |
Modifies the acl entry for the service nodes ACL More... | |
void | removeACLEntries (nACL entries) |
Removes the acl entries from the service nodes ACL More... | |
void | removeACLEntry (nACLEntry entry) |
Removes the acl entry from the service nodes ACL More... | |
virtual void | setACLs (nACL acl) |
Sets the acl on the service with the nACL list passed in More... | |
![]() | |
bool | Equals (long aLong) |
Needed as part of the SortedObject interface. More... | |
override bool | Equals (object item) |
Compares this object with the passed object More... | |
virtual string | getAbsolutePath () |
This function walks the tree to the root to generate a fully qualified name for this node More... | |
virtual nNode | getParent () |
Returns this nodes parent node. More... | |
virtual string | getRelativePath (nNode top) |
This method returns the relative path from this node to the nNode passed. More... | |
virtual bool | lessThan (long aLong) |
Needed as part of the SortedObject interface. More... | |
virtual bool | lessThan (object item) |
Compares this object with the passed object. More... | |
Properties | |
override string | Name [get] |
Returns the name of the service. More... | |
![]() | |
virtual string | Name [get] |
Returns the generic name of this node within the namespace More... | |
This class provides a mechanism to get information about P2P services on a particular realm.
void com.pcbsys.nirvana.nAdminAPI.nServiceNode.addACLEntries | ( | nACL | entries | ) |
Adds a list of acl entries to the service nodes acl
entries | an nACL object containing the list of nACLEntries to add to the existing ACL for this service node |
nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
nNodeException | if the ACLs being set are invalid |
nBaseAdminException | if unable to perform the operation, check the message for further information |
void com.pcbsys.nirvana.nAdminAPI.nServiceNode.addACLEntry | ( | nACLEntry | entry | ) |
Adds an nACLEntry to this service nodes acl
entry | an nACL object containing the list of nACLEntries to add to the existing ACL for this service node |
nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
nNodeException | if the ACLs being set are invalid |
nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Adds a listener to this service.
When connections to the service are added or removed the listener will be notified asynchronously
listener | nConnectionListener to use |
|
virtual |
Called when the nRealmNode is closed, for internal use only.
node | The nRealmNode which has been closed |
|
virtual |
Removes the registered listener for this service.
This will stop the listener getting informed of new connections to this service
|
virtual |
Returns a nACL object containing a list of nServiceACLEntry
nBaseAdminException | If unable to complete the function |
|
virtual |
The number of subscriptions made to this store per second
|
virtual |
The number of events published per second
|
virtual |
Returns the number of current connections this service is handling
|
virtual |
Returns the number of events within the channel/queue
|
virtual |
Returns a nServiceInfo containing information about the service
nServiceInfo
|
virtual |
Returns the local name without folder information for this service.
|
virtual |
The number of events published per second
|
virtual |
Returns the Realm Node this leaf node is associated with.
Please note this might not be the root of the namespace but a federated realm.
|
virtual |
Returns the total number of events that this channel has delivered to subscribers
|
virtual |
Returns the total number of connections that this channel has had since the realm started
|
virtual |
Returns the total number of events published/pushed to this channel/queue since the realm has started
|
virtual |
Returns the number of bytes that this channel/queue consumes on the server
|
virtual |
This function returns true if the nServerService is still active.
If the nServerService is shutdown then this method will return false
void com.pcbsys.nirvana.nAdminAPI.nServiceNode.modACLEntries | ( | nACL | entry | ) |
Modifies the acl entries for the service nodes ACL
entry | an nACL object containing the list of nACLEntries to remove from the existing ACL for this service node |
nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
nNodeException | if the ACLs being set are invalid |
nBaseAdminException | if unable to perform the operation, check the message for further information |
void com.pcbsys.nirvana.nAdminAPI.nServiceNode.modACLEntry | ( | nACLEntry | entry | ) |
Modifies the acl entry for the service nodes ACL
entry | an nACL object containing the list of nACLEntries to remove from the existing ACL for this service node |
nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
nNodeException | if the ACLs being set are invalid |
nBaseAdminException | if unable to perform the operation, check the message for further information |
void com.pcbsys.nirvana.nAdminAPI.nServiceNode.removeACLEntries | ( | nACL | entries | ) |
Removes the acl entries from the service nodes ACL
entries | an nACL object containing the list of nACLEntries to remove from the existing ACL for this service node |
nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
nNodeException | if the ACLs being set are invalid |
nBaseAdminException | if unable to perform the operation, check the message for further information |
void com.pcbsys.nirvana.nAdminAPI.nServiceNode.removeACLEntry | ( | nACLEntry | entry | ) |
Removes the acl entry from the service nodes ACL
entry | an nACL object containing the list of nACLEntries to remove from the existing ACL for this leaf node |
nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
nNodeException | if the ACLs being set are invalid |
nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Sets the acl on the service with the nACL list passed in
acl | New set of ACL Entry objects to use |
nBaseAdminException | If unable to complete the function |
nInsufficientPrivilegesException | If the user has no privilege to set the acl |
|
get |
Returns the name of the service.