com.pcbsys.nirvana.nAdminAPI.nServiceNode Class Reference

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

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

com.pcbsys.nirvana.nAdminAPI.nNode

Public Member Functions

void addACLEntries (nACL entries) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 Adds a specific acl entry to the leaf node acl.
void addACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 Adds a specific acl entry to the leaf node acl.
void addListener (nConnectionListener listener)
 Adds a listener to this service.
void closed (nRealmNode node)
 Called when the nRealmNode is closed, for internal use only.
void delListener ()
 Removes the registered listener for this service.
nACL getACLs () throws nBaseAdminException
 Returns a nACL object containing a list of nServiceACLEntry.
float getConnectionRate ()
 The number of subscriptions made to this store per second.
float getConsumedRate ()
 The number of events published per second.
int getCurrentNoOfConnections ()
 Returns the number of current connections this service is handling.
long getCurrentNumberOfEvents ()
 Returns the number of events within the channel/queue.
nServiceInfo getInformation ()
 Returns a nServiceInfo containing information about the service.
String getLocalName ()
 Returns the local name without folder information for this service.
String getName ()
 Returns the name of the service.
float getPublishRate ()
 The number of events published per second.
nRealmNode getRealm ()
 Returns the Realm Node this leaf node is associated with.
long getTotalConsumed ()
 Returns the total number of events that this channel has delivered to subscribers.
long getTotalNoOfConnections ()
 Returns the total number of connections that this channel has had since the realm started.
long getTotalPublished ()
 Returns the total number of events published/pushed to this channel/queue since the realm has started.
long getUsedSpace ()
 Returns the space used by this service node.
boolean isActive ()
 This function returns true if the nServerService is still active.
void modACLEntries (nACL entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 modifies a specific acl entry's permissions in the leaf node acl.
void modACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 modifies a specific acl entry's permissions in the leaf node acl.
void removeACLEntries (nACL entries) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 removes a specific acl entry from the leaf node acl.
void removeACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 removes a specific acl entry from the leaf node acl.
void setACLs (nACL acl) throws nBaseAdminException, nInsufficientPrivilegesException
 Sets the acl on the service with the nACL list passed in.

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  entries  )  throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException

Adds a specific acl entry to the leaf node acl.

Parameters:
entries An nACL list containing the subjects and permissions to add to the leaf node acl
Exceptions:
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.

Parameters:
entry An nACL entry containing the subject and permissions to add to the leaf node acl
Exceptions:
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

Parameters:
listener nConnectionListener to use
See also:
nConnectionListener

void com.pcbsys.nirvana.nAdminAPI.nServiceNode.closed ( nRealmNode  node  ) 

Called when the nRealmNode is closed, for internal use only.

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

Returns:
nACL
Exceptions:
nBaseAdminException If unable to complete the function
See also:
nServiceACLEntry

nACL

float com.pcbsys.nirvana.nAdminAPI.nServiceNode.getConnectionRate (  ) 

The number of subscriptions made to this store per second.

Returns:
float value

float com.pcbsys.nirvana.nAdminAPI.nServiceNode.getConsumedRate (  ) 

The number of events published per second.

Returns:
float value

int com.pcbsys.nirvana.nAdminAPI.nServiceNode.getCurrentNoOfConnections (  ) 

Returns the number of current connections this service is handling.

Returns:
int number of connections

long com.pcbsys.nirvana.nAdminAPI.nServiceNode.getCurrentNumberOfEvents (  ) 

Returns the number of events within the channel/queue.

Returns:
long value

nServiceInfo com.pcbsys.nirvana.nAdminAPI.nServiceNode.getInformation (  ) 

Returns a nServiceInfo containing information about the service.

Returns:
nServiceInfo
See also:
nServiceInfo

String com.pcbsys.nirvana.nAdminAPI.nServiceNode.getLocalName (  ) 

Returns the local name without folder information for this service.

Returns:
String name

String com.pcbsys.nirvana.nAdminAPI.nServiceNode.getName (  ) 

Returns the name of the service.

Returns:
String name

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

float com.pcbsys.nirvana.nAdminAPI.nServiceNode.getPublishRate (  ) 

The number of events published per second.

Returns:
int value

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.

Returns:
nRealmNode value

long com.pcbsys.nirvana.nAdminAPI.nServiceNode.getTotalConsumed (  ) 

Returns the total number of events that this channel has delivered to subscribers.

Returns:
long value

long com.pcbsys.nirvana.nAdminAPI.nServiceNode.getTotalNoOfConnections (  ) 

Returns the total number of connections that this channel has had since the realm started.

Returns:
long value

long com.pcbsys.nirvana.nAdminAPI.nServiceNode.getTotalPublished (  ) 

Returns the total number of events published/pushed to this channel/queue since the realm has started.

Returns:
long value

long com.pcbsys.nirvana.nAdminAPI.nServiceNode.getUsedSpace (  ) 

Returns the space used by this service node.

Returns:
long 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

Returns:
boolean value representing the current state

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.

Parameters:
entry An nACL entry containing the subject and permissions to modify in the leaf node acl
Exceptions:
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.

Parameters:
entry An nACL entry containing the subject and permissions to modify in the leaf node acl
Exceptions:
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.

Parameters:
entries An nACL list containing the subjects and permissions to remove from the leaf node acl
Exceptions:
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.

Parameters:
entry An nACL entry containing the subject and permissions to remove from the leaf node acl
Exceptions:
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.

Parameters:
acl New set of ACL Entry objects to use
Exceptions:
nBaseAdminException If unable to complete the function
nInsufficientPrivilegesException If the user has no privilege to set the acl
See also:
nServiceACLEntry

nACL