com.pcbsys.nirvana.nAdminAPI.nLeafNode Class Referenceabstract

This class represents the Nirvana Channel or Queue on the Nirvana Realm. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nLeafNode:
com.pcbsys.nirvana.nAdminAPI.nNode com.pcbsys.nirvana.nAdminAPI.nRemovable com.pcbsys.nirvana.nAdminAPI.nCopyable com.pcbsys.nirvana.nAdminAPI.nJoinable

Public Member Functions

void addACLEntries (nACL entries) throws nBaseAdminException
 Adds a specific acl entry to the leaf node acl. More...
 
void addACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 Adds a specific acl entry to the leaf node acl. More...
 
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. More...
 
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. More...
 
synchronized void closed (nRealmNode node)
 Called when the nRealmNode is closed, for internal use only. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void deleteJoin (nNode p_toNode) throws nUnsupportedJoinException, nBaseAdminException
 This method deletes the join between nodes. More...
 
void delListener () throws nBaseAdminException
 Removes the registered listener from the channel so no further callbacks are made to the listener. More...
 
nLeafNode findDeadEventStore ()
 Returns the dead event store of the eaf node. More...
 
void freeUnusedSpace () throws nBaseClientException
 Requests that the Realm frees the unused space within this channel/queue. More...
 
String getAbsolutePath ()
 This function walks the tree to the root to generate a fully qualified name for this node. More...
 
nACL getACLs () throws nBaseAdminException
 Retrieves the channel/queues ACLs which can then be modified and committed with the setACLs() function. More...
 
nChannelAttributes getAttributes ()
 Returns the channel attributes for this channel/queue. More...
 
float getCacheHitRatio ()
 Retreives the channel/queues cache ratio. More...
 
float getConnectionRate ()
 The number of subscriptions made to this store per second. More...
 
float getConsumedRate ()
 The number of events published per second. More...
 
long getCurrentNoOfConnections ()
 Retrieves the current number of connections to this channel. More...
 
long getCurrentNumberOfEvents ()
 Returns the number of events within the channel/queue. More...
 
float getFanoutTime ()
 The total number of milliseconds it takes to fanout each event to all consumers. More...
 
int getInboundJoinCount ()
 Returns a count of inbound joins this channel has. More...
 
Enumeration< nJoinDetailsgetInboundJoins ()
 Returns an enumeration of nJoinDetails objects containing information about channels sending events to this channel. More...
 
long getLastEID ()
 Returns the last EID that was used for the channel/queue. More...
 
long getMemoryUsage ()
 Returns the heap memory used by this store, for both cached events and for non persistent events.
 
int getOutboundJoinCount ()
 Returns a count of outbound joins this channel has. More...
 
Enumeration< nJoinDetailsgetOutboundJoins ()
 Returns an enumeration of nJoinDetails objects containing information about channels that this channel will pass events to. More...
 
int getPercentageFreeInStore ()
 Returns the amount of free space within a store as a percentage of the overall space used. More...
 
float getPublishRate ()
 The number of events published per second. More...
 
nRealmNode getRealm ()
 Returns the Realm Node this leaf node is associated with. More...
 
long getTotalConsumed ()
 Returns the total number of events that this channel has delivered to subscribers. More...
 
long getTotalNoOfConnections ()
 Returns the total number of connections that this channel has had since the realm started. More...
 
long getTotalPublished ()
 Returns the total number of events published/pushed to this channel/queue since the realm has started. More...
 
long getUsedSpace ()
 Returns the number of bytes that this channel/queue consumes on the server. More...
 
abstract boolean isChannel ()
 Returns true if this represents a nirvana channel. More...
 
boolean isClusterWide ()
 Returns true if this represents a nirvana channel or queue that is part of a cluster. More...
 
abstract boolean isQueue ()
 Returns true if this represents a nirvana queue. More...
 
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. More...
 
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. More...
 
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. More...
 
void modACLEntries (nACL entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 modifies a specific acl entry's permissions in the leaf node acl. More...
 
void modACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 modifies a specific acl entry's permissions in the leaf node acl. More...
 
abstract void remove (boolean removeChildren) throws nUnsupportedRemoveException, nNodeException
 This method removes this leafNode (channel or queue) from its parent RealmNode. More...
 
void removeACLEntries (nACL entries) throws nBaseAdminException
 removes a specific acl entry from the leaf node acl. More...
 
void removeACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 removes a specific acl entry from the leaf node acl. More...
 
void setACLs (nACL acl) throws nInsufficientPrivilegesException, nBaseAdminException
 Commits the ACL passed in with the Realm Server. 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...
 

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. More...
 

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
nNode

Member Function Documentation

void com.pcbsys.nirvana.nAdminAPI.nLeafNode.addACLEntries ( nACL  entries) throws nBaseAdminException

Adds a specific acl entry to the leaf node acl.

Parameters
entriesAn nACL list containing the subjects and permissions to add to the leaf node acl
Exceptions
nInsufficientPrivilegesExceptionIf the user is not permissioned to perform this operation
nNodeExceptionif the ACLs being set are invalid
nBaseAdminExceptionif 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
entryAn nACL entry containing the subject and permissions to add to the leaf node acl
Exceptions
nInsufficientPrivilegesExceptionIf the user is not permissioned to perform this operation
nNodeExceptionif the ACLs being set are invalid
nBaseAdminExceptionif 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
listenerthe connection listener to be added to the leaf node (channel or queue)
Exceptions
nBaseAdminExceptionif 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_toNodethe nNode object to join this node to
p_Selectorthe filter to be applied to the join
Exceptions
nUnsupportedJoinExceptionthrown if join is not supported (e.g. on queues)
nBaseAdminExceptionis thrown if the join creation fails
synchronized void com.pcbsys.nirvana.nAdminAPI.nLeafNode.closed ( nRealmNode  node)

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

Parameters
nodeThe nRealmNode which has been closed.
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_toNodeThe nRealmNode to copy the channel to
p_toNameThe name of the new LeafNode (channel or queue)
p_waitForCompleteSpecifies whether the method returns before copy operation has completed
aclan optional initial acl object that will be set on the object being copied
cmdStatusan optional nCommandStatus object that will inform you of the operation status
Exceptions
nUnsupportedCopyExceptionThrown if copy is not supported
Deprecated:
As of version 2.0

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_toNameThe name of the new LeafNode (channel or queue)
p_waitForCompleteSpecifies whether the method returns before copy operation has completed
aclan optional initial acl object that will be set on the object being copied
cmdStatusan optional nCommandStatus object that will inform you of the operation status
Exceptions
nUnsupportedCopyExceptionThrown 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,
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_toNodeThe nRealmNode to copy the channel to
p_waitForCompleteSpecifies whether the method returns before copy operation has completed
p_attrThe channel attributes of the new LeafNode
aclan optional initial acl object that will be set on the object being copied
cmdStatusan optional nCommandStatus object that will inform you of the operation status
Exceptions
nUnsupportedCopyExceptionThrown 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_toNodeThe nRealmNode to copy the channel to
p_waitForCompleteSpecifies whether the method returns before copy operation has completed
p_attrThe channel attributes of the new LeafNode
cmdStatusan optional nCommandStatus object that will inform you of the operation status
Exceptions
nUnsupportedCopyExceptionThrown if copy is not supported
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_waitForCompleteSpecifies whether the method returns before copy operation has completed
p_attrThe channel attributes of the new LeafNode
aclan optional initial acl object that will be set on the object being copied
cmdStatusan optional nCommandStatus object that will inform you of the operation status
Exceptions
nUnsupportedCopyExceptionThrown if copy is not supported

Implements com.pcbsys.nirvana.nAdminAPI.nCopyable.

static nACL com.pcbsys.nirvana.nAdminAPI.nLeafNode.createACL ( )
static

This method allows you to construct a new nACL object, useful when creating new channels with an initial ACL list.

Returns
new nACL object
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_toNodethe nNode object this node is joined to
Exceptions
nUnsupportedJoinExceptionthrown if join is not supported (e.g. from queues)
nBaseAdminExceptionis 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
nBaseAdminExceptionif the user is not permitted to access these lists
See Also
nConnectionListener
nLeafNode com.pcbsys.nirvana.nAdminAPI.nLeafNode.findDeadEventStore ( )

Returns the dead event store of the eaf node.

Returns
nLeafNode the DeadEventStore of the leadNode
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
nBaseClientExceptionIf 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
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
nBaseAdminExceptionIf 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
See Also
com.pcbsys.nirvana.client.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
int com.pcbsys.nirvana.nAdminAPI.nLeafNode.getInboundJoinCount ( )

Returns a count of inbound joins this channel has.

Returns
count of joins
See Also
com.pcbsys.nirvana.nAdminAPI.nJoinDetails
Enumeration<nJoinDetails> com.pcbsys.nirvana.nAdminAPI.nLeafNode.getInboundJoins ( )

Returns an enumeration of nJoinDetails objects containing information about channels sending events to this channel.

Returns
Enumeration
See Also
com.pcbsys.nirvana.nAdminAPI.nJoinDetails
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
See Also
com.pcbsys.nirvana.nAdminAPI.nJoinDetails
Enumeration<nJoinDetails> 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
See Also
com.pcbsys.nirvana.nAdminAPI.nJoinDetails
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
abstract boolean com.pcbsys.nirvana.nAdminAPI.nLeafNode.isChannel ( )
pure virtual

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
abstract boolean com.pcbsys.nirvana.nAdminAPI.nLeafNode.isQueue ( )
pure virtual

Returns true if this represents a nirvana queue.

Returns
boolean value
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_toNodethe nNode object to join this node to
p_isRoutedReserved for future use.
p_hopcountif 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_Selectora message selector specifying a filter for this message route
Exceptions
nUnsupportedJoinExceptionthrown if join is not supported (e.g. on queues)
nBaseAdminExceptionis 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_toNodethe nNode object to join this node to
p_isRoutedReserved for future use.
p_hopcountif 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_Selectora message selector specifying a filter for this message route
allowPurgeswhether purges will be propagated to the joined channel
Exceptions
nUnsupportedJoinExceptionthrown if join is not supported (e.g. on queues)
nBaseAdminExceptionis thrown if the join creation fails

Implements com.pcbsys.nirvana.nAdminAPI.nJoinable.

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_toNodethe nNode object to join this node to
p_Selectorthe filter to be applied to the join
Exceptions
nUnsupportedJoinExceptionthrown if join is not supported (e.g. on queues)
nBaseAdminExceptionis 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
entryAn nACL entry containing the subject and permissions to modify in the leaf node acl
Exceptions
nInsufficientPrivilegesExceptionIf the user is not permissioned to perform this operation
nNodeExceptionif the ACLs being set are invalid
nBaseAdminExceptionif 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
entryAn nACL entry containing the subject and permissions to modify in the leaf node acl
Exceptions
nInsufficientPrivilegesExceptionIf the user is not permissioned to perform this operation
nNodeExceptionif the ACLs being set are invalid
nBaseAdminExceptionif unable to perform the operation, check the message for further information
abstract void com.pcbsys.nirvana.nAdminAPI.nLeafNode.remove ( boolean  removeChildren) throws nUnsupportedRemoveException, nNodeException
pure virtual

This method removes this leafNode (channel or queue) from its parent RealmNode.

Parameters
removeChildrena boolean specifying whether siblings should be removed too. Specify false, as leafNodes do not have children
Exceptions
nUnsupportedRemoveExceptionthrown if join is not supported (e.g. on queues)
nNodeExceptionis thrown if an error occurs in the remove operation
See Also
nRealmNode
nLinkNode

Implements com.pcbsys.nirvana.nAdminAPI.nRemovable.

void com.pcbsys.nirvana.nAdminAPI.nLeafNode.removeACLEntries ( nACL  entries) throws nBaseAdminException

removes a specific acl entry from the leaf node acl.

Parameters
entriesAn nACL list containing the subjects and permissions to remove from the leaf node acl
Exceptions
nInsufficientPrivilegesExceptionIf the user is not permissioned to perform this operation
nNodeExceptionif the ACLs being set are invalid
nBaseAdminExceptionif 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
entryAn nACL entry containing the subject and permissions to remove from the leaf node acl
Exceptions
nInsufficientPrivilegesExceptionIf the user is not permissioned to perform this operation
nNodeExceptionif the ACLs being set are invalid
nBaseAdminExceptionif unable to perform the operation, check the message for further information
void com.pcbsys.nirvana.nAdminAPI.nLeafNode.setACLs ( 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 channel/queues current list.

Parameters
aclA nACL containing nChannelACLEntry
Exceptions
nInsufficientPrivilegesExceptionIf the user is not permissioned to perform this operation
nNodeExceptionif the ACLs being set are invalid
nBaseAdminExceptionif unable to perform the operation, check the message for further information