This class provides basic Administration functionality for security based operations. More...
Public Member Functions | |
| virtual void | addACLEntries (nACL entries, nAbstractChannel obj) |
| Adds a list of acl entries to the channel or queue acl More... | |
| virtual void | addACLEntries (nACL acl, nAbstractChannel[] objs) |
| Adds a list of acl entries to all objects in an array of channels and / or queues More... | |
| virtual void | addACLEntry (nACLEntry entry, nAbstractChannel obj) |
| Adds a specific acl entry to the channel or queue acl More... | |
| virtual void | addACLEntry (nACLEntry entry, nAbstractChannel[] objs) |
| Adds an acl entry to all objects in an array of channels and / or queues More... | |
| virtual void | addRealmACLEntries (nACL entry) |
| Adds a list of acl entries to the realm acl More... | |
| virtual void | addRealmACLEntry (nACLEntry entry) |
| Adds a specific acl entry to the realm acl More... | |
| virtual void | addReconnectHandler (nReconnectHandler handler) |
| Add a session reconnect handler to the underlying admin session. More... | |
| virtual void | close () |
| Closes the session with the remote Realm | |
| virtual nChannel | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr, nACL initialACL, long initialEID, nAbstractChannel deadStore) |
| Creates a new channel on the realm this session is connected. More... | |
| virtual nChannel | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr, nACL initialACL, long initialEID) |
| Creates a new channel on the realm this session is connected. More... | |
| virtual nChannel | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr, nACL initialACL) |
| Creates a new channel on the realm this session is connected. More... | |
| virtual nChannel | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr) |
| Creates a new channel on the realm this session is connected. More... | |
| virtual nQueue | createQueue (com.pcbsys.nirvana.client.nChannelAttributes attr, nACL initialACL, nAbstractChannel deadStore) |
| Creates a new queue on the realm this session is connected. More... | |
| virtual nQueue | createQueue (com.pcbsys.nirvana.client.nChannelAttributes attr, nACL initialACL) |
| Creates a new queue on the realm this session is connected. More... | |
| virtual nQueue | createQueue (com.pcbsys.nirvana.client.nChannelAttributes attr) |
| Creates a new queue on the realm this session is connected. More... | |
| virtual nACL | getACL (nAbstractChannel obj) |
| Returns the current ACL for the specified channel or queue on the Nirvana Realm. More... | |
| virtual List< fAclGroup > | getACLGroups () |
| Returns a list of all ACL groups defined on the realm. More... | |
| virtual string | getConnectedRealmName () |
| Return the name of the Nirvana Realm currently connected to More... | |
| virtual nACL | getInterfaceACL (string iface) |
| Returns the nACL object passed for the interface in question More... | |
| virtual nACL | getRealmACL () |
| Returns the current ACL on the Nirvana Realm. More... | |
| virtual nSession | getSession () |
| Returns the nSession object for this RealmAdmin More... | |
| virtual bool | isConnectedToMaster () |
| If follow master has been set, then when the nRealmAdmin is disconnected, the underlying nSession will be set to the master realm when a new master is elected after losing quorum. More... | |
| virtual void | modACLEntries (nACL entries, nAbstractChannel obj) |
| Modifies a list of acl entries in the channel or queue acl. More... | |
| virtual void | modACLEntry (nACLEntry entry, nAbstractChannel obj) |
| Modifies a specific acl entry's permissions in the channel or queue More... | |
| virtual void | modRealmACLEntries (nACL entry) |
| Modifies the acl entries in the list of realm acl entries. More... | |
| virtual void | modRealmACLEntry (nACLEntry entry) |
| Modifies a specific acl entry's permissions in the realm acl. More... | |
| nRealmAdmin (nSessionAttributes sAttr) | |
| Constructs a link with the realm server for admin operations More... | |
| nRealmAdmin (nSessionAttributes sAttr, bool followMaster) | |
| Constructs a link with the realm server for admin operations More... | |
| nRealmAdmin (nSessionAttributes sAttr, string username, SecureString password=null) | |
| Constructs a link with the realm server for admin operations More... | |
| nRealmAdmin (nSessionAttributes sAttr, string username, bool followMaster) | |
| Constructs a link with the realm server for admin operations More... | |
| nRealmAdmin (nSessionAttributes sAttr, string username, SecureString password, bool followMaster) | |
| Constructs a link with the realm server for admin operations More... | |
| virtual void | removeACLEntries (nACL entries, nAbstractChannel obj) |
| Removes a list of acl entries from the channel or queue acl. More... | |
| virtual void | removeACLEntries (nACL acl, nAbstractChannel[] objs) |
| Removes a list of acl entries from all objects in an array of channels and / or queues More... | |
| virtual void | removeACLEntry (nACLEntry entry, nAbstractChannel obj) |
| Removes a specific acl entry from the channel or queue acl. More... | |
| virtual void | removeACLEntry (nACLEntry entry, nAbstractChannel[] objs) |
| Removes an acl entry from all objects in an array of channels and / or queues More... | |
| virtual void | removeRealmACLEntries (nACL entry) |
| Removes a list of acl entries from the realm acl. More... | |
| virtual void | removeRealmACLEntry (nACLEntry entry) |
| Removes a specific acl entry from the realm acl. More... | |
| virtual void | setACL (nACL acl, nAbstractChannel obj) |
| Replaces the ACL on the Realm Server for this channel / queue with the acl list passed in. More... | |
| virtual void | setInterfaceACL (string iface, nACL acl) |
| Commits the nACL object passed in with the Realm Server for the specified interface More... | |
| virtual void | setRealmACL (nACL acl) |
| Replaces the ACL on the Nirvana Realm with that which is passed in. More... | |
This class provides basic Administration functionality for security based operations.
It does not maintain any state for any objects, but allows Realm, nChannel & nQueue and also Interface acls to be added, removed or modified. It is also possible to obtain an up to date image of the acl objects for the Realm, nChannel & nQueue and also interfaces by querying the Realm itself.
| com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.nRealmAdmin | ( | nSessionAttributes | sAttr | ) |
Constructs a link with the realm server for admin operations
| sAttr | nSessionAttributes representing the realm you wish to communicate with |
| nBaseAdminException | If the user is not authorised for admin functions |
| com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.nRealmAdmin | ( | nSessionAttributes | sAttr, |
| bool | followMaster | ||
| ) |
Constructs a link with the realm server for admin operations
| sAttr | nSessionAttributes representing the realm you wish to communicate with |
| followMaster | if set, this class will attempt to stay connected to the master realm |
| nBaseAdminException | If the user is not authorised for admin functions |
| com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.nRealmAdmin | ( | nSessionAttributes | sAttr, |
| string | username, | ||
| SecureString | password = null |
||
| ) |
Constructs a link with the realm server for admin operations
| sAttr | nSessionAttributes representing the realm you wish to communicate with |
| username | Username to use to login to the server |
| password | Password to use to login to the server |
| nBaseAdminException | If the user is not authorised for admin functions |
| com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.nRealmAdmin | ( | nSessionAttributes | sAttr, |
| string | username, | ||
| bool | followMaster | ||
| ) |
Constructs a link with the realm server for admin operations
| sAttr | nSessionAttributes representing the realm you wish to communicate with |
| username | Username to use to login to the server |
| followMaster | if set, this class will attempt to stay connected to the master realm |
| nBaseAdminException | If the user is not authorised for admin functions |
| com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.nRealmAdmin | ( | nSessionAttributes | sAttr, |
| string | username, | ||
| SecureString | password, | ||
| bool | followMaster | ||
| ) |
Constructs a link with the realm server for admin operations
| sAttr | nSessionAttributes representing the realm you wish to communicate with |
| username | Username to use to login to the server |
| password | Password to use to login to the server |
| followMaster | if set, this class will attempt to stay connected to the master realm |
| nBaseAdminException | If the user is not authorised for admin functions |
|
virtual |
Adds a list of acl entries to the channel or queue acl
| entries | An nACL list containing the subjects and permissions to add to the channel or queue acl |
| obj | the channel or queue |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Adds a list of acl entries to all objects in an array of channels and / or queues
| acl | the acl to apply |
| objs | the channels and / or queues to apply the acl to |
| nBaseAdminException |
|
virtual |
Adds a specific acl entry to the channel or queue acl
| entry | An nACL entry containing the subject and permissions to add to the channel or queue acl |
| obj | the channel or queue |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Adds an acl entry to all objects in an array of channels and / or queues
| entry | the acl to apply |
| objs | the channels and / or queues to apply the acl to |
| nBaseAdminException |
|
virtual |
Adds a list of acl entries to the realm acl
| entry | An nACL list containing the subjects and permissions to add to the realm acl |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Adds a specific acl entry to the realm acl
| entry | An nACL entry containing the subject and permissions to add to the realm acl |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Add a session reconnect handler to the underlying admin session.
| handler | - the nReconnectHandler object for the underlying admin session |
|
virtual |
Creates a new channel on the realm this session is connected.
| attr | The channel attributes object containing the parameters for the new channel to be created |
| initialACL | The initial ACLs to apply to the channel at creation time |
| initialEID | The value to start the event id at |
| deadStore | 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 occurred, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
|
virtual |
Creates a new channel on the realm this session is connected.
| attr | The channel attributes object containing the parameters for the new channel to be created |
| initialACL | The initial ACLs to apply to the channel at creation time |
| 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 occurred, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
|
virtual |
Creates a new channel on the realm this session is connected.
| attr | The channel attributes object containing the parameters for the new channel to be created |
| 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 occurred, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
|
virtual |
Creates a new channel on the realm this session is connected.
| 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 |
| 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 occurred, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
|
virtual |
Creates a new queue on the realm this session is connected.
| attr | The channel attributes object containing the parameters for the new queue to be created |
| initialACL | The initial ACLs to apply to the queue at creation time |
| deadStore | 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 occurred, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
|
virtual |
Creates a new queue on the realm this session is connected.
| attr | The channel 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 occurred, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
|
virtual |
Creates a new queue on the realm this session is connected.
| attr | The channel 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 occurred, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
|
virtual |
Returns the current ACL for the specified channel or queue on the Nirvana Realm.
This call makes a synchronous call to the realm to obtain the current acl.
| obj | the channel or queue to obtain the current permissions for |
| nBaseAdminException | If unable to successfully perform this operation, check the message for more information |
|
virtual |
Returns a list of all ACL groups defined on the realm.
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Return the name of the Nirvana Realm currently connected to
|
virtual |
Returns the nACL object passed for the interface in question
| iface | The name of the interface |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Returns the current ACL on the Nirvana Realm.
This call makes a synchronous call to the realm to obtain the current acl list.
| nBaseAdminException | If unable to successfully perform this operation, check the message for more information |
|
virtual |
Returns the nSession object for this RealmAdmin
<seealso cref= com.pcbsys.nirvana.client.nSession
|
virtual |
If follow master has been set, then when the nRealmAdmin is disconnected, the underlying nSession will be set to the master realm when a new master is elected after losing quorum.
This method will determine whether the underlying nSession is actually connected to the master realm
|
virtual |
Modifies a list of acl entries in the channel or queue acl.
| entries | An nACL list containing the subjects and permissions to remove from the channel or queue acl |
| obj | the channel or queue |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Modifies a specific acl entry's permissions in the channel or queue
| entry | An nACL entry containing the subject and permissions to modify in the channel or queue acl |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Modifies the acl entries in the list of realm acl entries.
| entry | An nACL list containing the subjects and permissions to modify in the realm |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Modifies a specific acl entry's permissions in the realm acl.
| entry | An nACL entry containing the subject and permissions to modify in the realm node |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Removes a list of acl entries from the channel or queue acl.
| entries | An nACL list containing the subjects and permissions to remove from the channel or queue acl |
| obj | the channel or queue |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Removes a list of acl entries from all objects in an array of channels and / or queues
| acl | the acl to apply |
| objs | the channels and / or queues to apply the acl to |
| nBaseAdminException |
|
virtual |
Removes a specific acl entry from the channel or queue acl.
| entry | An nACL entry containing the subject and permissions to remove from the channel or queue acl |
| obj | the channel or queue |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Removes an acl entry from all objects in an array of channels and / or queues
| entry | the acl to apply |
| objs | the channels and / or queues to apply the acl to |
| nBaseAdminException |
|
virtual |
Removes a list of acl entries from the realm acl.
| entry | An nACL list containing the subjects and permissions to remove from the realm acl |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Removes a specific acl entry from the realm acl.
| entry | An nACL entry containing the subject and permissions to remove from the realm acl |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Replaces the ACL on the Realm Server for this channel / queue with the acl list passed in.
This will entirely replace the channel / queue acl with the contents of the acl passed into the function.
This method should be used with extreme caution. Unlike the nRealmNode, the nRealmAdmin does not maintain an up to date image of any of the channel ACL lists. This function will overwrite the acl at the server for the specific channel / queue with the acl entries passed in.
| acl | A nACL containing list of subjects and permissions |
| obj | The channel or queue to set the acl on |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Commits the nACL object passed in with the Realm Server for the specified interface
| iface | The name of the interface |
| acl | A nACL containing nInterfaceViaEntry objects |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
|
virtual |
Replaces the ACL on the Nirvana Realm with that which is passed in.
This method is synchronous and will return once the operation has been completed by the server or cluster.
This method should be used with extreme caution. Unlike the nRealmNode, the nRealmAdmin does not maintain an up to date image of the Realm ACL. This function will overwrite the acl at the server with the acl entries passed in.
| acl | A nACL containing nRealmACLEntry |
| nBaseAdminException | If unable to successfully perform this operation, check the message for more information |