This class represents the Nirvana Channel or Queue on the Nirvana Realm. More...
Public Member Functions | |
| void | addACLEntries (nACL entries) |
| Adds a list of acl entries to the leaf nodes acl More... | |
| virtual void | addACLEntry (nACLEntry entry) |
| Adds a specific acl entry to the leaf node acl More... | |
| virtual void | addListener (nConnectionListener listener) |
| 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) |
| summary> This method enables the joining of the object from one node to another, specifying a selector for filtered joins More... | |
| virtual void | closed (nRealmNode node) |
| Called when the nRealmNode is closed, for internal use only. More... | |
| virtual void | copy (nNode p_toNode, string p_toName, bool p_waitForComplete, nACL acl, nCommandStatus cmdStatus) |
| 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... | |
| virtual void | copy (string p_toName, bool p_waitForComplete, nACL acl, nCommandStatus cmdStatus) |
| Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within same realm with the specfied channel name. More... | |
| virtual void | copy (nNode p_toNode, bool p_waitForComplete, nChannelAttributes p_attr, nACL acl, nCommandStatus cmdStatus) |
| 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... | |
| virtual void | copy (nNode p_toNode, bool p_waitForComplete, nChannelAttributes p_attr, nCommandStatus cmdStatus) |
| 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... | |
| virtual void | copy (bool p_waitForComplete, nChannelAttributes p_attr, nACL acl, nCommandStatus cmdStatus) |
| Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within the same realm node with the specfied channel attributes. More... | |
| virtual void | deleteJoin (nNode p_toNode) |
| This method deletes the join between nodes. More... | |
| virtual void | delListener () |
| Removes the registered listener from the channel so no further callbacks are made to the listener More... | |
| virtual nLeafNode | findDeadEventStore () |
| Returns the dead event store if one exists More... | |
| virtual void | freeUnusedSpace () |
| Requests that the Realm frees the unused space within this channel/queue. More... | |
| override string | getAbsolutePath () |
| This function walks the tree to the root to generate a fully qualified name for this node More... | |
| virtual nACL | getACLs () |
| Retrieves the channel/queues ACLs which can then be modified and committed with the setACLs() function More... | |
| virtual nChannelAttributes | getAttributes () |
| Returns the channel attributes for this channel/queue. More... | |
| virtual float | getCacheHitRatio () |
| Retreives the channel/queues cache ratio. More... | |
| virtual float | getConnectionRate () |
| The number of subscriptions made to this store per second More... | |
| virtual float | getConsumedRate () |
| The number of events published per second More... | |
| virtual long | getCurrentNoOfConnections () |
| Retrieves the current number of connections to this channel More... | |
| virtual 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... | |
| virtual System.Collections.IEnumerator | getInboundJoins () |
| Returns an IEnumerator of nJoinDetails objects containing information about channels sending events to this channel More... | |
| virtual long | getLastEID () |
| Returns the last EID that was used for the channel/queue More... | |
| virtual int | getOutboundJoinCount () |
| Returns a count of outbound joins from this channel More... | |
| virtual System.Collections.IEnumerator | getOutboundJoins () |
| Returns an IEnumerator of nJoinDetails objects containing information about channels that this channel will pass events to More... | |
| virtual int | getPercentageFreeInStore () |
| Returns the amount of free space within a store as a percentage of the overall space used More... | |
| virtual float | getPublishRate () |
| The number of events published per second More... | |
| virtual nRealmNode | getRealm () |
| Returns the Realm Node this leaf node is associated with. More... | |
| virtual long | getTotalConsumed () |
| Returns the total number of events that this channel has delivered to subscribers More... | |
| virtual long | getTotalNoOfConnections () |
| Returns the total number of connections that this channel has had since the realm started More... | |
| virtual long | getTotalPublished () |
| Returns the total number of events published/pushed to this channel/queue since the realm has started More... | |
| virtual long | getUsedSpace () |
| Returns the number of bytes that this channel/queue consumes on the server More... | |
| virtual bool | isChannel () |
| Returns true if this represents a nirvana channel More... | |
| virtual bool | isClusterWide () |
| Returns true if this represents a nirvana channel or queue that is part of a cluster More... | |
| virtual bool | isQueue () |
| Returns true if this represents a nirvana queue More... | |
| virtual void | join (nNode p_toNode, bool p_isRouted, int p_hopcount, string p_Selector) |
| 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... | |
| virtual void | join (nNode p_toNode, bool p_isRouted, int p_hopcount, string p_Selector, bool allowPurges) |
| 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... | |
| virtual void | join (nNode p_toNode, string p_Selector) |
| This method enables the joining of the object from one node to another, specifying a selector for filtered joins More... | |
| void | modACLEntries (nACL entry) |
| Modifies the acl entries for the leaf nodes ACL More... | |
| virtual void | modACLEntry (nACLEntry entry) |
| modifies a specific acl entry's permissions in the leaf node acl. More... | |
| virtual void | remove (bool removeChildren) |
| This method removes this leafNode (channel or queue) from its parent RealmNode. More... | |
| void | removeACLEntries (nACL entries) |
| Removes the acl entries from the leaf nodes ACL More... | |
| virtual void | removeACLEntry (nACLEntry entry) |
| removes a specific acl entry from the leaf node acl. More... | |
| virtual void | setACLs (nACL acl) |
| Commits the ACL passed in with the Realm Server. More... | |
 Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nNode | |
| bool | Equals (long aLong) |
| Needed as part of the SortedObject interface. More... | |
| override bool | Equals (object item) |
| Compares this object with the passed object More... | |
| virtual nNode | getParent () |
| Returns this nodes parent node. More... | |
| virtual string | getRelativePath (nNode top) |
| This method returns the relative path from this node to the nNode passed. More... | |
| virtual bool | lessThan (long aLong) |
| Needed as part of the SortedObject interface. More... | |
| virtual bool | lessThan (object item) |
| Compares this object with the passed object. More... | |
| Public Member Functions inherited from com.pcbsys.nirvana.client.Observable | |
| void | addObserver (IObserver o) |
| Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. More... | |
| int | countObservers () |
Returns the number of observers of this Observable object. More... | |
| void | deleteObserver (IObserver o) |
| Deletes an observer from the set of observers of this object. More... | |
| void | deleteObservers () |
| Clears the observer list so that this object no longer has any observers. More... | |
| bool | hasChanged () |
| Tests if this object has changed. More... | |
| void | notifyObservers () |
If this object has changed, as indicated by the hasChanged method, then notify all of its observers and then call the clearChanged method to indicate that this object has no longer changed. More... | |
| void | notifyObservers (Object arg) |
| If this object has changed, as indicated by the More... | |
| Observable () | |
| Construct an Observable with zero Observers. More... | |
Static Public Member Functions | |
| static nACL | createACL () |
| This method allows you to construct a new nACL object, useful when creating new channels with an initial ACL list More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from com.pcbsys.nirvana.client.Observable | |
| void | clearChanged () |
Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the hasChanged method will now return false. More... | |
| void | setChanged () |
Marks this Observable object as having been changed; the hasChanged method will now return true. More... | |
| Properties inherited from com.pcbsys.nirvana.nAdminAPI.nNode | |
| virtual string | Name [get] |
| Returns the generic name of this node within the namespace More... | |
This class represents the Nirvana Channel or Queue on the Nirvana Realm.
The super class is nNode which implements 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.
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.addACLEntries | ( | nACL | entries | ) |
Adds a list of acl entries to the leaf nodes acl
| entries | an nACL object containing the list of nACLEntries to add to the existing ACL for this leaf node |
| nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
| nNodeException | if the ACLs being set are invalid |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Adds a specific acl entry to the leaf node acl
| entry | An nACL entry containing the subject and permissions to add to the leaf node acl |
| nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
| nNodeException | if the ACLs being set are invalid |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
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.
| listener | the connection listener to be added to the leaf node (channel or queue) |
| nBaseAdminException | if the user is not permitted to access these lists, check the message for further information |
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.archiveJoin | ( | nNode | p_toNode, |
| String | p_Selector | ||
| ) |
summary> This method enables the joining of the object from one node to another, specifying a selector for filtered joins
| p_toNode | the nNode object to join this node to |
| p_Selector | the filter to be applied to the join |
| nUnsupportedJoinException | thrown if join is not supported (e.g. on queues) |
| nBaseAdminException | is thrown if the join creation fails |
|
virtual |
Called when the nRealmNode is closed, for internal use only.
| node | The nRealmNode which has been closed |
|
virtual |
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.
| 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 |
| nUnsupportedCopyException | Thrown if copy is not supported |
deprecated 3.
Implements com.pcbsys.nirvana.nAdminAPI.nCopyable.
|
virtual |
Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within same realm with the specfied channel name.
| 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 |
| nUnsupportedCopyException | Thrown if copy is not supported |
deprecated 4.
Implements com.pcbsys.nirvana.nAdminAPI.nCopyable.
|
virtual |
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.
| 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 |
| nUnsupportedCopyException | Thrown if copy is not supported |
Implements com.pcbsys.nirvana.nAdminAPI.nCopyable.
|
virtual |
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.
| 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 |
| nUnsupportedCopyException | Thrown if copy is not supported |
|
virtual |
Copies this leafNode (channel or queue) to a new LeafNode (channel or queue) within the same realm node with the specfied channel attributes.
| 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 |
| nUnsupportedCopyException | Thrown if copy is not supported |
Implements com.pcbsys.nirvana.nAdminAPI.nCopyable.
|
static |
|
virtual |
This method deletes the join between nodes.
This is only supported where the source node is a channel
| p_toNode | the nNode object this node is joined to |
| nUnsupportedJoinException | thrown if join is not supported (e.g. from queues) |
| nBaseAdminException | is thrown if the join deletion fails |
|
virtual |
Removes the registered listener from the channel so no further callbacks are made to the listener
| nBaseAdminException | if the user is not permitted to access these lists |
|
virtual |
Returns the dead event store if one exists
<return> The dead event store if one exists, null otherwise </return>
|
virtual |
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.
| nBaseClientException | If the user does not have the permission to request this |
|
virtual |
This function walks the tree to the root to generate a fully qualified name for this node
Reimplemented from com.pcbsys.nirvana.nAdminAPI.nNode.
|
virtual |
Retrieves the channel/queues ACLs which can then be modified and committed with the setACLs() function
| nBaseAdminException | If this user is not permissioned to view this data |
|
virtual |
Returns the channel attributes for this channel/queue.
com.pcbsys.nirvana.client.nChannelAttributes
|
virtual |
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.
|
virtual |
The number of subscriptions made to this store per second
|
virtual |
The number of events published per second
|
virtual |
Retrieves the current number of connections to this channel
|
virtual |
Returns the number of events within the channel/queue
| float com.pcbsys.nirvana.nAdminAPI.nLeafNode.getFanoutTime | ( | ) |
The total number of milliseconds it takes to fanout each event to all consumers
|
virtual |
Returns an IEnumerator of nJoinDetails objects containing information about channels sending events to this channel
com.pcbsys.nirvana.nAdminAPI.nJoinDetails
|
virtual |
Returns the last EID that was used for the channel/queue
|
virtual |
Returns a count of outbound joins from this channel
com.pcbsys.nirvana.nAdminAPI.nJoinDetails
|
virtual |
Returns an IEnumerator of nJoinDetails objects containing information about channels that this channel will pass events to
com.pcbsys.nirvana.nAdminAPI.nJoinDetails
|
virtual |
Returns the amount of free space within a store as a percentage of the overall space used
|
virtual |
The number of events published per second
|
virtual |
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.
|
virtual |
Returns the total number of events that this channel has delivered to subscribers
|
virtual |
Returns the total number of connections that this channel has had since the realm started
|
virtual |
Returns the total number of events published/pushed to this channel/queue since the realm has started
|
virtual |
Returns the number of bytes that this channel/queue consumes on the server
|
virtual |
Returns true if this represents a nirvana channel
|
virtual |
Returns true if this represents a nirvana channel or queue that is part of a cluster
|
virtual |
Returns true if this represents a nirvana queue
|
virtual |
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.
| 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 |
| 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.
|
virtual |
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.
| 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 |
| 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.
|
virtual |
This method enables the joining of the object from one node to another, specifying a selector for filtered joins
| p_toNode | the nNode object to join this node to |
| p_Selector | the filter to be applied to the join |
| 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 | ) |
Modifies the acl entries for the leaf nodes ACL
| entries | an nACL object containing the list of nACLEntries to be modified for the existing ACL for this leaf node |
| nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
| nNodeException | if the ACLs being set are invalid |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
modifies a specific acl entry's permissions in the leaf node acl.
| entry | An nACL entry containing the subject and permissions to modify in the leaf node acl |
| nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
| nNodeException | if the ACLs being set are invalid |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
This method removes this leafNode (channel or queue) from its parent RealmNode.
| removeChildren | a boolean specifying whether siblings should be removed too. Specify false, as leafNodes do not have children |
| nUnsupportedRemoveException | thrown if join is not supported (e.g. on queues) |
| nNodeException | is thrown if an error occurs in the remove operation |
Implements com.pcbsys.nirvana.nAdminAPI.nRemovable.
| void com.pcbsys.nirvana.nAdminAPI.nLeafNode.removeACLEntries | ( | nACL | entries | ) |
Removes the acl entries from the leaf nodes ACL
| entries | an nACL object containing the list of nACLEntries to remove from the existing ACL for this leaf node |
| nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
| nNodeException | if the ACLs being set are invalid |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
removes a specific acl entry from the leaf node acl.
| entry | An nACL entry containing the subject and permissions to remove from the leaf node acl |
| nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
| nNodeException | if the ACLs being set are invalid |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
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.
| acl | A nACL containing nChannelACLEntry |
| 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 |