- com
- pcbsys
- nirvana
- nAdminAPI
- nRealmNode
This class represents a Realm within the Nirvana namespace. More...
Public Member Functions | |
| synchronized void | addAuditListener (final nAuditListener listener) |
| This will register the nAuditListener for all audit events from this realm. More... | |
| synchronized void | addAuditListener (final nAuditListener listener, final boolean replay) |
| This will register the nAuditListener for all audit events from this realm. More... | |
| 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. More... | |
| void | addConnectionListenerToAllLeafNodes (final nConnectionListener listener) throws nBaseAdminException |
| Registers a nConnectionListener to each nLeaNode of the nRealmNode. More... | |
| synchronized void | addLogListener (final nLogListener listener) |
| This will register the nLogListener for all log events from this realm. More... | |
| synchronized void | addPluginAccessListener (final nLogListener listener) |
| This will register the nLogListener for all Access events from the plugin manager. More... | |
| synchronized void | addPluginErrorListener (final nLogListener listener) |
| This will register the nLogListener for all error events from the plugin manager. More... | |
| synchronized void | addPluginLogListener (final nLogListener listener) |
| This will register the nLogListener for all events from the plugin manager. More... | |
| void | addRealmACLEntries (nACL entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Adds a specific acl entry to the realm acl. More... | |
| void | addRealmACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Adds a specific acl entry to the realm acl. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| synchronized void | delAuditListener (final nAuditListener listener) |
| This will remove the audit listener from receiving future audit events. More... | |
| synchronized void | delConnectionListener (final nConnectionListener listener) throws nBaseAdminException |
| Removes the registered listener from the realm so no further callbacks are made to the listener. More... | |
| void | delLeafNode (final nLeafNode node) throws nUnknownRemoteRealmException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nUnexpectedResponseException, nSessionPausedException, nRequestTimedOutException, nIllegalArgumentException |
| Removes the specified channel/queue from the server. More... | |
| synchronized void | delLogListener (final nLogListener listener) |
| This will remove the log listener from receiving future log events. More... | |
| synchronized void | delPluginAccessListener (final nLogListener listener) |
| This will remove the log listener from receiving future log events. More... | |
| synchronized void | delPluginErrorListener (final nLogListener listener) |
| This will remove the log listener from receiving future log events. More... | |
| synchronized void | delPluginLogListener (final nLogListener listener) |
| This will remove the log listener from receiving future log events. More... | |
| void | delSchedulerNode (final nScheduler node) throws nBaseClientException |
| Removes the specified nScheduler node from the server. More... | |
| NirvanaRealm | exportConfiguration (ImportExportParametersBuilder exportSettings) throws DatatypeConfigurationException, nBaseClientException, nBaseAdminException |
| Export the realm configuration to XML. More... | |
| nConfigGroup | findConfigGroup (final String groupName) |
| Finds a configuration group by the name specified by the String argument. More... | |
| nNode | findDatagroup (String name) |
| Finds the datagroup with the same name as the one specified in the current realm node. More... | |
| 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. More... | |
| 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. More... | |
| Collection< fAclGroup > | getACLGroups () throws nBaseAdminException |
| Retrieves the current realms ACL so that the user can add/remove/modify the entries within. More... | |
| nACL | getACLs () throws nBaseAdminException |
| Retrieves the current realms ACL so that the user can add/remove/modify the entries within. More... | |
| long | getBuffersCreated () |
| Number of data buffers created within the realms and for use within event fanout. More... | |
| long | getBuffersReused () |
| Number of data buffers reused by the event fanout. More... | |
| nClusterNode | getCluster () |
| Return the cluster node if one exists, i.e. More... | |
| nConfigGroup | getConfigGroup (String name) |
| Returns the nConfigGroup specified by the name. More... | |
| Enumeration< SortedObject > | getConfigGroups () |
| Returns a Enumeration containing nConfigGroup objects. More... | |
| int | getConfigGroupsLength () |
| Return the number of configuration groups defined in the realm. More... | |
| double | getCPUUsage () |
| Returns the CPU usage for the realm if the server can access the Beans. More... | |
| int | getCurrentConnections () |
| Returns the number of connections on this realm. More... | |
| nDataGroupListener | getDataGroupListener () |
| Get the default data group listener. More... | |
| nDataGroupsContainer | getDataGroups () |
| Returns the datagroup container of this realm node. More... | |
| nDataGroupNode | getDefaultDataGroup () |
| Get the default data group node. More... | |
| long | getFanoutBacklog () |
| Returns the number of events waiting to be processed by the fanout engine. More... | |
| long | getFreeDirectMemory () |
| Returns the total amount of free direct memory that the server can allocate. More... | |
| long | getFreeMemory () |
| Returns the amount of free memory the Realm Server has within the JVM. More... | |
| double | getHeapPercentage () |
| Returns the percentage of available on-heap memory currently in use. More... | |
| nInterfaceManager | getInterfaceManager () |
| Returns the Realms Interface Manager. More... | |
| long | getInternalSchedulerSize () |
| Return the total number of scheduled tasks currently running within the realm. More... | |
| long | getMaxHeapMemory () |
| Returns the maximum on-heap memory available. More... | |
| nMulticastManager | getMulticastManager () |
| Returns the Realms Multicast Manager. More... | |
| int | getNoOfChannels () |
| Return the number of channels within the realm. More... | |
| int | getNoOfQueues () |
| Return the number of queues within the realm. More... | |
| long | getNoOfThreads () |
| Return the number of thread the JVM has allocated for the Realm Server. More... | |
| int | getQueuedThreads () |
| Number of threads currently queued ready to execute tasks. More... | |
| com.pcbsys.nirvana.client.nRealm | getRealm () |
| Returns the nRealm object for this RealmNode. More... | |
| Vector< nRealmNode > | getRealmList () |
| Method to return a vector of known realms. More... | |
| 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... | |
| int | getReUsedThreads () |
| Return the number of reused threads within the realm. More... | |
| nSchedulerManager | getSchedulerManager () |
| Obtain the scheduler manager associated with this realm node. More... | |
| nSecurityGroupManager | getSecurityGroupManager () |
| Return the securityGroupManager object for this realm. More... | |
| Date | getServerTime () |
| Returns the last status update date that the server sent. More... | |
| nSession | getSession () |
| Returns the nSession object for this RealmNode. More... | |
| Date | getStartTime () |
| Returns the Date that the realm server was started. More... | |
| Vector< nThreadPool > | getThreadPoolDetails () |
| Return a Vector of nThreadPool objects that represent the different thread pools deployed within the realm. More... | |
| long | getTotalConnections () |
| Total number of connections served by this realm from the time it started. More... | |
| long | getTotalDirectMemory () |
| Returns the total allocatable number of bytes that the JVM can use before receiving a Out Of Memory Exception. 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... | |
| long | getTotalMemory () |
| Returns the total number of bytes that the JVM has allocated from the unerlying OS. More... | |
| long | getTotalPublished () |
| Returns the total number of events published on this realm from the time it has started. More... | |
| long | getTotalSubscribed () |
| Returns the total number of events that this realm has sent to clients from the time it started. More... | |
| long | getUpdateInterval () |
| Returns the update interval for status updates. More... | |
| long | getUsedEventMemory () |
| Returns the current memory allocated on the server to store events in memory. More... | |
| int | getVendedThreads () |
| Get the total number of threads that have been allocated threads within the realm. More... | |
| nZoneManager | getZoneManager () |
| Return the Zone Manager object for this realm. More... | |
| boolean | hasConnectionListener () |
| Checks if there is a connection listener object associated with the realm. More... | |
| void | importConfiguration (NirvanaRealm nirvanaRealm, ImportExportParametersBuilder importSettings) throws nSchedulerParseException, nBaseAdminException, nBaseClientException |
| Import a realm configuration. More... | |
| boolean | isAnEmbeddedServer () |
| If the realm is running within an application then this will be set to true. More... | |
| boolean | isAuthorised () |
| This function returns true if the user is authorised for admininstration functions on the remote realm. More... | |
| boolean | isClustered () |
| Returns the current cluster membership state of this realm. More... | |
| boolean | isConnected () |
| This method returns true if the connection to the remote realm is still valid. More... | |
| boolean | isEntireNamespaceComplete () |
| This method returns true when the namespace discovery process is complete for the entire namespace from this node down. More... | |
| boolean | isNamespaceComplete () |
| This method returns true when the namespace discovery process is complete. More... | |
| void | modRealmACLEntries (nACL entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| modifies a specific acl entry's permissions in the realm acl. More... | |
| void | modRealmACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| modifies a specific acl entry's permissions in the realm acl. More... | |
| 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. More... | |
| nRealmNode (final nSessionAttributes sAttr, 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. More... | |
| nRealmNode (final nSessionAttributes sAttr, String username, String passwd) throws nBaseAdminException | |
| Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function. More... | |
| nRealmNode (final nSessionAttributes sAttr, final nNode parent, String user, String passwd) | |
| Do not use this method as it will not create a nRealmNode. More... | |
| 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. More... | |
| void | removeConnection (final String connectionId) throws nBaseAdminException |
| This method will cause the server to disconnect the connection described by the connection ID. More... | |
| 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. More... | |
| void | removeRealmACLEntries (nACL entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| removes a specific acl entry from the realm acl. More... | |
| void | removeRealmACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| removes a specific acl entry from the realm acl. More... | |
| 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. More... | |
| void | rollLogFile () |
| Rolls the servers log file. | |
| void | setACLs (final nACL acl) throws nInsufficientPrivilegesException, nBaseAdminException |
| Commits the ACL passed in with the Realm Server. More... | |
| void | waitForEntireNameSpace (final long timeout) throws Exception |
| This method will block the calling thread until all of the namespace has been resolved. More... | |
| void | waitForEntireNameSpace () |
| This method will block the calling thread until all of the namespace has been resolved. More... | |
| void | waitForJoinInformation (long timeout) throws Exception |
| This method will block the calling thread until join information for all leaf nodes has been fetched from the Realm, this could take some time depending on the number of leaf nodes and joins. More... | |
| void | waitForJoinInformation () |
| This method will block the calling thread until join information for all leaf nodes has been fetched from the Realm, this could take some time depending on the number of leaf nodes and joins. | |
| 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. More... | |
| 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) throws nAdminIllegalArgumentException, nBaseAdminException |
| Adds a list acl entry to all nodes. More... | |
| void | addACLEntries (nACL acl, nNode[] nodes) throws nAdminIllegalArgumentException, nBaseAdminException |
| Adds a list acl entry to all nodes contained with in the array of nNodes. More... | |
| void | addACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Adds a specific acl entry to all known nodes within the nContainer node. More... | |
| void | addACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Adds a specific acl entry to all known nodes within the nContainer node. More... | |
| void | addACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Adds a specific acl entry to all known nodes within the nContainer node. More... | |
| void | addACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices, boolean realm) throws nBaseAdminException |
| Adds a specific acl entry to all known nodes within the nContainer node. More... | |
| void | addACLEntry (boolean realmLevel, nACLEntry entry, boolean allChannels, boolean allQueues) throws nBaseAdminException |
| Adds a specific acl entry to all known nodes within the nContainer node. More... | |
| void | closed (nRealmNode node) |
| Called when the nRealmNode is closed, for internal use only. More... | |
| nNode | findNode (String name) 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. More... | |
| nNode | findNode (nNode node) throws nAdminIllegalArgumentException |
| 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... | |
| nNode | findNode (nNode node, boolean searchChildren) 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 can not be found. More... | |
| nNode | getNextSibling () |
| Method to return the next sibling from this node's parent. More... | |
| Enumeration | getNodes () |
| Returns an Enumeration of all the nodes under this container. More... | |
| nRealmNode | getRealmAt (String name) throws nAdminIllegalArgumentException |
| Given a mount point this function will return a realm if one exists at the specified mount point. More... | |
| nRealmNode | getRealmNode () |
| Get the realm node at the root of this container node. More... | |
| int | getSize () |
| Returns the number of nodes under this container. More... | |
| 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... | |
| boolean | hasRealmAt (String name) throws nAdminIllegalArgumentException |
| 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) throws nAdminIllegalArgumentException, nBaseAdminException |
| Modifies a list of acl entry to all known nodes within the nContainer node. More... | |
| void | modACLEntries (nACL acl, nNode[] nodes) throws nAdminIllegalArgumentException, nBaseAdminException |
| Modifies a list of acl entry to all nodes contained with in the array of nNodes. More... | |
| void | modACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| modifies a specific acl entry's permissions for all known nodes within the nContainer node. More... | |
| void | modACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| modifies a specific acl entry's permissions for all known nodes within the nContainer node. More... | |
| void | modACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| modifies a specific acl entry's permissions for all known nodes within the nContainer node. More... | |
| void | modACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices, boolean realm) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| modifies a specific acl entry's permissions for all known nodes within the nContainer node. More... | |
| void | modACLEntry (boolean realmLevel, nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| modifies a specific acl entry's permissions for all known nodes within the nContainer node. More... | |
| void | removeACLEntries (nACL acl) throws nAdminIllegalArgumentException, nBaseAdminException |
| Removes a list of acl entries from all known nodes within the nContainer node. More... | |
| void | removeACLEntries (nACL acl, nNode[] nodes) throws nAdminIllegalArgumentException, nBaseAdminException |
| Removes a list of acl entries from all nodes contained with in the array of nNodes. More... | |
| void | removeACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| removes a specific acl entry from all known nodes within the nContainer node. More... | |
| void | removeACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| removes a specific acl entry from all known nodes within the nContainer node. More... | |
| void | removeACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| removes a specific acl entry from all known nodes within the nContainer node. More... | |
| void | removeACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices, boolean realm) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Removes a specific acl entry from all known nodes within the nContainer node. More... | |
| void | removeACLEntry (boolean realmLevel, nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Removes a specific acl entry from all known nodes within the nContainer node. More... | |
| void | setACL (nACL acl) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Changes the entire ACL entries for all nodes within this container node. More... | |
| void | setACL (nACL acl, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Changes the entire ACL entries for the selected nodes with the new ACL passed in. More... | |
| void | setACL (nACL acl, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Changes the entire ACL entries for the selected nodes with the new ACL passed in. More... | |
| Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nNode | |
| boolean | equals (long aLong) |
| Needed as part of the SortedObject interface. | |
| synchronized String | getAbsolutePath () |
| This function walks the tree to the root to generate a fully qualified name for this node. More... | |
| String | getName () |
| Returns the generic name of this node within the namespace. More... | |
| nNode | getParent () |
| Returns this nodes parent node. More... | |
| String | getRelativePath (nNode top) throws nAdminIllegalArgumentException |
| This method returns the relative path from this node to the nNode passed. More... | |
| boolean | isMatch (Object item) |
| Compares this object with the passed object. More... | |
| boolean | lessThan (long aLong) |
| Needed as part of the SortedObject interface. | |
| boolean | lessThan (Object item) |
| Compares this object with the passed object. More... | |
| Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nRemovable | |
| void | remove (boolean removeChildren) throws nUnsupportedRemoveException, nNodeException |
| This method enables the removal of the object from the namespace. More... | |
Static Public Member Functions | |
| static nACL | createACL () |
| Return a new nACL object. More... | |
| static boolean | getAsyncUpdateFlag () |
| Return whether realm node will receive asynchronous updates from the server. More... | |
| static void | setAsyncUpdateFlag (boolean flag) |
| Flag indicating whether the realm node will receive asynchronous updates from the server. 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 notify 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 | ( | 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.
If the provided nSessionAttributes contain TLS properties like keystore, truststore, enabled ciphers, etc., the latter will be automatically used by the created nRealmNode when it connects to the other realm servers from the namespace over TLS.
| 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 | ( | final nSessionAttributes | sAttr, |
| 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.
If the provided nSessionAttributes contain TLS properties like keystore, truststore, enabled ciphers, etc., the latter will be automatically used by the created nRealmNode when it connects to the other realm servers from the namespace over TLS.
| sAttr | nSessionAttributes representing the realm you wish to communicate with |
| username | Username to use to login to the server |
| nBaseAdminException | If the user is not authorised for admin functions |
| com.pcbsys.nirvana.nAdminAPI.nRealmNode.nRealmNode | ( | final nSessionAttributes | sAttr, |
| String | username, | ||
| String | passwd | ||
| ) | throws nBaseAdminException |
Constructs a link with the realm server and builds up the realm servers namespace which can be retrieved using the getNameSpace() function.
If the provided nSessionAttributes contain TLS properties like keystore, truststore, enabled ciphers, etc., the latter will be automatically used by the created nRealmNode when it connects to the other realm servers from the namespace over TLS.
| sAttr | nSessionAttributes representing the realm you wish to communicate with |
| username | Username to use to login to the server |
| passwd | Password to use to login to the server |
| nBaseAdminException | If the user is not authorised for admin functions |
| com.pcbsys.nirvana.nAdminAPI.nRealmNode.nRealmNode | ( | final nSessionAttributes | sAttr, |
| final nNode | parent, | ||
| String | user, | ||
| String | passwd | ||
| ) |
| synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addAuditListener | ( | final nAuditListener | listener | ) |
This will register the nAuditListener for all audit events from this realm.
| listener | The listener object to call when new log events happen |
| 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.
| 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.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.
| 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 |
| void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addConnectionListenerToAllLeafNodes | ( | final nConnectionListener | listener | ) | throws nBaseAdminException |
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 |
| 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.
| 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.
| 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.
| 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.
| 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.
| 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 |
| void com.pcbsys.nirvana.nAdminAPI.nRealmNode.addRealmACLEntry | ( | nACLEntry | entry | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
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 |
| 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.
| 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 |
| 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.
| 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 |
| 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.
| changedGroup | The nConfigGroup containing the changed nConfigEntry |
| nConfigurationException | If the user is not authorized for this function, Check the message for more information |
|
static |
| 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.
| 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 |
| 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.
| 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 |
| 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.
| 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 |
| 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.
| 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 |
| 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.
| 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 |
| 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.
| 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 |
| 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.
| 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 |
| 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.
| 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 |
| 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.
| 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 |
| 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.
| 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 |
| synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.delAuditListener | ( | final nAuditListener | listener | ) |
This will remove the audit listener from receiving future audit events.
| 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.
| listener | The listener object to remove |
| nBaseAdminException | if the user is not permitted to access these lists |
| 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.
| 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 |
| synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmNode.delLogListener | ( | final nLogListener | listener | ) |
This will remove the log listener from receiving future log events.
| 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.
| 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.
| 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.
| 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.
| node | Scheduler to delete |
| nBaseClientException | The command was not successful |
| NirvanaRealm com.pcbsys.nirvana.nAdminAPI.nRealmNode.exportConfiguration | ( | ImportExportParametersBuilder | exportSettings | ) | throws DatatypeConfigurationException, nBaseClientException, nBaseAdminException |
Export the realm configuration to XML.
| exportSettings | - the export settings |
| nConfigGroup com.pcbsys.nirvana.nAdminAPI.nRealmNode.findConfigGroup | ( | final String | groupName | ) |
Finds a configuration group by the name specified by the String argument.
| groupName | Name of the config group to find |
| nNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.findDatagroup | ( | String | name | ) |
Finds the datagroup with the same name as the one specified in the current realm node.
| name | String name of the datagroup to find. |
| 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.
| name | the name of the node to locate as a String |
| nAdminIllegalArgumentException | thrown if null is passed as the nNode |
| 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.
| 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 |
| Collection<fAclGroup> com.pcbsys.nirvana.nAdminAPI.nRealmNode.getACLGroups | ( | ) | throws nBaseAdminException |
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 or realm node is in an illegal state. Check the message for more information. |
| 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.
| nBaseAdminException | if the user is not permitted to access these lists or realm node is in an illegal state. Check the message for more information. |
|
static |
Return whether realm node will receive asynchronous updates from the server.
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getBuffersCreated | ( | ) |
Number of data buffers created within the realms and for use within event fanout.
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getBuffersReused | ( | ) |
Number of data buffers reused by the event fanout.
| nClusterNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.getCluster | ( | ) |
Return the cluster node if one exists, i.e.
if this realm is part of a cluster
| nConfigGroup com.pcbsys.nirvana.nAdminAPI.nRealmNode.getConfigGroup | ( | String | name | ) |
Returns the nConfigGroup specified by the name.
| name | the name of the config group to locate |
| Enumeration<SortedObject> com.pcbsys.nirvana.nAdminAPI.nRealmNode.getConfigGroups | ( | ) |
Returns a Enumeration containing nConfigGroup objects.
| int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getConfigGroupsLength | ( | ) |
Return the number of configuration groups defined in the realm.
| double com.pcbsys.nirvana.nAdminAPI.nRealmNode.getCPUUsage | ( | ) |
Returns the CPU usage for the realm if the server can access the Beans.
| int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getCurrentConnections | ( | ) |
Returns the number of connections on this realm.
| nDataGroupListener com.pcbsys.nirvana.nAdminAPI.nRealmNode.getDataGroupListener | ( | ) |
Get the default data group listener.
| nDataGroupsContainer com.pcbsys.nirvana.nAdminAPI.nRealmNode.getDataGroups | ( | ) |
Returns the datagroup container of this realm node.
| nDataGroupNode com.pcbsys.nirvana.nAdminAPI.nRealmNode.getDefaultDataGroup | ( | ) |
Get 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.
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getFreeDirectMemory | ( | ) |
Returns the total amount of free direct memory that the server can allocate.
| 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.
| double com.pcbsys.nirvana.nAdminAPI.nRealmNode.getHeapPercentage | ( | ) |
Returns the percentage of available on-heap memory currently in use.
| nInterfaceManager com.pcbsys.nirvana.nAdminAPI.nRealmNode.getInterfaceManager | ( | ) |
Returns the Realms Interface Manager.
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getInternalSchedulerSize | ( | ) |
Return the total number of scheduled tasks currently running within the realm.
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getMaxHeapMemory | ( | ) |
Returns the maximum on-heap memory available.
| nMulticastManager com.pcbsys.nirvana.nAdminAPI.nRealmNode.getMulticastManager | ( | ) |
Returns the Realms Multicast Manager.
| int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getNoOfChannels | ( | ) |
Return the number of channels within the realm.
| int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getNoOfQueues | ( | ) |
Return the number of 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.
| int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getQueuedThreads | ( | ) |
Number of threads currently queued ready to execute tasks.
| com.pcbsys.nirvana.client.nRealm com.pcbsys.nirvana.nAdminAPI.nRealmNode.getRealm | ( | ) |
Returns the nRealm object for this RealmNode.
| Vector<nRealmNode> com.pcbsys.nirvana.nAdminAPI.nRealmNode.getRealmList | ( | ) |
Method to return a vector of known realms.
| nThreadEntry [] com.pcbsys.nirvana.nAdminAPI.nRealmNode.getRealmScheduledThreadList | ( | ) |
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.
| int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getReUsedThreads | ( | ) |
Return the number of reused threads within the realm.
| nSchedulerManager com.pcbsys.nirvana.nAdminAPI.nRealmNode.getSchedulerManager | ( | ) |
Obtain the scheduler manager associated with this realm node.
| nSecurityGroupManager com.pcbsys.nirvana.nAdminAPI.nRealmNode.getSecurityGroupManager | ( | ) |
Return the securityGroupManager object for this realm.
| Date com.pcbsys.nirvana.nAdminAPI.nRealmNode.getServerTime | ( | ) |
Returns the last status update date that the server sent.
| nSession com.pcbsys.nirvana.nAdminAPI.nRealmNode.getSession | ( | ) |
Returns the nSession object for this RealmNode.
| Date com.pcbsys.nirvana.nAdminAPI.nRealmNode.getStartTime | ( | ) |
Returns the Date that the realm server was started.
| Vector<nThreadPool> com.pcbsys.nirvana.nAdminAPI.nRealmNode.getThreadPoolDetails | ( | ) |
Return a Vector of nThreadPool objects that represent the different thread pools deployed within the realm.
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getTotalConnections | ( | ) |
Total number of connections served by this realm from the time it started.
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getTotalDirectMemory | ( | ) |
Returns the total allocatable number of bytes that the JVM can use before receiving a Out Of Memory Exception.
| 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.
| 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.
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getTotalPublished | ( | ) |
Returns the total number of events published on this realm from the time it has started.
| 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.
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getUpdateInterval | ( | ) |
Returns the update interval for status updates.
| long com.pcbsys.nirvana.nAdminAPI.nRealmNode.getUsedEventMemory | ( | ) |
Returns the current memory allocated on the server to store events in memory.
| int com.pcbsys.nirvana.nAdminAPI.nRealmNode.getVendedThreads | ( | ) |
Get the total number of threads that have been allocated threads within the realm.
| nZoneManager com.pcbsys.nirvana.nAdminAPI.nRealmNode.getZoneManager | ( | ) |
Return the Zone Manager object for this realm.
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.hasConnectionListener | ( | ) |
Checks if there is a connection listener object associated with the realm.
| void com.pcbsys.nirvana.nAdminAPI.nRealmNode.importConfiguration | ( | NirvanaRealm | nirvanaRealm, |
| ImportExportParametersBuilder | importSettings | ||
| ) | throws nSchedulerParseException, nBaseAdminException, nBaseClientException |
Import a realm configuration.
| nirvanaRealm | - the nirvana realm XML to be imported |
| importSettings | - the import settings |
| nClusteredTransientStoreException | - in case there is a clustered transient store in the import and importSettings.doAutoConvert() is false. |
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.isAnEmbeddedServer | ( | ) |
If the realm is running within an application then this will be set to true.
| 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
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.isClustered | ( | ) |
Returns the current cluster membership state of this realm.
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmNode.isConnected | ( | ) |
This method returns true if the connection to the remote realm is still valid.
| 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
| 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.
| void com.pcbsys.nirvana.nAdminAPI.nRealmNode.modRealmACLEntries | ( | nACL | entry | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
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.modRealmACLEntry | ( | nACLEntry | entry | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
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.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 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 |
| 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.
| connectionId | The connectionId to disconnect |
| 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, |
| 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.
| 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 | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
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 |
| void com.pcbsys.nirvana.nAdminAPI.nRealmNode.removeRealmACLEntry | ( | nACLEntry | entry | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
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 |
| 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.
| 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.
| 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 |
| 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.
| timeout | milliseconds to wait for the namespace to be discovered |
| Exception | if unable to complete the namespace within the time specified |
| 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.waitForJoinInformation | ( | long | timeout | ) | throws Exception |
This method will block the calling thread until join information for all leaf nodes has been fetched from the Realm, this could take some time depending on the number of leaf nodes and joins.
| timeout | milliseconds to wait for the join information to be complete |
| Exception | if unable to complete the namespace within the time specified |
| 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 immediately.
| timeout | milliseconds to wait for the namespace to be discovered |
| Exception | If the name space is not completed with in 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.