This class represents a Realm within the Nirvana namespace. More...
Public Member Functions | |
| virtual void | addAuditListener (nAuditListener listener) |
| This will register the nAuditListener for all audit events from this realm. More... | |
| virtual void | addAuditListener (nAuditListener listener, bool replay) |
| This will register the nAuditListener for all audit events from this realm. More... | |
| virtual void | addConnectionListener (nConnectionListener listener) |
| 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. More... | |
| virtual void | addConnectionListenerToAllLeafNodes (nConnectionListener listener) |
| Registers a nConnectionListener to each nLeaNode of the nRealmNode. More... | |
| virtual void | addLogListener (nLogListener listener) |
| This will register the nLogListener for all log events from this realm. More... | |
| virtual void | addPluginAccessListener (nLogListener listener) |
| This will register the nLogListener for all Access events from the plugin manager. More... | |
| virtual void | addPluginErrorListener (nLogListener listener) |
| This will register the nLogListener for all error events from the plugin manager. More... | |
| virtual void | addPluginLogListener (nLogListener listener) |
| This will register the nLogListener for all events from the plugin manager. More... | |
| void | addRealmACLEntries (nACL entry) |
| Adds list of acl entries to the realm acl More... | |
| virtual void | addRealmACLEntry (nACLEntry entry) |
| Adds a specific acl entry to the realm acl More... | |
| virtual void | changeStatusChannel (int type, long age, int capacity) |
| This will cause the realm server to close the current status file, delete it and recreate the file using the attributes specified. More... | |
| virtual void | changeTransactionChannel (int type, long age, int capacity) |
| This will cause the realm server to close the current transaction file, delete it and recreate the file using the attributes specified. More... | |
| virtual void | close () |
| Closes the session with the remote Realm and all realms from this point in the namespace. More... | |
| virtual void | commitConfig (nConfigGroup changedGroup) |
| Calling this function with causes all changes within the group to be committed on the realm and activated. More... | |
| virtual nLeafNode | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr) |
| Creates a new channel on the realm this session is connected. More... | |
| virtual nLeafNode | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr, nLeafNode dead) |
| Creates a new channel on the realm this session is connected. More... | |
| virtual nLeafNode | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr, long p_initialEID) |
| Creates a new channel on the realm this session is connected. More... | |
| virtual nLeafNode | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr, long p_initialEID, nLeafNode dead) |
| Creates a new channel on the realm this session is connected. More... | |
| virtual nLeafNode | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr, long p_initialEID, nACL initialACL) |
| Creates a new channel on the realm this session is connected. More... | |
| virtual nLeafNode | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr, long p_initialEID, nACL initialACL, nLeafNode dead) |
| Creates a new channel on the realm this session is connected. More... | |
| virtual nLeafNode | createQueue (com.pcbsys.nirvana.client.nChannelAttributes attr) |
| Creates a new queue on the realm this session is connected. More... | |
| virtual nLeafNode | createQueue (com.pcbsys.nirvana.client.nChannelAttributes attr, nACL initialACL) |
| Creates a new queue on the realm this session is connected. More... | |
| virtual nLeafNode | createQueue (com.pcbsys.nirvana.client.nChannelAttributes attr, nLeafNode dead) |
| Creates a new queue on the realm this session is connected. More... | |
| virtual nLeafNode | createQueue (com.pcbsys.nirvana.client.nChannelAttributes attr, nACL initialACL, nLeafNode dead) |
| Creates a new queue on the realm this session is connected. More... | |
| virtual void | delAuditListener (nAuditListener listener) |
| This will remove the audit listener from receiving future audit events. More... | |
| virtual void | delConnectionListener (nConnectionListener listener) |
| Removes the registered listener from the realm so no further callbacks are made to the listener. More... | |
| virtual void | delLeafNode (nLeafNode node) |
| Removes the specified channel/queue from the server More... | |
| virtual void | delLogListener (nLogListener listener) |
| This will remove the log listener from receiving future log events More... | |
| virtual void | delPluginAccessListener (nLogListener listener) |
| This will remove the log listener from receiving future log events More... | |
| virtual void | delPluginErrorListener (nLogListener listener) |
| This will remove the log listener from receiving future log events More... | |
| virtual void | delPluginLogListener (nLogListener listener) |
| This will remove the log listener from receiving future log events More... | |
| virtual nConfigGroup | findConfigGroup (string groupName) |
| Finds a configuration group by the name specified by the String argument More... | |
| override nNode | findNode (string name) |
| 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. More... | |
| nNode | findNode (string name, bool flag) |
| Given a name of the form /container/container/name this function will locate the name object and More... | |
| virtual List< fAclGroup > | getACLGroups () |
| * Retrieves the current realms ACL so that the user can add/remove/modify the entries within. More... | |
| virtual nACL | getACLs () |
| Removes the specified nScheduler node from the server More... | |
| virtual long | getBuffersCreated () |
| Number of data buffers created within the realms and for use within event fanout More... | |
| virtual long | getBuffersReused () |
| Number of data buffers reused by the event fanout More... | |
| virtual nClusterNode | getCluster () |
| Return the cluster node if one exists, i.e. More... | |
| virtual nConfigGroup | getConfigGroup (string name) |
| Returns the nConfigGroup specified by the name More... | |
| virtual IEnumerator | getConfigGroups () |
| Returns an IEnumerator containing nConfigGroup objects More... | |
| virtual int | getConfigGroupsLength () |
| Returns the size of the nConfigGroup, i.e. More... | |
| virtual int | getCurrentConnections () |
| Returns the number of connections on this realm More... | |
| nDataGroupListener | getDataGroupListener () |
| summary>Get the default data group listener More... | |
| nDataGroupsContainer | getDataGroups () |
| Provides a collection of all datagroups created on this realm More... | |
| nDataGroupNode | getDefaultDataGroup () |
| summary>Get the default data group node More... | |
| long | getFanoutBacklog () |
| Returns the number of events waiting to be processed by the fanout engine More... | |
| virtual long | getFreeMemory () |
| Returns the amount of free memory the Realm Server has within the JVM. More... | |
| virtual nInterfaceManager | getInterfaceManager () |
| Returns the Realms Interface Manager More... | |
| virtual long | getInternalSchedulerSize () |
| Return the total number of scheduled tasks currently running within the realm More... | |
| nMulticastManager | getMulticastManager () |
| Returns the Realms Interface Manager More... | |
| virtual int | getNoOfChannels () |
| Return the number of channels in the Realm Server. More... | |
| virtual int | getNoOfQueues () |
| Return the number of queues in the Realm Server. More... | |
| virtual long | getNoOfThreads () |
| Return the number of thread the JVM has allocated for the Realm Server. More... | |
| virtual int | getQueuedThreads () |
| Number of threads currently queued ready to execute tasks More... | |
| virtual com.pcbsys.nirvana.client.nRealm | getRealm () |
| Returns the nRealm object for this RealmNode More... | |
| virtual ArrayList | getRealmList () |
| Method to return an ArrayList of known realms More... | |
| virtual nThreadEntry[] | getRealmScheduledThreadList () |
| Sends a request to the Realm Server to produce a Thread dump. More... | |
| nRemoteInterestManager | getRemoteInterestManager () |
| The remote interest manager is an object that allows the user to control propagation of messages between realms. More... | |
| virtual int | getReUsedThreads () |
| Return the number of reused threads within the realm More... | |
| virtual nSecurityGroupManager | getSecurityGroupManager () |
| Return the securityGroupManager object for this realm More... | |
| virtual DateTime | getServerTime () |
| Returns the last status update date that the server sent More... | |
| virtual nSession | getSession () |
| Returns the nSession object for this RealmNode More... | |
| virtual DateTime | getStartTime () |
| Returns the Date that the realm server was started More... | |
| virtual ArrayList | getThreadPoolDetails () |
| Return an ArrayList of nThreadPool objects that represent the different thread pools deployed within the realm. More... | |
| virtual long | getTotalConnections () |
| Total number of connections served by this realm from the time it started More... | |
| long | getTotalGCCount () |
| Return the total number of GCs that the JVM has performed since the realm has started More... | |
| long | getTotalGCTime () |
| Returns the total time in milliseconds that the JVM jas spent doing GCs More... | |
| virtual long | getTotalMemory () |
| Returns the total number of bytes that the JVM has allocated from the unerlying OS. More... | |
| virtual long | getTotalPublished () |
| Returns the total number of events published on this realm from the time it has started More... | |
| virtual long | getTotalSubscribed () |
| Returns the total number of events that this realm has sent to clients from the time it started More... | |
| virtual long | getUpdateInterval () |
| Returns the update interval for status updates More... | |
| virtual int | getVendedThreads () |
| Get the total number of threads that have been allocated threads within the realm More... | |
| virtual nZoneManager | getZoneManager () |
| Return the Zone Manager object for this realm More... | |
| virtual bool | hasConnectionListener () |
| Checks if there is a connection listener object associated with the realm. More... | |
| virtual bool | isAnEmbeddedServer () |
| If the realm is running within an application then this will be set to true More... | |
| virtual bool | isAuthorised () |
| This function returns true if the user is authorised for admininstration functions on the remote realm. More... | |
| bool | isClustered () |
| Returns the current cluster membership state of this realm More... | |
| virtual bool | isConnected () |
| This method returns true if the connection to the remote realm is still valid More... | |
| virtual bool | isEntireNamespaceComplete () |
| This method returns true when the namespace discovery process is complete for the entire namespace from this node down. More... | |
| virtual bool | isNamespaceComplete () |
| This method returns true when the namespace discovery process is complete. More... | |
| void | modRealmACLEntries (nACL entry) |
| modifies a list of acl entries permissions in the realm acl. More... | |
| virtual void | modRealmACLEntry (nACLEntry entry) |
| modifies a specific acl entry's permissions in the realm acl. More... | |
| nRealmNode (nSessionAttributes sAttr) | |
| Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function More... | |
| nRealmNode (nSessionAttributes sAttr, NetworkCredential creds) | |
| Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function More... | |
| nRealmNode (nSessionAttributes sAttr, string username, SecureString password=null) | |
| Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function More... | |
| void | onMessage (nConsumeEvent evt) |
| This method is for internal use only More... | |
| virtual void | releaseCachedMemory () |
| Sends a request to the Realm Server to release cached memory. More... | |
| virtual void | remove (bool removeChildren) |
| This method enables the removal of the object from the namespace, in this case a RealmNode from the namespace. More... | |
| virtual void | removeConnection (string connectionId) |
| This method will cause the server to disconnect the connection described by the connection ID. More... | |
| virtual void | removeConnection (string connectionId, bool sendRedirection) |
| This method will cause the server to disconnect the connection described by the connection ID. More... | |
| void | removeRealmACLEntries (nACL entry) |
| removes a list of acl entries from the realm acl. More... | |
| virtual void | removeRealmACLEntry (nACLEntry entry) |
| removes a specific acl entry from the realm acl. More... | |
| virtual void | requestThreadDump () |
| Sends a request to the Realm Server to produce a Thread dump. More... | |
| virtual void | rollAuditFile () |
| This will cause the realm server to close the current audit log, rename it to the current date and start a new audit log More... | |
| void | rollLogFile () |
| Rolls the servers log file More... | |
| virtual void | setACLs (nACL acl) |
| Commits the ACL passed in with the Realm Server. More... | |
| virtual void | waitForEntireNameSpace (long timeout) |
| This method will block the calling thread until all of the namespace has been resolved. More... | |
| virtual void | waitForEntireNameSpace () |
| This method will block the calling thread until all of the namespace has been resolved. More... | |
| virtual void | waitForNameSpace (long timeout) |
| This method will block the calling thread until the namespace discovery is complete for this node or the supplied timeout, in milliseconds, is reached. More... | |
| virtual void | waitForNameSpace () |
| This method will block the calling thread until the namespace discovery is complete for this node. More... | |
 Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nContainer | |
| void | addACLEntries (nACL acl) |
| Adds a list of acl entry to all known nodes within the nContainer node. More... | |
| void | addACLEntries (nACL acl, nNode[] nodes) |
| Adds a list acl entry to all nodes contained with in the array of nNodes More... | |
| virtual void | addACLEntry (nACLEntry entry) |
| Adds a specific acl entry to all known nodes within the nContainer node. More... | |
| virtual void | addACLEntry (nACLEntry entry, bool allChannels, bool allQueues, bool allServices) |
| Adds a specific acl entry to all known nodes within the nContainer node. More... | |
| virtual void | closed (nRealmNode node) |
| Called when the nRealmNode is closed, for internal use only. More... | |
| virtual nNode | findNode (nNode node) |
| Given a name of the form /container/container/name this function will locate the nNode object and return it, or null if that can not be found. More... | |
| virtual nNode | findNode (nNode node, bool searchChildren) |
| Given a name of the form /container/container/name this function will locate the name object and return it, or null if that can not be found. More... | |
| nNode | getNextSibling () |
| Method to return the next sibling from this node's parent More... | |
| virtual nNode | getNextSibling (int idx) |
| Returns the sibling at position idx from this nodes parent. More... | |
| virtual System.Collections.IEnumerator | getNodes () |
| Returns an IEnumerator of all the nodes under this container. More... | |
| virtual nRealmNode | getRealmAt (string name) |
| Given a mount point this function will return a realm if one exists at the specified mount point More... | |
| nRealmNode | getRealmNode () |
| Get method for the realm node which acts as a container for this object More... | |
| virtual int | getSize () |
| Returns the number of nodes under this container. More... | |
| virtual int | getTotalNodes () |
| Returns the total number of nodes within this container and all subsequent children by traversing the entire structure beneath this container node More... | |
| virtual bool | hasRealmAt (string name) |
| Given a mount point this function will determine if this container contains a mounted realm at the specified mount point More... | |
| void | modACLEntries (nACL acl) |
| Modifies a list of acl entry to all known nodes within the nContainer node. More... | |
| void | modACLEntries (nACL acl, nNode[] nodes) |
| Modifies a list of acl entry to all nodes contained with in the array of nNodes More... | |
| virtual void | modACLEntry (nACLEntry entry) |
| modifies a specific acl entry's permissions for all known nodes within the nContainer node. More... | |
| virtual void | modACLEntry (nACLEntry entry, bool allChannels, bool allQueues, bool allServices) |
| modifies a specific acl entry's permissions for all known nodes within the nContainer node. More... | |
| void | removeACLEntries (nACL acl) |
| Removes a list of acl entries from all known nodes within the nContainer node. More... | |
| void | removeACLEntries (nACL acl, nNode[] nodes) |
| Removes a list of acl entries from all nodes contained with in the array of nNodes More... | |
| virtual void | removeACLEntry (nACLEntry entry) |
| removes a specific acl entry from all known nodes within the nContainer node. More... | |
| virtual void | removeACLEntry (nACLEntry entry, bool allChannels, bool allQueues, bool allServices) |
| removes a specific acl entry from all known nodes within the nContainer node. More... | |
| virtual void | setACL (nACL acl) |
| Replaces the existing ACL with the nACL supplied to all known nodes within the nContainer node. More... | |
| virtual void | setACL (nACL acl, bool allChannels, bool allQueues, bool allServices) |
| Replaces the existing ACL with the nACL supplied to all known nodes within the nContainer node. More... | |
| Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nNode | |
| 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... | |
| Public Member Functions inherited from com.pcbsys.nirvana.client.Observable | |
| void | addObserver (IObserver o) |
| Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. More... | |
| int | countObservers () |
Returns the number of observers of this Observable object. More... | |
| void | deleteObserver (IObserver o) |
| Deletes an observer from the set of observers of this object. More... | |
| void | deleteObservers () |
| Clears the observer list so that this object no longer has any observers. More... | |
| bool | hasChanged () |
| Tests if this object has changed. More... | |
| void | notifyObservers () |
If this object has changed, as indicated by the hasChanged method, then notify all of its observers and then call the clearChanged method to indicate that this object has no longer changed. More... | |
| void | notifyObservers (Object arg) |
| If this object has changed, as indicated by the More... | |
| Observable () | |
| Construct an Observable with zero Observers. More... | |
Static Public Member Functions | |
| static nACL | createACL () |
| Return a new nACL object More... | |
| static bool | getAsyncUpdateFlag () |
| Return whether realm node will receive asynchronous updates from the server. More... | |
| static void | setAsyncUpdateFlag (bool flag) |
| Flag indicating whether the realm node will receive asynchronous updates from the server. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from com.pcbsys.nirvana.client.Observable | |
| void | clearChanged () |
Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the hasChanged method will now return false. More... | |
| void | setChanged () |
Marks this Observable object as having been changed; the hasChanged method will now return true. More... | |
| Properties inherited from com.pcbsys.nirvana.nAdminAPI.nNode | |
| virtual string | Name [get] |
| Returns the generic name of this node within the namespace More... | |
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.
| com.pcbsys.nirvana.nAdminAPI.nRealmNode.nRealmNode | ( | nSessionAttributes | sAttr | ) |
Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function
| sAttr | nSessionAttributes representing the realm you wish to communicate with |
| nBaseAdminException | If the user is not authorised for admin functions |
| com.pcbsys.nirvana.nAdminAPI.nRealmNode.nRealmNode | ( | nSessionAttributes | sAttr, |
| NetworkCredential | creds | ||
| ) |
Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function
| sAttr | nSessionAttributes representing the realm you wish to communicate with |
| creds | Credentials to use to login to the server |
| nBaseAdminException | If the user is not authorised for admin functions |
| com.pcbsys.nirvana.nAdminAPI.nRealmNode.nRealmNode | ( | nSessionAttributes | sAttr, |
| string | username, | ||
| SecureString | password = null |
||
| ) |
Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function
| sAttr | nSessionAttributes representing the realm you wish to communicate with |
| username | Username to use to login to the server |
| password | Password to use to login to the server |
| nBaseAdminException | If the user is not authorised for admin functions |
|
virtual |
This will register the nAuditListener for all audit events from this realm.
| listener | The listener object to call when new log events happen |
|
virtual |
This will register the nAuditListener for all audit events from this realm.
| listener | The listener object to call when new log events happen |
| replay | specify true to replay the entire audit contents |
|
virtual |
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.
| listener | The instance of the nConnectionListener to be called when connections are made or disconnected |
| nBaseAdminException | if the user is not permitted to access these lists, check the message for further information |
|
virtual |
Registers a nConnectionListener to each nLeaNode of the nRealmNode.
| listener | The instance of the nConnectionListener to be called when connections are made or disconnected |
| nBaseAdminException | if the user is not permitted to access these lists, check the message for further information |
|
virtual |
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.
| listener | The listener object to call when new log events happen |
|
virtual |
This will register the nLogListener for all Access events from the plugin manager.
| listener | The listener object to call when new log events happen |
|
virtual |
This will register the nLogListener for all error events from the plugin manager.
| listener | The listener object to call when new log events happen |
|
virtual |
This will register the nLogListener for all events from the plugin manager.
| listener | The listener object to call when new log events happen |
| void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addRealmACLEntries | ( | nACL | entry | ) |
Adds list of acl entries to the realm acl
| entry | An nACL object containing the subject and permissions to add to the realm 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 |
|
virtual |
Adds a specific acl entry to the realm acl
| entry | An nACL entry containing the subject and permissions to add to the realm 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 |
|
virtual |
This will cause the realm server to close the current status file, delete it and recreate the file using the attributes specified.
| 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) |
| nBaseAdminException | If the user is not authorized for this function, check the message for further information |
|
virtual |
This will cause the realm server to close the current transaction file, delete it and recreate the file using the attributes specified.
| 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) |
| nBaseAdminException | If the user is not authorized for this function, check the message for further information |
|
virtual |
Closes the session with the remote Realm and all realms from this point in the namespace.
|
virtual |
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.
| changedGroup | The nConfigGroup containing the changed nConfigEntry |
| nConfigurationException | If the user is not authorized for this function, Check the message for more information |
|
static |
|
virtual |
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.
| attr | The channel attributes object containing the parameters for the new channel to be created |
| 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 |
|
virtual |
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.
| 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 |
| 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 |
|
virtual |
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.
| 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 |
| 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 |
|
virtual |
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.
| 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 |
| 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 |
|
virtual |
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.
| 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 |
| 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 |
|
virtual |
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.
| 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 |
| 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 |
|
virtual |
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.
| attr | The queue attributes object containing the parameters for the new queue to be created |
| 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 |
|
virtual |
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.
| 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 |
| 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 |
|
virtual |
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.
| 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 |
| 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 |
|
virtual |
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.
| 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 |
| 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 |
|
virtual |
This will remove the audit listener from receiving future audit events.
| listener | The listener object to remove |
|
virtual |
Removes the registered listener from the realm so no further callbacks are made to the listener.
| listener | The listener object to remove |
| nBaseAdminException | if the user is not permitted to access these lists |
|
virtual |
Removes the specified channel/queue from the server
| node | LeafNode to delete |
| 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 |
|
virtual |
This will remove the log listener from receiving future log events
| listener | The listener object to remove |
|
virtual |
This will remove the log listener from receiving future log events
| listener | The listener object to remove |
|
virtual |
This will remove the log listener from receiving future log events
| listener | The listener object to remove |
|
virtual |
This will remove the log listener from receiving future log events
| listener | The listener object to remove |
|
virtual |
Finds a configuration group by the name specified by the String argument
| groupName | Name of the config group to find |
|
virtual |
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.
| name | the name of the node to locate as a String |
| nAdminIllegalArgumentException | thrown if null is passed as the nNode |
Reimplemented from com.pcbsys.nirvana.nAdminAPI.nContainer.
| nNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.findNode | ( | string | name, |
| bool | flag | ||
| ) |
Given a name of the form /container/container/name this function will locate the name object and
| 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 |
| nAdminIllegalArgumentException | thrown if null is passed as the nNode |
|
virtual |
* Retrieves the current realms ACL so that the user can add/remove/modify the entries within.
| nBaseAdminException | if the user is not permitted to access these lists, check the message for more information |
|
virtual |
Removes the specified nScheduler node from the server
| node | Scheduler to delete |
| nBaseClientException | The command was not successful |
Retrieves the current realms ACL so that the user can add/remove/modify the entries within. This nACL contains nRealmACLEntry objects.
| nBaseAdminException | if the user is not permitted to access these lists, check the message for more information |
|
static |
Return whether realm node will receive asynchronous updates from the server.
|
virtual |
Number of data buffers created within the realms and for use within event fanout
|
virtual |
Number of data buffers reused by the event fanout
|
virtual |
Return the cluster node if one exists, i.e.
if this realm is part of a cluster
|
virtual |
Returns the nConfigGroup specified by the name
| name | the name of the config group to locate |
|
virtual |
Returns an IEnumerator containing nConfigGroup objects
|
virtual |
Returns the size of the nConfigGroup, i.e.
how many nConfigEntry objects
|
virtual |
Returns the number of connections on this realm
| nDataGroupListener com.pcbsys.nirvana.nAdminAPI.nRealmNode.getDataGroupListener | ( | ) |
summary>Get the default data group listener
returns> return the data group listener
| nDataGroupsContainer com.pcbsys.nirvana.nAdminAPI.nRealmNode.getDataGroups | ( | ) |
Provides a collection of all datagroups created on this realm
| nDataGroupNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.getDefaultDataGroup | ( | ) |
summary>Get the default data group node
returns> the default data group node
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getFanoutBacklog | ( | ) |
Returns the number of events waiting to be processed by the fanout engine
|
virtual |
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.
|
virtual |
Returns the Realms Interface Manager
|
virtual |
Return the total number of scheduled tasks currently running within the realm
| nMulticastManager com.pcbsys.nirvana.nAdminAPI.nRealmNode.getMulticastManager | ( | ) |
Returns the Realms Interface Manager
|
virtual |
Return the number of channels in the Realm Server.
|
virtual |
Return the number of queues in the Realm Server.
|
virtual |
Return the number of thread the JVM has allocated for the Realm Server.
This includes all the threads used by the JVM as well.
|
virtual |
Number of threads currently queued ready to execute tasks
|
virtual |
Returns the nRealm object for this RealmNode
|
virtual |
Method to return an ArrayList of known realms
|
virtual |
Sends a request to the Realm Server to produce a Thread dump.
| nRemoteInterestManager com.pcbsys.nirvana.nAdminAPI.nRealmNode.getRemoteInterestManager | ( | ) |
The remote interest manager is an object that allows the user to control propagation of messages between realms.
|
virtual |
Return the number of reused threads within the realm
|
virtual |
Return the securityGroupManager object for this realm
|
virtual |
Returns the last status update date that the server sent
|
virtual |
Returns the nSession object for this RealmNode
|
virtual |
Returns the Date that the realm server was started
|
virtual |
Return an ArrayList of nThreadPool objects that represent the different thread pools deployed within the realm.
|
virtual |
Total number of connections served by this realm from the time it started
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getTotalGCCount | ( | ) |
Return the total number of GCs that the JVM has performed since the realm has started
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getTotalGCTime | ( | ) |
Returns the total time in milliseconds that the JVM jas spent doing GCs
|
virtual |
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.
|
virtual |
Returns the total number of events published on this realm from the time it has started
|
virtual |
Returns the total number of events that this realm has sent to clients from the time it started
|
virtual |
Returns the update interval for status updates
|
virtual |
Get the total number of threads that have been allocated threads within the realm
|
virtual |
Return the Zone Manager object for this realm
|
virtual |
Checks if there is a connection listener object associated with the realm.
|
virtual |
If the realm is running within an application then this will be set to true
|
virtual |
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
| bool com.pcbsys.nirvana.nAdminAPI.nRealmNode.isClustered | ( | ) |
Returns the current cluster membership state of this realm
|
virtual |
This method returns true if the connection to the remote realm is still valid
|
virtual |
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
|
virtual |
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.
| void com.pcbsys.nirvana.nAdminAPI.nRealmNode.modRealmACLEntries | ( | nACL | entry | ) |
modifies a list of acl entries permissions in the realm acl.
| entry | An nACL object containting the subject and permissions to modify in the realm 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 |
modifies a specific acl entry's permissions in the realm acl.
| entry | An nACL entry containing the subject and permissions to modify in the realm 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.nRealmNode.onMessage | ( | nConsumeEvent | evt | ) |
This method is for internal use only
| evt |
|
virtual |
Sends a request to the Realm Server to release cached memory.
|
virtual |
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
| removeChildren | a boolean specifying whether siblings should be removed too |
| 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 |
Implements com.pcbsys.nirvana.nAdminAPI.nRemovable.
|
virtual |
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.
| connectionId | The connectionId to disconnect |
| nBaseAdminException | If the user is not authorized for this function, check the message for further information |
|
virtual |
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.
| connectionId | The connectionId to disconnect |
| sendRedirection | Tells the server to send a Server Redirection event to this client |
| 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 | ) |
removes a list of acl entries from the realm acl.
| entry | An nACL object containing the subject and permissions to remove from the realm 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 |
|
virtual |
removes a specific acl entry from the realm acl.
| entry | An nACL entry containing the subject and permissions to remove from the realm 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 |
|
virtual |
Sends a request to the Realm Server to produce a Thread dump.
|
virtual |
This will cause the realm server to close the current audit log, rename it to the current date and start a new audit log
| nBaseAdminException | If the user is not authorized for this function, check the message for further information |
| void com.pcbsys.nirvana.nAdminAPI.nRealmNode.rollLogFile | ( | ) |
Rolls the servers log file
|
virtual |
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.
| acl | A nACL containing nRealmACLEntry |
| 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 |
Flag indicating whether the realm node will receive asynchronous updates from the server.
| flag | inidcating whether asynchronous updates will be received |
|
virtual |
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.
| timeout | milliseconds to wait for the namespace to be discovered |
| Exception | if unable to complete the namespace within the time specified |
|
virtual |
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.
|
virtual |
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 immediately.
| timeout | milliseconds to wait for the namespace to be discovered |
| Exception | If the name space is not completed with in the time specified |
|
virtual |
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.