This class provides basic Administration functionality for security based operations. More...

Public Member Functions
void	addACLEntries (nACL entries, nAbstractChannel obj) throws nBaseAdminException
	Adds a list of acl entries to the channel or queue acl. More...

void	addACLEntries (nACL acl, nAbstractChannel[] objs) throws nBaseAdminException
	Adds a list of acl entries to all objects in an array of channels and / or queues. More...

void	addACLEntry (nACLEntry entry, nAbstractChannel obj) throws nBaseAdminException
	Adds a specific acl entry to the channel or queue acl. More...

void	addACLEntry (nACLEntry entry, nAbstractChannel[] objs) throws nBaseAdminException
	Adds an acl entry to all objects in an array of channels and / or queues. More...

void	addRealmACLEntries (nACL entry) throws nBaseAdminException
	Adds a list of acl entries to the realm acl. More...

void	addRealmACLEntry (nACLEntry entry) throws nBaseAdminException
	Adds a specific acl entry to the realm acl. More...

void	addReconnectHandler (nReconnectHandler handler)
	Add a session reconnect handler to the underlying admin session. More...

void	close ()
	Closes the session with the remote Realm.

nChannel	createChannel (final com.pcbsys.nirvana.client.nChannelAttributes attr, final nACL initialACL, final long initialEID, final nAbstractChannel deadStore) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
	Creates a new channel on the realm this session is connected. More...

nChannel	createChannel (final com.pcbsys.nirvana.client.nChannelAttributes attr, final nACL initialACL, final long initialEID) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
	Creates a new channel on the realm this session is connected. More...

nChannel	createChannel (final com.pcbsys.nirvana.client.nChannelAttributes attr, final nACL initialACL) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
	Creates a new channel on the realm this session is connected. More...

nChannel	createChannel (final com.pcbsys.nirvana.client.nChannelAttributes attr) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
	Creates a new channel on the realm this session is connected. More...

nQueue	createQueue (final com.pcbsys.nirvana.client.nChannelAttributes attr, final nACL initialACL, final nAbstractChannel deadStore) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
	Creates a new queue on the realm this session is connected. More...

nQueue	createQueue (final com.pcbsys.nirvana.client.nChannelAttributes attr, final nACL initialACL) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
	Creates a new queue on the realm this session is connected. More...

nQueue	createQueue (final com.pcbsys.nirvana.client.nChannelAttributes attr) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException
	Creates a new queue on the realm this session is connected. More...

nACL	getACL (nAbstractChannel obj) throws nBaseAdminException
	Returns the current ACL for the specified channel or queue on the Nirvana Realm. More...

Collection< fAclGroup >	getACLGroups () throws nBaseClientException
	Returns a list of all ACL groups defined on the realm. More...

String	getConnectedRealmName ()
	Return the name of the Nirvana Realm currently connected to. More...

nACL	getInterfaceACL (String iface) throws nBaseAdminException
	Returns the nACL object passed for the interface in question. More...

synchronized nACL	getRealmACL () throws nBaseAdminException
	Returns the current ACL on the Nirvana Realm. More...

nSession	getSession ()
	Returns the nSession object for this RealmAdmin. More...

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

void	modACLEntries (nACL entries, nAbstractChannel obj) throws nBaseAdminException
	Modifies a list of acl entries in the channel or queue acl. More...

void	modACLEntry (nACLEntry entry, nAbstractChannel obj) throws nBaseAdminException
	Modifies a specific acl entry's permissions in the channel or queue. More...

void	modRealmACLEntries (nACL entry) throws nBaseAdminException
	Modifies the acl entries in the list of realm acl entries. More...

void	modRealmACLEntry (nACLEntry entry) throws nBaseAdminException
	Modifies a specific acl entry's permissions in the realm acl. More...

	nRealmAdmin (final nSessionAttributes sAttr) throws nBaseAdminException
	Constructs a link with the realm server for admin operations. More...

	nRealmAdmin (final nSessionAttributes sAttr, final String username) throws nBaseAdminException
	Constructs a link with the realm server for admin operations. More...

	nRealmAdmin (final nSessionAttributes sAttr, final String username, final String password) throws nBaseAdminException
	Constructs a link with the realm server for admin operations. More...

	nRealmAdmin (final nSessionAttributes sAttr, boolean followMaster) throws nBaseAdminException
	Constructs a link with the realm server for admin operations. More...

	nRealmAdmin (final nSessionAttributes sAttr, final String username, boolean followMaster) throws nBaseAdminException
	Constructs a link with the realm server for admin operations. More...

	nRealmAdmin (final nSessionAttributes sAttr, final String username, final String password, boolean followMaster) throws nBaseAdminException
	Constructs a link with the realm server for admin operations. More...

void	removeACLEntries (nACL entries, nAbstractChannel obj) throws nBaseAdminException
	Removes a list of acl entries from the channel or queue acl. More...

void	removeACLEntries (nACL acl, nAbstractChannel[] objs) throws nBaseAdminException
	Removes a list of acl entries from all objects in an array of channels and / or queues. More...

void	removeACLEntry (nACLEntry entry, nAbstractChannel obj) throws nBaseAdminException
	Removes a specific acl entry from the channel or queue acl. More...

void	removeACLEntry (nACLEntry entry, nAbstractChannel[] objs) throws nBaseAdminException
	Removes an acl entry from all objects in an array of channels and / or queues. More...

void	removeRealmACLEntries (nACL entry) throws nBaseAdminException
	Removes a list of acl entries from the realm acl. More...

void	removeRealmACLEntry (nACLEntry entry) throws nBaseAdminException
	Removes a specific acl entry from the realm acl. More...

void	setACL (nACL acl, nAbstractChannel obj) throws nBaseAdminException
	Replaces the ACL on the Realm Server for this channel / queue with the acl list passed in. More...

void	setInterfaceACL (String iface, nACL acl) throws nBaseAdminException
	Commits the nACL object passed in with the Realm Server for the specified interface. More...

synchronized void	setRealmACL (final nACL acl) throws nBaseAdminException
	Replaces the ACL on the Nirvana Realm with that which is passed in. More...

Detailed Description

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.

Constructor & Destructor Documentation

com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.nRealmAdmin ( final nSessionAttributes sAttr ) throws nBaseAdminException

Constructs a link with the realm server for admin operations.

Parameters

sAttr nSessionAttributes representing the realm you wish to communicate with

Exceptions

nBaseAdminException If the user is not authorised for admin functions

com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.nRealmAdmin	(	final nSessionAttributes	sAttr,
		final String	username
	)		throws nBaseAdminException

Constructs a link with the realm server for admin operations.

Parameters

sAttr	nSessionAttributes representing the realm you wish to communicate with
username	Username to use to login to the server

Exceptions

nBaseAdminException If the user is not authorised for admin functions

com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.nRealmAdmin	(	final nSessionAttributes	sAttr,
		final String	username,
		final String	password
	)		throws nBaseAdminException

Constructs a link with the realm server for admin operations.

Parameters

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

Exceptions

nBaseAdminException If the user is not authorised for admin functions

com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.nRealmAdmin	(	final nSessionAttributes	sAttr,
		boolean	followMaster
	)		throws nBaseAdminException

Constructs a link with the realm server for admin operations.

Parameters

sAttr	nSessionAttributes representing the realm you wish to communicate with
followMaster	if set, this class will attempt to stay connected to the master realm

Exceptions

nBaseAdminException If the user is not authorised for admin functions

com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.nRealmAdmin	(	final nSessionAttributes	sAttr,
		final String	username,
		boolean	followMaster
	)		throws nBaseAdminException

Constructs a link with the realm server for admin operations.

Parameters

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

Exceptions

nBaseAdminException If the user is not authorised for admin functions

com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.nRealmAdmin	(	final nSessionAttributes	sAttr,
		final String	username,
		final String	password,
		boolean	followMaster
	)		throws nBaseAdminException

Constructs a link with the realm server for admin operations.

Parameters

sAttr	nSessionAttributes representing the realm you wish to communicate with
password	Password to use to login to the server
username	Username to use to login to the server
followMaster	if set, this class will attempt to stay connected to the master realm

Exceptions

nBaseAdminException If the user is not authorised for admin functions

Member Function Documentation

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.addACLEntries	(	nACL	entries,
		nAbstractChannel	obj
	)		throws nBaseAdminException

Adds a list of acl entries to the channel or queue acl.

Parameters

entries	An nACL list containing the subjects and permissions to add to the channel or queue acl
obj	the channel or queue

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.addACLEntries	(	nACL	acl,
		nAbstractChannel[]	objs
	)		throws nBaseAdminException

Adds a list of acl entries to all objects in an array of channels and / or queues.

Parameters

acl	the acl to apply
objs	the channels and / or queues to apply the acl to

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.addACLEntry	(	nACLEntry	entry,
		nAbstractChannel	obj
	)		throws nBaseAdminException

Adds a specific acl entry to the channel or queue acl.

Parameters

entry	An nACL entry containing the subject and permissions to add to the channel or queue acl
obj	the channel or queue

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.addACLEntry	(	nACLEntry	entry,
		nAbstractChannel[]	objs
	)		throws nBaseAdminException

Adds an acl entry to all objects in an array of channels and / or queues.

Parameters

entry	the acl to apply
objs	the channels and / or queues to apply the acl to

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.addRealmACLEntries ( nACL entry ) throws nBaseAdminException

Adds a list of acl entries to the realm acl.

Parameters

entry An nACL list containing the subjects and permissions to add to the realm acl

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.addRealmACLEntry ( nACLEntry entry ) throws nBaseAdminException

Adds a specific acl entry to the realm acl.

Parameters

entry An nACL entry containing the subject and permissions to add to the realm acl

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.addReconnectHandler ( nReconnectHandler handler )

Add a session reconnect handler to the underlying admin session.

Parameters

handler - the nReconnectHandler object for the underlying admin session

nChannel com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.createChannel	(	final com.pcbsys.nirvana.client.nChannelAttributes	attr,
		final nACL	initialACL,
		final long	initialEID,
		final nAbstractChannel	deadStore
	)		throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new channel on the realm this session is connected.

Parameters

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

Returns: an nChannel object representing the newly created nirvana channel

Exceptions

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

nChannel com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.createChannel	(	final com.pcbsys.nirvana.client.nChannelAttributes	attr,
		final nACL	initialACL,
		final long	initialEID
	)		throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new channel on the realm this session is connected.

Parameters

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

Returns: an nChannel object representing the newly created nirvana channel

Exceptions

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

nChannel com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.createChannel	(	final com.pcbsys.nirvana.client.nChannelAttributes	attr,
		final nACL	initialACL
	)		throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new channel on the realm this session is connected.

Parameters

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

Returns: an nChannel object representing the newly created nirvana channel

Exceptions

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

nChannel com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.createChannel ( final com.pcbsys.nirvana.client.nChannelAttributes attr ) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new channel on the realm this session is connected.

Parameters

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

Returns: an nChannel object representing the newly created nirvana channel

Exceptions

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

nQueue com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.createQueue	(	final com.pcbsys.nirvana.client.nChannelAttributes	attr,
		final nACL	initialACL,
		final nAbstractChannel	deadStore
	)		throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new queue on the realm this session is connected.

Parameters

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

Returns: an nQueue object representing the newly created nirvana queue

Exceptions

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

nQueue com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.createQueue	(	final com.pcbsys.nirvana.client.nChannelAttributes	attr,
		final nACL	initialACL
	)		throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new queue on the realm this session is connected.

Parameters

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

Returns: an nQueue object representing the newly created nirvana queue

Exceptions

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

nQueue com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.createQueue ( final com.pcbsys.nirvana.client.nChannelAttributes attr ) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException

Creates a new queue on the realm this session is connected.

Parameters

attr	The channel attributes object containing the parameters for the new queue to be created

Returns: an nQueue object representing the newly created nirvana queue

Exceptions

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

nACL com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.getACL ( nAbstractChannel obj ) throws nBaseAdminException

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.

Parameters

obj	the channel or queue to obtain the current permissions for

Returns: The channel or queue nACL

Exceptions

nBaseAdminException If unable to successfully perform this operation, check the message for more information

Collection<fAclGroup> com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.getACLGroups ( ) throws nBaseClientException

Returns a list of all ACL groups defined on the realm.

Returns: A collection of ACL groups

Exceptions

nBaseClientException if the operation cannot be performed

String com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.getConnectedRealmName ( )

Return the name of the Nirvana Realm currently connected to.

Returns: the name of the Nirvana Realm currently connected to

nACL com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.getInterfaceACL ( String iface ) throws nBaseAdminException

Returns the nACL object passed for the interface in question.

Parameters

iface The name of the interface

Returns: An nACL containing nInterfaceViaEntry objects

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

synchronized nACL com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.getRealmACL ( ) throws nBaseAdminException

Returns the current ACL on the Nirvana Realm.

This call makes a synchronous call to the realm to obtain the current acl list.

Returns: The realm nACL

Exceptions

nBaseAdminException If unable to successfully perform this operation, check the message for more information

nSession com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.getSession ( )

Returns the nSession object for this RealmAdmin.

Returns: The com.pcbsys.nirvana.client.nSession object

See Also: com.pcbsys.nirvana.client.nSession

boolean com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.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.

This method will determine whether the underlying nSession is actually connected to the master realm

Returns: true when connected to the master realm, false if not

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.modACLEntries	(	nACL	entries,
		nAbstractChannel	obj
	)		throws nBaseAdminException

Modifies a list of acl entries in the channel or queue acl.

Parameters

entries	An nACL list containing the subjects and permissions to remove from the channel or queue acl
obj	the channel or queue

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.modACLEntry	(	nACLEntry	entry,
		nAbstractChannel	obj
	)		throws nBaseAdminException

Modifies a specific acl entry's permissions in the channel or queue.

Parameters

entry An nACL entry containing the subject and permissions to modify in the channel or queue acl

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.modRealmACLEntries ( nACL entry ) throws nBaseAdminException

Modifies the acl entries in the list of realm acl entries.

Parameters

entry An nACL list containing the subjects and permissions to modify in the realm

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.modRealmACLEntry ( nACLEntry entry ) throws nBaseAdminException

Modifies a specific acl entry's permissions in the realm acl.

Parameters

entry An nACL entry containing the subject and permissions to modify in the realm node

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.removeACLEntries	(	nACL	entries,
		nAbstractChannel	obj
	)		throws nBaseAdminException

Removes a list of acl entries from the channel or queue acl.

Parameters

entries	An nACL list containing the subjects and permissions to remove from the channel or queue acl
obj	the channel or queue

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.removeACLEntries	(	nACL	acl,
		nAbstractChannel[]	objs
	)		throws nBaseAdminException

Removes a list of acl entries from all objects in an array of channels and / or queues.

Parameters

acl	the acl to apply
objs	the channels and / or queues to apply the acl to

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.removeACLEntry	(	nACLEntry	entry,
		nAbstractChannel	obj
	)		throws nBaseAdminException

Removes a specific acl entry from the channel or queue acl.

Parameters

entry	An nACL entry containing the subject and permissions to remove from the channel or queue acl
obj	the channel or queue

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.removeACLEntry	(	nACLEntry	entry,
		nAbstractChannel[]	objs
	)		throws nBaseAdminException

Removes an acl entry from all objects in an array of channels and / or queues.

Parameters

entry	the acl to apply
objs	the channels and / or queues to apply the acl to

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.removeRealmACLEntries ( nACL entry ) throws nBaseAdminException

Removes a list of acl entries from the realm acl.

Parameters

entry An nACL list containing the subjects and permissions to remove from the realm acl

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.removeRealmACLEntry ( nACLEntry entry ) throws nBaseAdminException

Removes a specific acl entry from the realm acl.

Parameters

entry An nACL entry containing the subject and permissions to remove from the realm acl

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.setACL	(	nACL	acl,
		nAbstractChannel	obj
	)		throws nBaseAdminException

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.

Parameters

acl	A nACL containing list of subjects and permissions
obj	The channel or queue to set the acl on

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.setInterfaceACL	(	String	iface,
		nACL	acl
	)		throws nBaseAdminException

Commits the nACL object passed in with the Realm Server for the specified interface.

Parameters

iface	The name of the interface
acl	A nACL containing nInterfaceViaEntry objects

Exceptions

nBaseAdminException if unable to perform the operation, check the message for further information

synchronized void com.pcbsys.nirvana.nAdminAPI.nRealmAdmin.setRealmACL ( final nACL acl ) throws nBaseAdminException

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.

Parameters

acl	A nACL containing nRealmACLEntry

Exceptions

nBaseAdminException If unable to successfully perform this operation, check the message for more information

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation