com.pcbsys.nirvana.nAdminAPI.nLeafNode Class Reference
This class represents the Nirvana Channel or Queue on the Nirvana Realm. More...

Public Member Functions | |
| void | addACLEntries (nACL entries) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Adds a specific acl entry to the leaf node acl. | |
| void | addACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Adds a specific acl entry to the leaf node acl. | |
| void | addListener (nConnectionListener listener) throws nBaseAdminException |
| Registers the listener object with the channel/queue so that whenever a connection is made or lost with the channel such as a subscriber is added the listener is notified of the change in state of the channel. | |
| void | archiveJoin (nNode p_toNode, String p_Selector) throws nUnsupportedJoinException, nBaseAdminException |
| This method enables the joining of the object from one node to another, specifying a selector for filtered joins. | |
| void | closed (nRealmNode node) |
| Called when the nRealmNode is closed, for internal use only. | |
| void | copy (boolean p_waitForComplete, nChannelAttributes p_attr, nACL acl, nCommandStatus cmdStatus) throws nUnsupportedCopyException |
| Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within the same realm node with the specfied channel attributes. | |
| void | copy (nNode p_toNode, boolean p_waitForComplete, nChannelAttributes p_attr, nCommandStatus cmdStatus) throws nUnsupportedCopyException |
| Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within the RealmNode passed as a parameter, with the specfied channel attributes. | |
| void | copy (nNode p_toNode, boolean p_waitForComplete, nChannelAttributes p_attr, nACL acl, nCommandStatus cmdStatus) throws nUnsupportedCopyException |
| Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within the RealmNode passed as a parameter, with the specfied channel attributes. | |
| void | copy (String p_toName, boolean p_waitForComplete, nACL acl, nCommandStatus cmdStatus) throws nUnsupportedCopyException |
| Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within same realm with the specfied channel name. | |
| void | copy (nNode p_toNode, String p_toName, boolean p_waitForComplete, nACL acl, nCommandStatus cmdStatus) throws nUnsupportedCopyException |
| Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within the RealmNode passed as a parameter, with the specfied channel name. | |
| void | deleteJoin (nNode p_toNode) throws nUnsupportedJoinException, nBaseAdminException |
| This method deletes the join between nodes. | |
| void | delListener () throws nBaseAdminException |
| Removes the registered listener from the channel so no further callbacks are made to the listener. | |
| nLeafNode | findDeadEventStore () |
| Returns the dead event store of the eaf node. | |
| void | freeUnusedSpace () throws nBaseClientException |
| Requests that the Realm frees the unused space within this channel/queue. | |
| String | getAbsolutePath () |
| This function walks the tree to the root to generate a fully qualified name for this node. | |
| nACL | getACLs () throws nBaseAdminException |
| Retrieves the channel/queues ACLs which can then be modified and committed with the setACLs() function. | |
| nChannelAttributes | getAttributes () |
| Returns the channel attributes for this channel/queue. | |
| float | getCacheHitRatio () |
| Retreives the channel/queues cache ratio. | |
| float | getConnectionRate () |
| The number of subscriptions made to this store per second. | |
| float | getConsumedRate () |
| The number of events published per second. | |
| long | getCurrentNoOfConnections () |
| Retrieves the current number of connections to this channel. | |
| long | getCurrentNumberOfEvents () |
| Returns the number of events within the channel/queue. | |
| float | getFanoutTime () |
| The total number of milliseconds it takes to fanout each event to all consumers. | |
| Enumeration | getInboundJoins () |
| Returns an enumeration of nJoinDetails objects containing information about channels sending events to this channel. | |
| long | getLastEID () |
| Returns the last EID that was used for the channel/queue. | |
| int | getOutboundJoinCount () |
| Returns a count of outbound joins this channel has. | |
| Enumeration | getOutboundJoins () |
| Returns an enumeration of nJoinDetails objects containing information about channels that this channel will pass events to. | |
| int | getPercentageFreeInStore () |
| Returns the amount of free space within a store as a percentage of the overall space used. | |
| float | getPublishRate () |
| The number of events published per second. | |
| nRealmNode | getRealm () |
| Returns the Realm Node this leaf node is associated with. | |
| long | getTotalConsumed () |
| Returns the total number of events that this channel has delivered to subscribers. | |
| long | getTotalNoOfConnections () |
| Returns the total number of connections that this channel has had since the realm started. | |
| long | getTotalPublished () |
| Returns the total number of events published/pushed to this channel/queue since the realm has started. | |
| long | getUsedSpace () |
| Returns the number of bytes that this channel/queue consumes on the server. | |
| boolean | isChannel () |
| Returns true if this represents a nirvana channel. | |
| boolean | isClusterWide () |
| Returns true if this represents a nirvana channel or queue that is part of a cluster. | |
| boolean | isQueue () |
| Returns true if this represents a nirvana queue. | |
| void | join (nNode p_toNode, String p_Selector) throws nUnsupportedJoinException, nBaseAdminException |
| This method enables the joining of the object from one node to another, specifying a selector for filtered joins. | |
| void | join (nNode p_toNode, boolean p_isRouted, int p_hopcount, String p_Selector, boolean allowPurges) throws nUnsupportedJoinException, nBaseAdminException |
| This method enables the joining of the object from one node to another, specifying a selector, and a maximum hop count for the events. | |
| void | join (nNode p_toNode, boolean p_isRouted, int p_hopcount, String p_Selector) throws nUnsupportedJoinException, nBaseAdminException |
| This method enables the joining of the object from one node to another, specifying a selector, and a maximum hop count for the events. | |
| void | modACLEntries (nACL entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| modifies a specific acl entry's permissions in the leaf node acl. | |
| void | modACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| modifies a specific acl entry's permissions in the leaf node acl. | |
| void | remove (boolean removeChildren) throws nUnsupportedRemoveException, nNodeException |
| This method removes this leafNode (channel or queue) from its parent RealmNode. | |
| void | removeACLEntries (nACL entries) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| removes a specific acl entry from the leaf node acl. | |
| void | removeACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| removes a specific acl entry from the leaf node acl. | |
| void | setACLs (nACL acl) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
| Commits the ACL passed in with the Realm Server. | |
Static Public Member Functions | |
| static nACL | createACL () |
| This method allows you to construct a new nACL object, useful when creating new channels with an initial ACL list. | |
Detailed Description
This class represents the Nirvana Channel or Queue on the Nirvana Realm.The super class is nNode which implements java.util.Observable. When any details change for this object any registered Observers are notified with the change. The status functions may return 0 until the status events are received from the server.
- See also:
- java.util.Observable
Member Function Documentation
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.addACLEntries | ( | nACL | entries | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
Adds a specific acl entry to the leaf node acl.
- Parameters:
-
entries An nACL list containing the subjects and permissions to add to the leaf node acl
- Exceptions:
-
nInsufficientPrivilegesException If the user is not permissioned to perform this operation nNodeException if the ACLs being set are invalid nBaseAdminException if unable to perform the operation, check the message for further information
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.addACLEntry | ( | nACLEntry | entry | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
Adds a specific acl entry to the leaf node acl.
- Parameters:
-
entry An nACL entry containing the subject and permissions to add to the leaf node acl
- Exceptions:
-
nInsufficientPrivilegesException If the user is not permissioned to perform this operation nNodeException if the ACLs being set are invalid nBaseAdminException if unable to perform the operation, check the message for further information
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.addListener | ( | nConnectionListener | listener | ) | throws nBaseAdminException |
Registers the listener object with the channel/queue so that whenever a connection is made or lost with the channel such as a subscriber is added the listener is notified of the change in state of the channel.
Currently only one listener per session is supported.
- Parameters:
-
listener the connection listener to be added to the leaf node (channel or queue)
- Exceptions:
-
nBaseAdminException if the user is not permitted to access these lists, check the message for further information
- See also:
- nConnectionListener
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.archiveJoin | ( | nNode | p_toNode, | |
| String | p_Selector | |||
| ) | throws nUnsupportedJoinException, nBaseAdminException |
This method enables the joining of the object from one node to another, specifying a selector for filtered joins.
- Parameters:
-
p_toNode the nNode object to join this node to p_Selector the filter to be applied to the join
- Exceptions:
-
nUnsupportedJoinException thrown if join is not supported (e.g. on queues) nBaseAdminException is thrown if the join creation fails
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.closed | ( | nRealmNode | node | ) |
Called when the nRealmNode is closed, for internal use only.
- Parameters:
-
node The nRealmNode which has been closed.
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.copy | ( | boolean | p_waitForComplete, | |
| nChannelAttributes | p_attr, | |||
| nACL | acl, | |||
| nCommandStatus | cmdStatus | |||
| ) | throws nUnsupportedCopyException |
Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within the same realm node with the specfied channel attributes.
Attributes can be different on the copied channel, such as ttl, capacity and type
- Parameters:
-
p_waitForComplete Specifies whether the method returns before copy operation has completed p_attr The channel attributes of the new LeafNode acl an optional initial acl object that will be set on the object being copied cmdStatus an optional nCommandStatus object that will inform you of the operation status
- Exceptions:
-
nUnsupportedCopyException Thrown if copy is not supported
Implements com.pcbsys.nirvana.nAdminAPI.nCopyable.
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.copy | ( | nNode | p_toNode, | |
| boolean | p_waitForComplete, | |||
| nChannelAttributes | p_attr, | |||
| nCommandStatus | cmdStatus | |||
| ) | throws nUnsupportedCopyException |
Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within the RealmNode passed as a parameter, with the specfied channel attributes.
Using this method, allows LeafNodes to be copied to other realms within the namespace
Attributes can be different on the copied channel, such as ttl, capacity and type
- Parameters:
-
p_toNode The nRealmNode to copy the channel to p_waitForComplete Specifies whether the method returns before copy operation has completed p_attr The channel attributes of the new LeafNode cmdStatus an optional nCommandStatus object that will inform you of the operation status
- Exceptions:
-
nUnsupportedCopyException Thrown if copy is not supported
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.copy | ( | nNode | p_toNode, | |
| boolean | p_waitForComplete, | |||
| nChannelAttributes | p_attr, | |||
| nACL | acl, | |||
| nCommandStatus | cmdStatus | |||
| ) | throws nUnsupportedCopyException |
Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within the RealmNode passed as a parameter, with the specfied channel attributes.
Using this method, allows LeafNodes to be copied to other realms within the namespace
Attributes can be different on the copied channel, such as ttl, capacity and type
- Parameters:
-
p_toNode The nRealmNode to copy the channel to p_waitForComplete Specifies whether the method returns before copy operation has completed p_attr The channel attributes of the new LeafNode acl an optional initial acl object that will be set on the object being copied cmdStatus an optional nCommandStatus object that will inform you of the operation status
- Exceptions:
-
nUnsupportedCopyException Thrown if copy is not supported
Implements com.pcbsys.nirvana.nAdminAPI.nCopyable.
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.copy | ( | String | p_toName, | |
| boolean | p_waitForComplete, | |||
| nACL | acl, | |||
| nCommandStatus | cmdStatus | |||
| ) | throws nUnsupportedCopyException |
Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within same realm with the specfied channel name.
The channel name used for the new copied LeafNode must be unique in the realm
- Parameters:
-
p_toName The name of the new LeafNode (channel or queue) p_waitForComplete Specifies whether the method returns before copy operation has completed acl an optional initial acl object that will be set on the object being copied cmdStatus an optional nCommandStatus object that will inform you of the operation status
- Exceptions:
-
nUnsupportedCopyException Thrown if copy is not supported
- Deprecated:
- As of version 2.0
Implements com.pcbsys.nirvana.nAdminAPI.nCopyable.
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.copy | ( | nNode | p_toNode, | |
| String | p_toName, | |||
| boolean | p_waitForComplete, | |||
| nACL | acl, | |||
| nCommandStatus | cmdStatus | |||
| ) | throws nUnsupportedCopyException |
Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within the RealmNode passed as a parameter, with the specfied channel name.
Using this method, allows LeafNodes to be copied to other realms within the namespace
The channel name used for the new copied LeafNode must be unique in the destination realm
- Parameters:
-
p_toNode The nRealmNode to copy the channel to p_toName The name of the new LeafNode (channel or queue) p_waitForComplete Specifies whether the method returns before copy operation has completed acl an optional initial acl object that will be set on the object being copied cmdStatus an optional nCommandStatus object that will inform you of the operation status
- Exceptions:
-
nUnsupportedCopyException Thrown if copy is not supported
- Deprecated:
- As of version 2.0
Implements com.pcbsys.nirvana.nAdminAPI.nCopyable.
| static nACL com.pcbsys.nirvana.nAdminAPI.nLeafNode.createACL | ( | ) | [static] |
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.deleteJoin | ( | nNode | p_toNode | ) | throws nUnsupportedJoinException, nBaseAdminException |
This method deletes the join between nodes.
This is only supported where the source node is a channel
- Parameters:
-
p_toNode the nNode object this node is joined to
- Exceptions:
-
nUnsupportedJoinException thrown if join is not supported (e.g. from queues) nBaseAdminException is thrown if the join deletion fails
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.delListener | ( | ) | throws nBaseAdminException |
Removes the registered listener from the channel so no further callbacks are made to the listener.
- Exceptions:
-
nBaseAdminException if the user is not permitted to access these lists
- See also:
- nConnectionListener
| nLeafNode com.pcbsys.nirvana.nAdminAPI.nLeafNode.findDeadEventStore | ( | ) |
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.freeUnusedSpace | ( | ) | throws nBaseClientException |
Requests that the Realm frees the unused space within this channel/queue.
If the Channel/Queue has a large number of events it could take some time to perform. It is recommended to do this during quiet periods.
- Exceptions:
-
nBaseClientException If the user does not have the permission to request this
| String com.pcbsys.nirvana.nAdminAPI.nLeafNode.getAbsolutePath | ( | ) |
This function walks the tree to the root to generate a fully qualified name for this node.
- Returns:
- String full path and name
Reimplemented from com.pcbsys.nirvana.nAdminAPI.nNode.
| nACL com.pcbsys.nirvana.nAdminAPI.nLeafNode.getACLs | ( | ) | throws nBaseAdminException |
Retrieves the channel/queues ACLs which can then be modified and committed with the setACLs() function.
- Returns:
- The list of nChannelACLEntry in a nACL object
- Exceptions:
-
nBaseAdminException If this user is not permissioned to view this data
| nChannelAttributes com.pcbsys.nirvana.nAdminAPI.nLeafNode.getAttributes | ( | ) |
Returns the channel attributes for this channel/queue.
- Returns:
- nChannelAttributes
| float com.pcbsys.nirvana.nAdminAPI.nLeafNode.getCacheHitRatio | ( | ) |
Retreives the channel/queues cache ratio.
This ratio represents the (number of cache hits)/(Total Access). This cache is only active when the channel/queue is a persistant store and the server caches the event instead of re-reading it from the store again.
- Returns:
- float value
| float com.pcbsys.nirvana.nAdminAPI.nLeafNode.getConnectionRate | ( | ) |
The number of subscriptions made to this store per second.
- Returns:
- float value
| float com.pcbsys.nirvana.nAdminAPI.nLeafNode.getConsumedRate | ( | ) |
The number of events published per second.
- Returns:
- float value
| long com.pcbsys.nirvana.nAdminAPI.nLeafNode.getCurrentNoOfConnections | ( | ) |
Retrieves the current number of connections to this channel.
- Returns:
- long value
| long com.pcbsys.nirvana.nAdminAPI.nLeafNode.getCurrentNumberOfEvents | ( | ) |
Returns the number of events within the channel/queue.
- Returns:
- long value
| float com.pcbsys.nirvana.nAdminAPI.nLeafNode.getFanoutTime | ( | ) |
The total number of milliseconds it takes to fanout each event to all consumers.
- Returns:
- long value
| Enumeration com.pcbsys.nirvana.nAdminAPI.nLeafNode.getInboundJoins | ( | ) |
Returns an enumeration of nJoinDetails objects containing information about channels sending events to this channel.
- Returns:
- Enumeration
| long com.pcbsys.nirvana.nAdminAPI.nLeafNode.getLastEID | ( | ) |
Returns the last EID that was used for the channel/queue.
- Returns:
- long value
| int com.pcbsys.nirvana.nAdminAPI.nLeafNode.getOutboundJoinCount | ( | ) |
Returns a count of outbound joins this channel has.
- Returns:
- count of joins
| Enumeration com.pcbsys.nirvana.nAdminAPI.nLeafNode.getOutboundJoins | ( | ) |
Returns an enumeration of nJoinDetails objects containing information about channels that this channel will pass events to.
- Returns:
- Enumeration
| int com.pcbsys.nirvana.nAdminAPI.nLeafNode.getPercentageFreeInStore | ( | ) |
Returns the amount of free space within a store as a percentage of the overall space used.
- Returns:
- int value
| float com.pcbsys.nirvana.nAdminAPI.nLeafNode.getPublishRate | ( | ) |
The number of events published per second.
- Returns:
- int value
| nRealmNode com.pcbsys.nirvana.nAdminAPI.nLeafNode.getRealm | ( | ) |
Returns the Realm Node this leaf node is associated with.
Please note this might not be the root of the namespace but a federated realm.
- Returns:
- nRealmNode value
| long com.pcbsys.nirvana.nAdminAPI.nLeafNode.getTotalConsumed | ( | ) |
Returns the total number of events that this channel has delivered to subscribers.
- Returns:
- long value
| long com.pcbsys.nirvana.nAdminAPI.nLeafNode.getTotalNoOfConnections | ( | ) |
Returns the total number of connections that this channel has had since the realm started.
- Returns:
- long value
| long com.pcbsys.nirvana.nAdminAPI.nLeafNode.getTotalPublished | ( | ) |
Returns the total number of events published/pushed to this channel/queue since the realm has started.
- Returns:
- long value
| long com.pcbsys.nirvana.nAdminAPI.nLeafNode.getUsedSpace | ( | ) |
Returns the number of bytes that this channel/queue consumes on the server.
- Returns:
- long value
| boolean com.pcbsys.nirvana.nAdminAPI.nLeafNode.isChannel | ( | ) |
Returns true if this represents a nirvana channel.
- Returns:
- boolean value
| boolean com.pcbsys.nirvana.nAdminAPI.nLeafNode.isClusterWide | ( | ) |
Returns true if this represents a nirvana channel or queue that is part of a cluster.
- Returns:
- boolean value
| boolean com.pcbsys.nirvana.nAdminAPI.nLeafNode.isQueue | ( | ) |
Returns true if this represents a nirvana queue.
- Returns:
- boolean value
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.join | ( | nNode | p_toNode, | |
| String | p_Selector | |||
| ) | throws nUnsupportedJoinException, nBaseAdminException |
This method enables the joining of the object from one node to another, specifying a selector for filtered joins.
- Parameters:
-
p_toNode the nNode object to join this node to p_Selector the filter to be applied to the join
- Exceptions:
-
nUnsupportedJoinException thrown if join is not supported (e.g. on queues) nBaseAdminException is thrown if the join creation fails
Implements com.pcbsys.nirvana.nAdminAPI.nJoinable.
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.join | ( | nNode | p_toNode, | |
| boolean | p_isRouted, | |||
| int | p_hopcount, | |||
| String | p_Selector, | |||
| boolean | allowPurges | |||
| ) | throws nUnsupportedJoinException, nBaseAdminException |
This method enables the joining of the object from one node to another, specifying a selector, and a maximum hop count for the events.
This is only supported on channel objects.
- Parameters:
-
p_toNode the nNode object to join this node to p_isRouted Reserved for future use. p_hopcount if an event is published directly to this node (i.e. does not arrive here through another join), this is the maximum number of hops it will follow p_Selector a message selector specifying a filter for this message route allowPurges whether purges will be propagated to the joined channel
- Exceptions:
-
nUnsupportedJoinException thrown if join is not supported (e.g. on queues) nBaseAdminException is thrown if the join creation fails
Implements com.pcbsys.nirvana.nAdminAPI.nJoinable.
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.join | ( | nNode | p_toNode, | |
| boolean | p_isRouted, | |||
| int | p_hopcount, | |||
| String | p_Selector | |||
| ) | throws nUnsupportedJoinException, nBaseAdminException |
This method enables the joining of the object from one node to another, specifying a selector, and a maximum hop count for the events.
This is only supported on channel objects.
- Parameters:
-
p_toNode the nNode object to join this node to p_isRouted Reserved for future use. p_hopcount if an event is published directly to this node (i.e. does not arrive here through another join), this is the maximum number of hops it will follow p_Selector a message selector specifying a filter for this message route
- Exceptions:
-
nUnsupportedJoinException thrown if join is not supported (e.g. on queues) nBaseAdminException is thrown if the join creation fails
Implements com.pcbsys.nirvana.nAdminAPI.nJoinable.
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.modACLEntries | ( | nACL | entry | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
modifies a specific acl entry's permissions in the leaf node acl.
- Parameters:
-
entry An nACL entry containing the subject and permissions to modify in the leaf node acl
- Exceptions:
-
nInsufficientPrivilegesException If the user is not permissioned to perform this operation nNodeException if the ACLs being set are invalid nBaseAdminException if unable to perform the operation, check the message for further information
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.modACLEntry | ( | nACLEntry | entry | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
modifies a specific acl entry's permissions in the leaf node acl.
- Parameters:
-
entry An nACL entry containing the subject and permissions to modify in the leaf node acl
- Exceptions:
-
nInsufficientPrivilegesException If the user is not permissioned to perform this operation nNodeException if the ACLs being set are invalid nBaseAdminException if unable to perform the operation, check the message for further information
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.remove | ( | boolean | removeChildren | ) | throws nUnsupportedRemoveException, nNodeException |
This method removes this leafNode (channel or queue) from its parent RealmNode.
- Parameters:
-
removeChildren a boolean specifying whether siblings should be removed too. Specify false, as leafNodes do not have children
- Exceptions:
-
nUnsupportedRemoveException thrown if join is not supported (e.g. on queues) nNodeException is thrown if an error occurs in the remove operation
- See also:
- nRealmNode
Implements com.pcbsys.nirvana.nAdminAPI.nRemovable.
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.removeACLEntries | ( | nACL | entries | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
removes a specific acl entry from the leaf node acl.
- Parameters:
-
entries An nACL list containing the subjects and permissions to remove from the leaf node acl
- Exceptions:
-
nInsufficientPrivilegesException If the user is not permissioned to perform this operation nNodeException if the ACLs being set are invalid nBaseAdminException if unable to perform the operation, check the message for further information
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.removeACLEntry | ( | nACLEntry | entry | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
removes a specific acl entry from the leaf node acl.
- Parameters:
-
entry An nACL entry containing the subject and permissions to remove from the leaf node acl
- Exceptions:
-
nInsufficientPrivilegesException If the user is not permissioned to perform this operation nNodeException if the ACLs being set are invalid nBaseAdminException if unable to perform the operation, check the message for further information
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.setACLs | ( | nACL | acl | ) | throws nInsufficientPrivilegesException, nNodeException, 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 channel/queues current list.
- Parameters:
-
acl A nACL containing nChannelACLEntry
- Exceptions:
-
nInsufficientPrivilegesException If the user is not permissioned to perform this operation nNodeException if the ACLs being set are invalid nBaseAdminException if unable to perform the operation, check the message for further information
