com.pcbsys.nirvana.nAdminAPI.nRealmNode Class Reference

This class represents a Realm within the Nirvana namespace. More...

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

com.pcbsys.nirvana.nAdminAPI.nContainer com.pcbsys.nirvana.nAdminAPI.nRemovable com.pcbsys.nirvana.client.nDataStreamListener com.pcbsys.nirvana.nAdminAPI.nNode

Public Member Functions

synchronized void addAuditListener (final nAuditListener listener, final boolean replay)
 This will register the nAuditListener for all audit events from this realm.
synchronized void addAuditListener (final nAuditListener listener)
 This will register the nAuditListener for all audit events from this realm.
synchronized void addConnectionListener (final nConnectionListener listener) throws nBaseAdminException
 Registers the listener object with the realm so that whenever a connection is made or lost with the realm the listener is notified of the change in state of the realm.
void addConnectionListenerToAllLeafNodes (final nConnectionListener listener) throws nBaseAdminException
 Registers a nConnectionListener to each nLeaNode of the nRealmNode.
void addConnectionListenerToAllServiceNodes (final nConnectionListener listener) throws nBaseAdminException
 Registers a nConnectionListener to each nServiceNode of the nRealmNode.
synchronized void addLogListener (final nLogListener listener)
 This will register the nLogListener for all log events from this realm.
synchronized void addPluginAccessListener (final nLogListener listener)
 This will register the nLogListener for all Access events from the plugin manager.
synchronized void addPluginErrorListener (final nLogListener listener)
 This will register the nLogListener for all error events from the plugin manager.
synchronized void addPluginLogListener (final nLogListener listener)
 This will register the nLogListener for all events from the plugin manager.
void addRealmACLEntries (nACL entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 Adds a specific acl entry to the realm acl.
void addRealmACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 Adds a specific acl entry to the realm acl.
void changeStatusChannel (final int type, final long age, final int capacity) throws nBaseAdminException
 This will cause the realm server to close the current status file, delete it and recreate the file using the attributes specified.
void changeTransactionChannel (final int type, final long age, final int capacity) throws nBaseAdminException
 This will cause the realm server to close the current transaction file, delete it and recreate the file using the attributes specified.
void close ()
 Closes the session with the remote Realm and all realms from this point in the namespace.
void commitConfig (final nConfigGroup changedGroup) throws nConfigurationException
 Calling this function with causes all changes within the group to be committed on the realm and activated.
nLeafNode createChannel (final com.pcbsys.nirvana.client.nChannelAttributes attr, final long p_initialEID, final nACL initialACL, nLeafNode dead) throws nUnknownRemoteRealmException, nSessionPausedException,nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
 Creates a new channel on the realm this session is connected.
nLeafNode createChannel (final com.pcbsys.nirvana.client.nChannelAttributes attr, final long p_initialEID, final nACL initialACL) throws nUnknownRemoteRealmException, nSessionPausedException,nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
 Creates a new channel on the realm this session is connected.
nLeafNode createChannel (final com.pcbsys.nirvana.client.nChannelAttributes attr, final long p_initialEID, nLeafNode dead) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
 Creates a new channel on the realm this session is connected.
nLeafNode createChannel (final com.pcbsys.nirvana.client.nChannelAttributes attr, final long p_initialEID) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
 Creates a new channel on the realm this session is connected.
nLeafNode createChannel (final com.pcbsys.nirvana.client.nChannelAttributes attr, nLeafNode dead) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
 Creates a new channel on the realm this session is connected.
nLeafNode createChannel (final com.pcbsys.nirvana.client.nChannelAttributes attr) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
 Creates a new channel on the realm this session is connected.
nLeafNode createQueue (final com.pcbsys.nirvana.client.nChannelAttributes attr, final nACL initialACL, nLeafNode dead) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException,nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
 Creates a new queue on the realm this session is connected.
nLeafNode createQueue (final com.pcbsys.nirvana.client.nChannelAttributes attr, nLeafNode dead) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
 Creates a new queue on the realm this session is connected.
nLeafNode createQueue (final com.pcbsys.nirvana.client.nChannelAttributes attr, final nACL initialACL) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException,nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
 Creates a new queue on the realm this session is connected.
nLeafNode createQueue (final com.pcbsys.nirvana.client.nChannelAttributes attr) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
 Creates a new queue on the realm this session is connected.
synchronized void delAuditListener (final nAuditListener listener)
 This will remove the audit listener from receiving future audit events.
synchronized void delConnectionListener (final nConnectionListener listener) throws nBaseAdminException
 Removes the registered listener from the realm so no further callbacks are made to the listener.
void delLeafNode (final nLeafNode node) throws nUnknownRemoteRealmException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nUnexpectedResponseException, nSessionPausedException,nRequestTimedOutException, nIllegalArgumentException
 Removes the specified channel/queue from the server.
synchronized void delLogListener (final nLogListener listener)
 This will remove the log listener from receiving future log events.
synchronized void delPluginAccessListener (final nLogListener listener)
 This will remove the log listener from receiving future log events.
synchronized void delPluginErrorListener (final nLogListener listener)
 This will remove the log listener from receiving future log events.
synchronized void delPluginLogListener (final nLogListener listener)
 This will remove the log listener from receiving future log events.
void delSchedulerNode (final nScheduler node) throws nBaseClientException
 Removes the specified nScheduler node from the server.
nConfigGroup findConfigGroup (final String groupName)
 Finds a configuration group by the name specified by the String argument.
nNode findNode (String name, boolean flag) throws nAdminIllegalArgumentException
 Given a name of the form /container/container/name this function will locate the name object and return it, or null if that object can not be found.
nNode findNode (String name) throws nAdminIllegalArgumentException
 Given a name of the form /container1/container2/name this function will try to locate the name object locally and return it, or null if that object can not be found.
nACL getACLs () throws nBaseAdminException
 Retrieves the current realms ACL so that the user can add/remove/modify the entries within.
long getBuffersCreated ()
 Number of data buffers created within the realms and for use within event fanout.
long getBuffersReused ()
 Number of data buffers reused by the event fanout.
nClusterNode getCluster ()
 Return the cluster node if one exists, i.e.
nConfigGroup getConfigGroup (String name)
 Returns the nConfigGroup specified by the name.
Enumeration getConfigGroups ()
 Returns a Enumeration containing nConfigGroup objects.
int getConfigGroupsLength ()
 Return the number of configuration groups defined in the realm.
int getCurrentConnections ()
 Returns the number of connections on this realm.
nDataGroupListener getDataGroupListener ()
 Get the default data group listener.
nDataGroupNode getDefaultDataGroup ()
 Get the default data group node.
long getFreeMemory ()
 Returns the amount of free memory the Realm Server has within the JVM.
nInterfaceManager getInterfaceManager ()
 Returns the Realms Interface Manager.
long getInternalSchedulerSize ()
 Return the total number of scheduled tasks currently running within the realm.
int getNoOfChannels ()
 Return the number of channels within the realm.
int getNoOfQueues ()
 Return the number of queues within the realm.
long getNoOfThreads ()
 Return the number of thread the JVM has allocated for the Realm Server.
int getQueuedThreads ()
 Number of threads currently queued ready to execute tasks.
com.pcbsys.nirvana.client.nRealm getRealm ()
 Returns the nRealm object for this RealmNode.
Vector getRealmList ()
 Method to return a vector of known realms.
nThreadEntry[] getRealmScheduledThreadList ()
 Sends a request to the Realm Server to produce a Thread dump.
int getReUsedThreads ()
 Return the number of reused threads within the realm.
nSchedulerManager getSchedulerManager ()
 Obtain the scheduler manager associated with this realm node.
Date getServerTime ()
 Returns the last status update date that the server sent.
Vector getServicesList ()
 Method to return a Vector of all p2p service nodes (nServiceNode) from this realm.
nSession getSession ()
 Returns the nSession object for this RealmNode.
Date getStartTime ()
 Returns the Date that the realm server was started.
Vector getThreadPoolDetails ()
 Return a Vector of nThreadPool objects that represent the different thread pools deployed within the realm.
long getTotalConnections ()
 Total number of connections served by this realm from the time it started.
long getTotalMemory ()
 Returns the total number of bytes that the JVM has allocated from the unerlying OS.
long getTotalPublished ()
 Returns the total number of events published on this realm from the time it has started.
long getTotalSubscribed ()
 Returns the total number of events that this realm has sent to clients from the time it started.
long getUpdateInterval ()
 Returns the update interval for status updates.
int getVendedThreads ()
 Get the total number of threads that have been allocated threads within the realm.
boolean hasConnectionListener ()
 Checks if there is a connection listener object associated with the realm.
boolean isAnEmbeddedServer ()
 If the realm is running within an application then this will be set to true.
boolean isAuthorised ()
 This function returns true if the user is authorised for admininstration functions on the remote realm.
boolean isClustered ()
 Returns the current cluster membership state of this realm.
boolean isConnected ()
 This method returns true if the connection to the remote realm is still valid.
boolean isEntireNamespaceComplete ()
 This method returns true when the namespace discovery process is complete for the entire namespace from this node down.
boolean isNamespaceComplete ()
 This method returns true when the namespace discovery process is complete.
void modRealmACLEntries (nACL entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 modifies a specific acl entry's permissions in the realm acl.
void modRealmACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 modifies a specific acl entry's permissions in the realm acl.
 nRealmNode (final nSessionAttributes sAttr, final String username) throws nBaseAdminException
 Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function.
 nRealmNode (final nSessionAttributes sAttr) throws nBaseAdminException
 Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function.
void onMessage (nConsumeEvent evt)
 Called when an event has been published to a data group that the client is a member of.
void releaseCachedMemory ()
 Sends a request to the Realm Server to release cached memory.
void remove (final boolean removeChildren) throws nUnsupportedRemoveException, nNodeException
 This method enables the removal of the object from the namespace, in this case a RealmNode from the namespace.
void removeConnection (final String connectionId, final boolean sendRedirection) throws nBaseAdminException
 This method will cause the server to disconnect the connection described by the connection ID.
void removeConnection (final String connectionId) throws nBaseAdminException
 This method will cause the server to disconnect the connection described by the connection ID.
void removeRealmACLEntries (nACL entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 removes a specific acl entry from the realm acl.
void removeRealmACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 removes a specific acl entry from the realm acl.
void requestThreadDump ()
 Sends a request to the Realm Server to produce a Thread dump.
void rollAuditFile () throws nBaseAdminException
 This will cause the realm server to close the current audit log, rename it to the current date and start a new audit log.
void rollLogFile ()
 Rolls the servers log file.
void setACLs (final nACL acl) throws nInsufficientPrivilegesException, nBaseAdminException
 Commits the ACL passed in with the Realm Server.
void waitForEntireNameSpace ()
 This method will block the calling thread until all of the namespace has been resolved.
void waitForEntireNameSpace (final long timeout) throws Exception
 This method will block the calling thread until all of the namespace has been resolved.
void waitForNameSpace ()
 This method will block the calling thread until the namespace discovery is complete for this node.
void waitForNameSpace (final long timeout) throws Exception
 This method will block the calling thread until the namespace discovery is complete for this node or the supplied timeout, in milliseconds, is reached.

Static Public Member Functions

static nACL createACL ()
 Return a new nACL object.
static boolean getAsyncUpdateFlag ()
 Return whether realm node will receive asynchronous updates from the server.
static void setAsyncUpdateFlag (boolean flag)
 Flag indicating whether the realm node will receive asynchronous updates from the server.

Detailed Description

This class represents a Realm within the Nirvana namespace.

This object allows the user to access the current status of the RealmServer, the current configuration parameters, change the ACL entries for the realm and access to the nodes that this RealmServer manages. It extents nContainer which is a Observable via nNode, if any status parameters change then the observer is notified via the notofy method.

This class also allows you to monitor connections to the realm by implementing a nConnectionListener and calling addConnectionListener with the object. Then when connections are added or deleted the callbacks will be executed with the details of the connections.

See also:
nContainer

nNode

Constructor & Destructor Documentation

com.pcbsys.nirvana.nAdminAPI.nRealmNode.nRealmNode ( final nSessionAttributes  sAttr  )  throws nBaseAdminException

Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function.

Parameters:
sAttr nSessionAttributes representing the realm you wish to communicate with
Exceptions:
nBaseAdminException If the user is not authorised for admin functions

com.pcbsys.nirvana.nAdminAPI.nRealmNode.nRealmNode ( final nSessionAttributes  sAttr,
final String  username 
) throws nBaseAdminException

Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function.

Parameters:
sAttr nSessionAttributes representing the realm you wish to communicate with
username Username to use to login to the server
Exceptions:
nBaseAdminException If the user is not authorised for admin functions

Member Function Documentation

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addAuditListener ( final nAuditListener  listener,
final boolean  replay 
)

This will register the nAuditListener for all audit events from this realm.

Parameters:
listener The listener object to call when new log events happen
replay specify true to replay the entire audit contents

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addAuditListener ( final nAuditListener  listener  ) 

This will register the nAuditListener for all audit events from this realm.

Parameters:
listener The listener object to call when new log events happen

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addConnectionListener ( final nConnectionListener  listener  )  throws nBaseAdminException

Registers the listener object with the realm so that whenever a connection is made or lost with the realm the listener is notified of the change in state of the realm.

Currently only one listener per session is supported.

Parameters:
listener The instance of the nConnectionListener to be called when connections are made or disconnected
Exceptions:
nBaseAdminException if the user is not permitted to access these lists, check the message for further information
See also:
nConnectionListener

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addConnectionListenerToAllLeafNodes ( final nConnectionListener  listener  )  throws nBaseAdminException

Registers a nConnectionListener to each nLeaNode of the nRealmNode.

Parameters:
listener The instance of the nConnectionListener to be called when connections are made or disconnected
Exceptions:
nBaseAdminException if the user is not permitted to access these lists, check the message for further information
See also:
nConnectionListener

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addConnectionListenerToAllServiceNodes ( final nConnectionListener  listener  )  throws nBaseAdminException

Registers a nConnectionListener to each nServiceNode of the nRealmNode.

Parameters:
listener The instance of the nConnectionListener to be called when connections are made or disconnected
Exceptions:
nBaseAdminException if the user is not permitted to access these lists, check the message for further information
See also:
nConnectionListener

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addLogListener ( final nLogListener  listener  ) 

This will register the nLogListener for all log events from this realm.

This can become quiet busy if the log level on the realm is set for verbose.

Parameters:
listener The listener object to call when new log events happen

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addPluginAccessListener ( final nLogListener  listener  ) 

This will register the nLogListener for all Access events from the plugin manager.

Parameters:
listener The listener object to call when new log events happen

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addPluginErrorListener ( final nLogListener  listener  ) 

This will register the nLogListener for all error events from the plugin manager.

Parameters:
listener The listener object to call when new log events happen

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addPluginLogListener ( final nLogListener  listener  ) 

This will register the nLogListener for all events from the plugin manager.

Parameters:
listener The listener object to call when new log events happen

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addRealmACLEntries ( nACL  entry  )  throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException

Adds a specific acl entry to the realm acl.

Parameters:
entry An nACL entry containing the subject and permissions to add to the realm 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.nRealmNode.addRealmACLEntry ( nACLEntry  entry  )  throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException

Adds a specific acl entry to the realm acl.

Parameters:
entry An nACL entry containing the subject and permissions to add to the realm 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.nRealmNode.changeStatusChannel ( final int  type,
final long  age,
final int  capacity 
) throws nBaseAdminException

This will cause the realm server to close the current status file, delete it and recreate the file using the attributes specified.

Parameters:
age the ttl which will be assigned as default to each nirvana status event stored into the status channel file
capacity set the maximum number of status events to store within the channel
type change the type of the status channel (default is mixed)
Exceptions:
nBaseAdminException If the user is not authorized for this function, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.changeTransactionChannel ( final int  type,
final long  age,
final int  capacity 
) throws nBaseAdminException

This will cause the realm server to close the current transaction file, delete it and recreate the file using the attributes specified.

Parameters:
age the ttl which will be assigned as default to each nirvana transaction
capacity set the maximum number of transactions to store within the channel
type change the type of the transaction channel (default is mixed)
Exceptions:
nBaseAdminException If the user is not authorized for this function, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.commitConfig ( final nConfigGroup  changedGroup  )  throws nConfigurationException

Calling this function with causes all changes within the group to be committed on the realm and activated.

All config changes are immediate and do not require the realm server to be restarted.

Parameters:
changedGroup The nConfigGroup containing the changed nConfigEntry
Exceptions:
nConfigurationException If the user is not authorized for this function, Check the message for more information

static nACL com.pcbsys.nirvana.nAdminAPI.nRealmNode.createACL (  )  [static]

Return a new nACL object.

Returns:
a new nACL object

nLeafNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.createChannel ( final com.pcbsys.nirvana.client.nChannelAttributes  attr,
final long  p_initialEID,
final nACL  initialACL,
nLeafNode  dead 
) throws nUnknownRemoteRealmException, nSessionPausedException,nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new channel on the realm this session is connected.

If the channel attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the channel will be created on that realm.

Parameters:
attr The channel attributes object containing the parameters for the new channel to be created @ param initialEID The channel will be created with the first eid being set to this value by default it is set to 0 but the user can set it to any positive value
p_initialEID The value to start the event id at
initialACL The initial ACLs to apply to the channel at creation time
dead The dead event store that will contain all purged, aged and dead events
Returns:
an nChannel object representing the newly created nirvana channel
Exceptions:
nUnknownRemoteRealmException The remote realm responded with an unknown exception
nSecurityException User is not authorised for the function
nChannelAlreadyExistsException The channel already exists
nSessionNotConnectedException Current session is not connected
nUnexpectedResponseException Internal Error has occured, since we received a response from the server out of sequence
nRequestTimedOutException The server has not responded to the request in the timeout period
nIllegalArgumentException Illegal parameter, check the message for more information
nSessionPausedException The session is currently paused, please resume

nLeafNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.createChannel ( final com.pcbsys.nirvana.client.nChannelAttributes  attr,
final long  p_initialEID,
final nACL  initialACL 
) throws nUnknownRemoteRealmException, nSessionPausedException,nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new channel on the realm this session is connected.

If the channel attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the channel will be created on that realm.

Parameters:
attr The channel attributes object containing the parameters for the new channel to be created @ param initialEID The channel will be created with the first eid being set to this value by default it is set to 0 but the user can set it to any positive value
p_initialEID The value to start the event id at
initialACL The initial ACLs to apply to the channel at creation time
Returns:
an nChannel object representing the newly created nirvana channel
Exceptions:
nUnknownRemoteRealmException The remote realm responded with an unknown exception
nSecurityException User is not authorised for the function
nChannelAlreadyExistsException The channel already exists
nSessionNotConnectedException Current session is not connected
nUnexpectedResponseException Internal Error has occured, since we received a response from the server out of sequence
nRequestTimedOutException The server has not responded to the request in the timeout period
nIllegalArgumentException Illegal parameter, check the message for more information
nSessionPausedException The session is currently paused, please resume

nLeafNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.createChannel ( final com.pcbsys.nirvana.client.nChannelAttributes  attr,
final long  p_initialEID,
nLeafNode  dead 
) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new channel on the realm this session is connected.

If the channel attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the channel will be created on that realm.

Parameters:
attr The channel attributes object containing the parameters for the new channel to be created @ param initialEID The channel will be created with the first eid being set to this value by default it is set to 0 but the user can set it to any positive value
p_initialEID The value to start the event id at
dead The dead event store that will contain all purged, aged and dead events
Returns:
an nChannel object representing the newly created nirvana channel
Exceptions:
nUnknownRemoteRealmException The remote realm responded with an unknown exception
nSecurityException User is not authorised for the function
nChannelAlreadyExistsException The channel already exists
nSessionNotConnectedException Current session is not connected
nUnexpectedResponseException Internal Error has occured, since we received a response from the server out of sequence
nRequestTimedOutException The server has not responded to the request in the timeout period
nIllegalArgumentException Illegal parameter, check the message for more information
nSessionPausedException The session is currently paused, please resume

nLeafNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.createChannel ( final com.pcbsys.nirvana.client.nChannelAttributes  attr,
final long  p_initialEID 
) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new channel on the realm this session is connected.

If the channel attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the channel will be created on that realm.

Parameters:
attr The channel attributes object containing the parameters for the new channel to be created @ param initialEID The channel will be created with the first eid being set to this value by default it is set to 0 but the user can set it to any positive value
p_initialEID The value to start the event id at
Returns:
an nChannel object representing the newly created nirvana channel
Exceptions:
nUnknownRemoteRealmException The remote realm responded with an unknown exception
nSecurityException User is not authorised for the function
nChannelAlreadyExistsException The channel already exists
nSessionNotConnectedException Current session is not connected
nUnexpectedResponseException Internal Error has occured, since we received a response from the server out of sequence
nRequestTimedOutException The server has not responded to the request in the timeout period
nIllegalArgumentException Illegal parameter, check the message for more information
nSessionPausedException The session is currently paused, please resume

nLeafNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.createChannel ( final com.pcbsys.nirvana.client.nChannelAttributes  attr,
nLeafNode  dead 
) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new channel on the realm this session is connected.

If the channel attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the channel will be created on that realm.

Parameters:
attr The channel attributes object containing the parameters for the new channel to be created
dead The dead event store that will contain all purged, aged and dead events
Returns:
an nChannel object representing the newly created nirvana channel
Exceptions:
com.pcbsys.nirvana.client.nUnknownRemoteRealmException The remote node responded with an unknown exception
nSecurityException User is not authorised for the function
com.pcbsys.nirvana.client.nChannelAlreadyExistsException The requested channel already exists
nSessionNotConnectedException Current session is not connected
nUnexpectedResponseException Internal Error has occured, since we received a response from the server out of sequence
nRequestTimedOutException The server has not responded to the request in the timeout period
nIllegalArgumentException Illegal parameter, check the message for more information
nSessionPausedException The session is currently paused, please resume

nLeafNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.createChannel ( final com.pcbsys.nirvana.client.nChannelAttributes  attr  )  throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new channel on the realm this session is connected.

If the channel attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the channel will be created on that realm.

Parameters:
attr The channel attributes object containing the parameters for the new channel to be created
Returns:
an nChannel object representing the newly created nirvana channel
Exceptions:
com.pcbsys.nirvana.client.nUnknownRemoteRealmException The remote node responded with an unknown exception
nSecurityException User is not authorised for the function
com.pcbsys.nirvana.client.nChannelAlreadyExistsException The requested channel already exists
nSessionNotConnectedException Current session is not connected
nUnexpectedResponseException Internal Error has occured, since we received a response from the server out of sequence
nRequestTimedOutException The server has not responded to the request in the timeout period
nIllegalArgumentException Illegal parameter, check the message for more information
nSessionPausedException The session is currently paused, please resume

nLeafNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.createQueue ( final com.pcbsys.nirvana.client.nChannelAttributes  attr,
final nACL  initialACL,
nLeafNode  dead 
) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException,nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new queue on the realm this session is connected.

If the queue attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the queue will be created on that realm.

Parameters:
attr The queue attributes object containing the parameters for the new queue to be created
initialACL The initial ACLs to apply to the queue at creation time
dead The dead event store that will contain all purged, aged and dead events
Returns:
an nLeafNode object representing the newly created nirvana queue
Exceptions:
nUnknownRemoteRealmException The remote realm responded with an unknown exception
nSecurityException User is not authorised for the function
nChannelAlreadyExistsException The channel already exists
nSessionNotConnectedException Current session is not connected
nUnexpectedResponseException Internal Error has occured, since we received a response from the server out of sequence
nRequestTimedOutException The server has not responded to the request in the timeout period
nIllegalArgumentException Illegal parameter, check the message for more information
nSessionPausedException The session is currently paused, please resume

nLeafNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.createQueue ( final com.pcbsys.nirvana.client.nChannelAttributes  attr,
nLeafNode  dead 
) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new queue on the realm this session is connected.

If the queue attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the queue will be created on that realm.

Parameters:
attr The queue attributes object containing the parameters for the new queue to be created
dead The dead event store that will contain all purged, aged and dead events
Returns:
an nLeafNode object representing the newly created nirvana queue
Exceptions:
nUnknownRemoteRealmException The remote realm responded with an unknown exception
nSecurityException User is not authorised for the function
nChannelAlreadyExistsException The channel already exists
nSessionNotConnectedException Current session is not connected
nUnexpectedResponseException Internal Error has occured, since we received a response from the server out of sequence
nRequestTimedOutException The server has not responded to the request in the timeout period
nIllegalArgumentException Illegal parameter, check the message for more information
nSessionPausedException The session is currently paused, please resume

nLeafNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.createQueue ( final com.pcbsys.nirvana.client.nChannelAttributes  attr,
final nACL  initialACL 
) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException,nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new queue on the realm this session is connected.

If the queue attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the queue will be created on that realm.

Parameters:
attr The queue attributes object containing the parameters for the new queue to be created
initialACL The initial ACLs to apply to the queue at creation time
Returns:
an nLeafNode object representing the newly created nirvana queue
Exceptions:
nUnknownRemoteRealmException The remote realm responded with an unknown exception
nSecurityException User is not authorised for the function
nChannelAlreadyExistsException The channel already exists
nSessionNotConnectedException Current session is not connected
nUnexpectedResponseException Internal Error has occured, since we received a response from the server out of sequence
nRequestTimedOutException The server has not responded to the request in the timeout period
nIllegalArgumentException Illegal parameter, check the message for more information
nSessionPausedException The session is currently paused, please resume

nLeafNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.createQueue ( final com.pcbsys.nirvana.client.nChannelAttributes  attr  )  throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException,nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new queue on the realm this session is connected.

If the queue attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the queue will be created on that realm.

Parameters:
attr The queue attributes object containing the parameters for the new queue to be created
Returns:
an nLeafNode object representing the newly created nirvana queue
Exceptions:
nUnknownRemoteRealmException The remote realm responded with an unknown exception
nSecurityException User is not authorised for the function
nChannelAlreadyExistsException The channel already exists
nSessionNotConnectedException Current session is not connected
nUnexpectedResponseException Internal Error has occured, since we received a response from the server out of sequence
nRequestTimedOutException The server has not responded to the request in the timeout period
nIllegalArgumentException Illegal parameter, check the message for more information
nSessionPausedException The session is currently paused, please resume

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.delAuditListener ( final nAuditListener  listener  ) 

This will remove the audit listener from receiving future audit events.

Parameters:
listener The listener object to remove

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.delConnectionListener ( final nConnectionListener  listener  )  throws nBaseAdminException

Removes the registered listener from the realm so no further callbacks are made to the listener.

Parameters:
listener The listener object to remove
Exceptions:
nBaseAdminException if the user is not permitted to access these lists
See also:
nConnectionListener

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.delLeafNode ( final nLeafNode  node  )  throws nUnknownRemoteRealmException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nUnexpectedResponseException, nSessionPausedException,nRequestTimedOutException, nIllegalArgumentException

Removes the specified channel/queue from the server.

Parameters:
node LeafNode to delete
Exceptions:
nUnknownRemoteRealmException if the path to the realm has been lost
nSecurityException If the current user has no authority to delete the resource
nChannelNotFoundException The channel/queue has already been deleted
nSessionNotConnectedException The current session is not currently connected
nUnexpectedResponseException The request resulted in an unknown response from the server
nRequestTimedOutException The request exceeded the specified time out period
nIllegalArgumentException The argument supplied is invalid
nSessionPausedException The session is currently paused, please resume

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.delLogListener ( final nLogListener  listener  ) 

This will remove the log listener from receiving future log events.

Parameters:
listener The listener object to remove

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.delPluginAccessListener ( final nLogListener  listener  ) 

This will remove the log listener from receiving future log events.

Parameters:
listener The listener object to remove

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.delPluginErrorListener ( final nLogListener  listener  ) 

This will remove the log listener from receiving future log events.

Parameters:
listener The listener object to remove

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.delPluginLogListener ( final nLogListener  listener  ) 

This will remove the log listener from receiving future log events.

Parameters:
listener The listener object to remove

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.delSchedulerNode ( final nScheduler  node  )  throws nBaseClientException

Removes the specified nScheduler node from the server.

Parameters:
node Scheduler to delete
Exceptions:
nBaseClientException The command was not successful

nConfigGroup com.pcbsys.nirvana.nAdminAPI.nRealmNode.findConfigGroup ( final String  groupName  ) 

Finds a configuration group by the name specified by the String argument.

Parameters:
groupName Name of the config group to find
Returns:
nConfigGroup object corresponding to the name or null if not found

nNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.findNode ( String  name,
boolean  flag 
) throws nAdminIllegalArgumentException

Given a name of the form /container/container/name this function will locate the name object and return it, or null if that object can not be found.

Parameters:
name the name of the node to locate as a String
flag Boolean flag indicating if we wait for the server to update our state or not
Returns:
a nNode which could be a nRealmNode, nLeafNode or a nContainer
Exceptions:
nAdminIllegalArgumentException thrown if null is passed as the nNode
See also:
nRealmNode

nLeafNode

nContainer

nNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.findNode ( String  name  )  throws nAdminIllegalArgumentException

Given a name of the form /container1/container2/name this function will try to locate the name object locally and return it, or null if that object can not be found.

This method will not wait for the server to update our local state so if a node is created in one session and this method is called immediately after in another session, the local state may not be up to date and therefore the node may not be found. Optionally you can call findNode(name,true) to force the method to wait for a maximum of 5 seconds for the local state to update.

Parameters:
name the name of the node to locate as a String
Returns:
a nNode which could be a nRealmNode, nLeafNode or a nContainer
Exceptions:
nAdminIllegalArgumentException thrown if null is passed as the nNode
See also:
nRealmNode

nLeafNode

nContainer

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

nACL com.pcbsys.nirvana.nAdminAPI.nRealmNode.getACLs (  )  throws nBaseAdminException

Retrieves the current realms ACL so that the user can add/remove/modify the entries within.

This nACL contains nRealmACLEntry objects.

Returns:
nACL containing nRealmACLEntry obejcts
Exceptions:
nBaseAdminException if the user is not permitted to access these lists, check the message for more information
See also:
nRealmACLEntry

static boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.getAsyncUpdateFlag (  )  [static]

Return whether realm node will receive asynchronous updates from the server.

Returns:
whether asynchronous updates will be received

long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getBuffersCreated (  ) 

Number of data buffers created within the realms and for use within event fanout.

Returns:
the number of buffers created
Since:
4.0

long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getBuffersReused (  ) 

Number of data buffers reused by the event fanout.

Returns:
number of reused buffers
Since:
4.0

nClusterNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.getCluster (  ) 

Return the cluster node if one exists, i.e.

if this realm is part of a cluster

Returns:
the cluster node for thsi realm, otherwise null

nConfigGroup com.pcbsys.nirvana.nAdminAPI.nRealmNode.getConfigGroup ( String  name  ) 

Returns the nConfigGroup specified by the name.

Parameters:
name the name of the config group to locate
Returns:
nConfigGroup of the specified name

Enumeration com.pcbsys.nirvana.nAdminAPI.nRealmNode.getConfigGroups (  ) 

Returns a Enumeration containing nConfigGroup objects.

Returns:
java.util.Enumeration of nConfigGroup

int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getConfigGroupsLength (  ) 

Return the number of configuration groups defined in the realm.

Returns:
nConfigGroup objects within the realm

int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getCurrentConnections (  ) 

Returns the number of connections on this realm.

Returns:
int number of clients connected

nDataGroupListener com.pcbsys.nirvana.nAdminAPI.nRealmNode.getDataGroupListener (  ) 

Get the default data group listener.

Returns:
the data group listener

nDataGroupNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.getDefaultDataGroup (  ) 

Get the default data group node.

Returns:
the default data group node

long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getFreeMemory (  ) 

Returns the amount of free memory the Realm Server has within the JVM.

This indicates the difference between what the JVM has currently allocated and what the Realm Server has used. The JVM may increase its memory usage if the free memory falls below a set threshold depending on the JVM parameters passed during the realm server startup script.

Returns:
Long value of bytes

nInterfaceManager com.pcbsys.nirvana.nAdminAPI.nRealmNode.getInterfaceManager (  ) 

Returns the Realms Interface Manager.

Returns:
The com.pcbsys.nirvana.nAdminAPI.nInterfaceManager object
See also:
com.pcbsys.nirvana.nAdminAPI.nInterfaceManager

long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getInternalSchedulerSize (  ) 

Return the total number of scheduled tasks currently running within the realm.

Returns:
the number of tasks within the realm
Since:
4.0

int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getNoOfChannels (  ) 

Return the number of channels within the realm.

Returns:
Channels within the realm

int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getNoOfQueues (  ) 

Return the number of queues within the realm.

Returns:
Queues within the realm

long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getNoOfThreads (  ) 

Return the number of thread the JVM has allocated for the Realm Server.

This includes all the threads used by the JVM as well.

Returns:
Number of threads

int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getQueuedThreads (  ) 

Number of threads currently queued ready to execute tasks.

Returns:
number of queued threads
Since:
4.0

com.pcbsys.nirvana.client.nRealm com.pcbsys.nirvana.nAdminAPI.nRealmNode.getRealm (  ) 

Returns the nRealm object for this RealmNode.

Returns:
The com.pcbsys.nirvana.client.nRealm object
See also:
com.pcbsys.nirvana.client.nRealm

Vector com.pcbsys.nirvana.nAdminAPI.nRealmNode.getRealmList (  ) 

Method to return a vector of known realms.

Returns:
Vector of all realms known by this realm

nThreadEntry [] com.pcbsys.nirvana.nAdminAPI.nRealmNode.getRealmScheduledThreadList (  ) 

Sends a request to the Realm Server to produce a Thread dump.

Returns:
list of Thread Entries that the server will execute at the specified time

int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getReUsedThreads (  ) 

Return the number of reused threads within the realm.

Returns:
the number of reused threads within the realm
Since:
4.0

nSchedulerManager com.pcbsys.nirvana.nAdminAPI.nRealmNode.getSchedulerManager (  ) 

Obtain the scheduler manager associated with this realm node.

Returns:
the nSchedulerManager object for this realm

Date com.pcbsys.nirvana.nAdminAPI.nRealmNode.getServerTime (  ) 

Returns the last status update date that the server sent.

Returns:
Server Date

Vector com.pcbsys.nirvana.nAdminAPI.nRealmNode.getServicesList (  ) 

Method to return a Vector of all p2p service nodes (nServiceNode) from this realm.

Returns:
Vector of nServiceNode objects representing p2p services

nSession com.pcbsys.nirvana.nAdminAPI.nRealmNode.getSession (  ) 

Returns the nSession object for this RealmNode.

Returns:
The com.pcbsys.nirvana.client.nSession object
See also:
com.pcbsys.nirvana.client.nSession

Date com.pcbsys.nirvana.nAdminAPI.nRealmNode.getStartTime (  ) 

Returns the Date that the realm server was started.

Returns:
Date of realm start

Vector com.pcbsys.nirvana.nAdminAPI.nRealmNode.getThreadPoolDetails (  ) 

Return a Vector of nThreadPool objects that represent the different thread pools deployed within the realm.

Returns:
Vector of nThreadPool objects
Since:
4.0

long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getTotalConnections (  ) 

Total number of connections served by this realm from the time it started.

Returns:
long count

long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getTotalMemory (  ) 

Returns the total number of bytes that the JVM has allocated from the unerlying OS.

This number may move depending on the Realm Server startup parameters.

Returns:
long byte count

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

Returns the total number of events published on this realm from the time it has started.

Returns:
lone event count

long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getTotalSubscribed (  ) 

Returns the total number of events that this realm has sent to clients from the time it started.

Returns:
Number if events sent to clients

long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getUpdateInterval (  ) 

Returns the update interval for status updates.

Returns:
a long representing the number of milliseconds between each update

int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getVendedThreads (  ) 

Get the total number of threads that have been allocated threads within the realm.

Returns:
the total number of threads allocated
Since:
4.0

boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.hasConnectionListener (  ) 

Checks if there is a connection listener object associated with the realm.

Returns:
true if connection listener has been set
See also:
nConnectionListener

boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.isAnEmbeddedServer (  ) 

If the realm is running within an application then this will be set to true.

Returns:
true if the realm is running as an embedded server

boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.isAuthorised (  ) 

This function returns true if the user is authorised for admininstration functions on the remote realm.

If the user is not authorised then this will return false and any functions performed against the realm will result in a nSecurityException

Returns:
boolean True if the user is authorised

boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.isClustered (  ) 

Returns the current cluster membership state of this realm.

Returns:
true if the node is a member of a cluster
Since:
5.1

boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.isConnected (  ) 

This method returns true if the connection to the remote realm is still valid.

Returns:
boolean current state

boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.isEntireNamespaceComplete (  ) 

This method returns true when the namespace discovery process is complete for the entire namespace from this node down.

Please refer to the isNamespaceComplete() function

Returns:
boolean

boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.isNamespaceComplete (  ) 

This method returns true when the namespace discovery process is complete.

Since the process of walking the entire namespace is asynchronous this method is useful to find out it the namespace is complete for this Realm. If this Realm contains other Realms then you need to call this function on subsequent Realms to see if the namespace is complete for them.

Alternative, you could add a listener to this object and you will be notified when new nRealmNodes are added to this object.

Returns:
boolean if the name space has been completed

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.modRealmACLEntries ( nACL  entry  )  throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException

modifies a specific acl entry's permissions in the realm acl.

Parameters:
entry An nACL entry containing the subject and permissions to modify in the realm node
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.nRealmNode.modRealmACLEntry ( nACLEntry  entry  )  throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException

modifies a specific acl entry's permissions in the realm acl.

Parameters:
entry An nACL entry containing the subject and permissions to modify in the realm node
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.nRealmNode.onMessage ( nConsumeEvent  evt  ) 

Called when an event has been published to a data group that the client is a member of.

Parameters:
evt an event published for this stream

Implements com.pcbsys.nirvana.client.nDataStreamListener.

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.remove ( final boolean  removeChildren  )  throws nUnsupportedRemoveException, nNodeException

This method enables the removal of the object from the namespace, in this case a RealmNode from the namespace.

If you specify true, all child nodes, including channels, queues and services will also be removed from the realm before removing it from its parent

Parameters:
removeChildren a boolean specifying whether siblings should be removed too
Exceptions:
nUnsupportedRemoveException thrown if remove is not supported (e.g. on the namespace root Realm)
nNodeException is thrown if an error occurs in the remove operation
See also:
nLeafNode

nLinkNode

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.removeConnection ( final String  connectionId,
final boolean  sendRedirection 
) throws nBaseAdminException

This method will cause the server to disconnect the connection described by the connection ID.

The default behaviour of the client is to reconnect so calling this alone will basically bounce the client. If your intent is to disable the remote user, you must first disable the user from the realm and then call this function.

Parameters:
connectionId The connectionId to disconnect
sendRedirection Tells the server to send a Server Redirection event to this client
Exceptions:
nBaseAdminException If the user is not authorized for this function, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.removeConnection ( final String  connectionId  )  throws nBaseAdminException

This method will cause the server to disconnect the connection described by the connection ID.

The default behaviour of the client is to reconnect so calling this alone will basically bounce the client. If your intent is to disable the remote user, you must first disable the user from the realm and then call this function.

Parameters:
connectionId The connectionId to disconnect
Exceptions:
nBaseAdminException If the user is not authorized for this function, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.removeRealmACLEntries ( nACL  entry  )  throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException

removes a specific acl entry from the realm acl.

Parameters:
entry An nACL entry containing the subject and permissions to remove from the realm 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.nRealmNode.removeRealmACLEntry ( nACLEntry  entry  )  throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException

removes a specific acl entry from the realm acl.

Parameters:
entry An nACL entry containing the subject and permissions to remove from the realm 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.nRealmNode.rollAuditFile (  )  throws nBaseAdminException

This will cause the realm server to close the current audit log, rename it to the current date and start a new audit log.

Exceptions:
nBaseAdminException If the user is not authorized for this function, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.setACLs ( final nACL  acl  )  throws nInsufficientPrivilegesException, nBaseAdminException

Commits the ACL passed in with the Realm Server.

This causes these ACLs to be active once the function returns. The nACL object can be retrieved by calling the getACLs() function which returns the realms current list.

Parameters:
acl A nACL containing nRealmACLEntry
Exceptions:
nInsufficientPrivilegesException If the user is not permissioned to perform this operation
nNodeException If the acls being set are invalid
nBaseAdminException If unable to successfully perform this operation, check the message for more information

static void com.pcbsys.nirvana.nAdminAPI.nRealmNode.setAsyncUpdateFlag ( boolean  flag  )  [static]

Flag indicating whether the realm node will receive asynchronous updates from the server.

Parameters:
flag inidcating whether asynchronous updates will be received

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.waitForEntireNameSpace (  ) 

This method will block the calling thread until all of the namespace has been resolved.

This could take some time depending on the number of realms within the namespace.

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.waitForEntireNameSpace ( final long  timeout  )  throws Exception

This method will block the calling thread until all of the namespace has been resolved.

This could take some time depending on the number of realms within the namespace.

Parameters:
timeout milliseconds to wait for the namespace to be discovered
Exceptions:
Exception if unable to complete the namespace within the time specified

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.waitForNameSpace (  ) 

This method will block the calling thread until the namespace discovery is complete for this node.

If the discovery is already complete the method will return immediatly.

void com.pcbsys.nirvana.nAdminAPI.nRealmNode.waitForNameSpace ( final long  timeout  )  throws Exception

This method will block the calling thread until the namespace discovery is complete for this node or the supplied timeout, in milliseconds, is reached.

If the discovery is already complete the method will return immediatly.

Parameters:
timeout milliseconds to wait for the namespace to be discovered
Exceptions:
Exception If the name space is not completed with in the time specified