- com
- pcbsys
- nirvana
- nAdminAPI
- nServiceNode
This class provides a mechanism to get information about P2P services on a particular realm. More...
Public Member Functions | |
| void | addACLEntries (nACL entries) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Adds a specific acl entry to the leaf node acl. More... | |
| void | addACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Adds a specific acl entry to the leaf node acl. More... | |
| void | addListener (nConnectionListener listener) |
| Adds a listener to this service. More... | |
| void | closed (nRealmNode node) |
| Called when the nRealmNode is closed, for internal use only. More... | |
| void | delListener () |
| Removes the registered listener for this service. More... | |
| nACL | getACLs () throws nBaseAdminException |
| Returns a nACL object containing a list of nServiceACLEntry. More... | |
| float | getConnectionRate () |
| The number of subscriptions made to this store per second. More... | |
| float | getConsumedRate () |
| The number of events published per second. More... | |
| int | getCurrentNoOfConnections () |
| Returns the number of current connections this service is handling. More... | |
| long | getCurrentNumberOfEvents () |
| Returns the number of events within the channel/queue. More... | |
| nServiceInfo | getInformation () |
| Returns a nServiceInfo containing information about the service. More... | |
| String | getLocalName () |
| Returns the local name without folder information for this service. More... | |
| String | getName () |
| Returns the name of the service. More... | |
| float | getPublishRate () |
| The number of events published per second. More... | |
| nRealmNode | getRealm () |
| Returns the Realm Node this leaf node is associated with. More... | |
| long | getTotalConsumed () |
| Returns the total number of events that this channel has delivered to subscribers. More... | |
| long | getTotalNoOfConnections () |
| Returns the total number of connections that this channel has had since the realm started. More... | |
| long | getTotalPublished () |
| Returns the total number of events published/pushed to this channel/queue since the realm has started. More... | |
| long | getUsedSpace () |
| Returns the space used by this service node. More... | |
| boolean | isActive () |
| This function returns true if the nServerService is still active. More... | |
| void | modACLEntries (nACL entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| modifies a specific acl entry's permissions in the leaf node acl. More... | |
| void | modACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| modifies a specific acl entry's permissions in the leaf node acl. More... | |
| void | removeACLEntries (nACL entries) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| removes a specific acl entry from the leaf node acl. More... | |
| void | removeACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| removes a specific acl entry from the leaf node acl. More... | |
| void | setACLs (nACL acl) throws nBaseAdminException, nInsufficientPrivilegesException |
| Sets the acl on the service with the nACL list 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 provides a mechanism to get information about P2P services on a particular realm.
| void com.pcbsys.nirvana.nAdminAPI.nServiceNode.addACLEntries | ( | nACL | entries | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
Adds a specific acl entry to the leaf node acl.
| entries | An nACL list containing the subjects and permissions to add to the leaf node acl |
| 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 | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
Adds a specific acl entry to the leaf node acl.
| entry | An nACL entry containing the subject and permissions to add to the leaf node acl |
| 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.addListener | ( | nConnectionListener | listener | ) |
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 |
| void com.pcbsys.nirvana.nAdminAPI.nServiceNode.closed | ( | nRealmNode | node | ) |
Called when the nRealmNode is closed, for internal use only.
| node | The nRealmNode which has been closed. |
| void com.pcbsys.nirvana.nAdminAPI.nServiceNode.delListener | ( | ) |
Removes the registered listener for this service.
This will stop the listener getting informed of new connections to this service
| nACL com.pcbsys.nirvana.nAdminAPI.nServiceNode.getACLs | ( | ) | throws nBaseAdminException |
Returns a nACL object containing a list of nServiceACLEntry.
| nBaseAdminException | If unable to complete the function |
| float com.pcbsys.nirvana.nAdminAPI.nServiceNode.getConnectionRate | ( | ) |
The number of subscriptions made to this store per second.
| float com.pcbsys.nirvana.nAdminAPI.nServiceNode.getConsumedRate | ( | ) |
The number of events published per second.
| int com.pcbsys.nirvana.nAdminAPI.nServiceNode.getCurrentNoOfConnections | ( | ) |
Returns the number of current connections this service is handling.
| long com.pcbsys.nirvana.nAdminAPI.nServiceNode.getCurrentNumberOfEvents | ( | ) |
Returns the number of events within the channel/queue.
| nServiceInfo com.pcbsys.nirvana.nAdminAPI.nServiceNode.getInformation | ( | ) |
Returns a nServiceInfo containing information about the service.
| String com.pcbsys.nirvana.nAdminAPI.nServiceNode.getLocalName | ( | ) |
Returns the local name without folder information for this service.
| String com.pcbsys.nirvana.nAdminAPI.nServiceNode.getName | ( | ) |
Returns the name of the service.
| float com.pcbsys.nirvana.nAdminAPI.nServiceNode.getPublishRate | ( | ) |
The number of events published per second.
| nRealmNode com.pcbsys.nirvana.nAdminAPI.nServiceNode.getRealm | ( | ) |
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.
| long com.pcbsys.nirvana.nAdminAPI.nServiceNode.getTotalConsumed | ( | ) |
Returns the total number of events that this channel has delivered to subscribers.
| long com.pcbsys.nirvana.nAdminAPI.nServiceNode.getTotalNoOfConnections | ( | ) |
Returns the total number of connections that this channel has had since the realm started.
| long com.pcbsys.nirvana.nAdminAPI.nServiceNode.getTotalPublished | ( | ) |
Returns the total number of events published/pushed to this channel/queue since the realm has started.
| long com.pcbsys.nirvana.nAdminAPI.nServiceNode.getUsedSpace | ( | ) |
Returns the space used by this service node.
| boolean com.pcbsys.nirvana.nAdminAPI.nServiceNode.isActive | ( | ) |
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 | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
modifies a specific acl entry's permissions in the leaf node acl.
| entry | An nACL entry containing the subject and permissions to modify in the leaf node acl |
| 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 | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
modifies a specific acl entry's permissions in the leaf node acl.
| entry | An nACL entry containing the subject and permissions to modify in the leaf node acl |
| 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 | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
removes a specific acl entry from the leaf node acl.
| entries | An nACL list containing the subjects and permissions to remove from the leaf node acl |
| 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 | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
removes a specific acl entry from the leaf node acl.
| entry | An nACL entry containing the subject and permissions to remove from the leaf node acl |
| 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.setACLs | ( | nACL | acl | ) | throws nBaseAdminException, nInsufficientPrivilegesException |
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 |