Manages the scheduler entries for a realm. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nSchedulerManager:

Public Member Functions
void	add (String source, String subject, boolean isClusterWide) throws nBaseClientException, nSchedulerParseException
	Adds a scheduler to the realm/cluster. More...

void	closed (nRealmNode node)
	Called when the nRealmNode is closed, for internal use only. More...

void	delete (nScheduler scheduler) throws nBaseClientException
	Deletes a known scheduled entry from the server. More...

java.util.Hashtable	getHelp ()
	Returns a Hashtable where the key is the name of the trigger/task while the data contains the help for the specific trigger/task. More...

String[]	getTaskNames ()
	Method that returns an array of task names available from the server. More...

String[]	getTriggerNames ()
	Method that returns an array of trigger names available from the server. More...

void	validate (String source) throws nSchedulerParseException
	Will validate the source and if valid will return, else will throw a nSchedulerParseException indicating further information regarding the syntax problem. More...

Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nContainer
void	addACLEntries (nACL acl) throws nAdminIllegalArgumentException, nBaseAdminException
	Adds a list acl entry to all nodes. More...

void	addACLEntries (nACL acl, nNode[] nodes) throws nAdminIllegalArgumentException, nBaseAdminException
	Adds a list acl entry to all nodes contained with in the array of nNodes. More...

void	addACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Adds a specific acl entry to all known nodes within the nContainer node. More...

void	addACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Adds a specific acl entry to all known nodes within the nContainer node. More...

void	addACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Adds a specific acl entry to all known nodes within the nContainer node. More...

void	addACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices, boolean realm) throws nBaseAdminException
	Adds a specific acl entry to all known nodes within the nContainer node. More...

void	addACLEntry (boolean realmLevel, nACLEntry entry, boolean allChannels, boolean allQueues) throws nBaseAdminException
	Adds a specific acl entry to all known nodes within the nContainer node. More...

void	closed (nRealmNode node)
	Called when the nRealmNode is closed, for internal use only. More...

nNode	findNode (String name) throws nAdminIllegalArgumentException
	Given a name of the form /container/container/name this function will locate the name object and return it, or null if that object can not be found. More...

nNode	findNode (nNode node) throws nAdminIllegalArgumentException
	Given a name of the form /container/container/name this function will locate the nNode object and return it, or null if that can not be found. More...

nNode	findNode (nNode node, boolean searchChildren) throws nAdminIllegalArgumentException
	Given a name of the form /container/container/name this function will locate the name object and return it, or null if that can not be found. More...

nNode	getNextSibling ()
	Method to return the next sibling from this node's parent. More...

Enumeration	getNodes ()
	Returns an Enumeration of all the nodes under this container. More...

nRealmNode	getRealmAt (String name) throws nAdminIllegalArgumentException
	Given a mount point this function will return a realm if one exists at the specified mount point. More...

nRealmNode	getRealmNode ()
	Get the realm node at the root of this container node. More...

int	getSize ()
	Returns the number of nodes under this container. More...

int	getTotalNodes ()
	Returns the total number of nodes within this container and all subsequent children by traversing the entire structure beneath this container node. More...

boolean	hasRealmAt (String name) throws nAdminIllegalArgumentException
	Given a mount point this function will determine if this container contains a mounted realm at the specified mount point. More...

void	modACLEntries (nACL acl) throws nAdminIllegalArgumentException, nBaseAdminException
	Modifies a list of acl entry to all known nodes within the nContainer node. More...

void	modACLEntries (nACL acl, nNode[] nodes) throws nAdminIllegalArgumentException, nBaseAdminException
	Modifies a list of acl entry to all nodes contained with in the array of nNodes. More...

void	modACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	modifies a specific acl entry's permissions for all known nodes within the nContainer node. More...

void	modACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	modifies a specific acl entry's permissions for all known nodes within the nContainer node. More...

void	modACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	modifies a specific acl entry's permissions for all known nodes within the nContainer node. More...

void	modACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices, boolean realm) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	modifies a specific acl entry's permissions for all known nodes within the nContainer node. More...

void	modACLEntry (boolean realmLevel, nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	modifies a specific acl entry's permissions for all known nodes within the nContainer node. More...

void	removeACLEntries (nACL acl) throws nAdminIllegalArgumentException, nBaseAdminException
	Removes a list of acl entries from all known nodes within the nContainer node. More...

void	removeACLEntries (nACL acl, nNode[] nodes) throws nAdminIllegalArgumentException, nBaseAdminException
	Removes a list of acl entries from all nodes contained with in the array of nNodes. More...

void	removeACLEntry (nACLEntry entry) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	removes a specific acl entry from all known nodes within the nContainer node. More...

void	removeACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	removes a specific acl entry from all known nodes within the nContainer node. More...

void	removeACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	removes a specific acl entry from all known nodes within the nContainer node. More...

void	removeACLEntry (nACLEntry entry, boolean allChannels, boolean allQueues, boolean allServices, boolean realm) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Removes a specific acl entry from all known nodes within the nContainer node. More...

void	removeACLEntry (boolean realmLevel, nACLEntry entry, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Removes a specific acl entry from all known nodes within the nContainer node. More...

void	setACL (nACL acl) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Changes the entire ACL entries for all nodes within this container node. More...

void	setACL (nACL acl, boolean allChannels, boolean allQueues, boolean allServices) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Changes the entire ACL entries for the selected nodes with the new ACL passed in. More...

void	setACL (nACL acl, boolean allChannels, boolean allQueues) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
	Changes the entire ACL entries for the selected nodes with the new ACL passed in. 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...

Detailed Description

Manages the scheduler entries for a realm.

Member Function Documentation

void com.pcbsys.nirvana.nAdminAPI.nSchedulerManager.add	(	String	source,
		String	subject,
		boolean	isClusterWide
	)		throws nBaseClientException, nSchedulerParseException

Adds a scheduler to the realm/cluster.

Parameters

source	of the scheduler to add.
subject	subject to run the scheduler as.
isClusterWide	send to the cluster or to the specified realm only.

Exceptions

nBaseClientException	if unable to communicate with the Realm Server.
nSchedulerParseException	if the scheduler has a syntax error.

void com.pcbsys.nirvana.nAdminAPI.nSchedulerManager.closed ( nRealmNode node )

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

Parameters

node	The nRealmNode which has been closed.

void com.pcbsys.nirvana.nAdminAPI.nSchedulerManager.delete ( nScheduler scheduler ) throws nBaseClientException

Deletes a known scheduled entry from the server.

Parameters

scheduler to be deleted.

Exceptions

nBaseClientException if unable to communicate with the realm.

java.util.Hashtable com.pcbsys.nirvana.nAdminAPI.nSchedulerManager.getHelp ( )

Returns a Hashtable where the key is the name of the trigger/task while the data contains the help for the specific trigger/task.

Returns: Hashtable.

String [] com.pcbsys.nirvana.nAdminAPI.nSchedulerManager.getTaskNames ( )

Method that returns an array of task names available from the server.

Returns: an array of task names

String [] com.pcbsys.nirvana.nAdminAPI.nSchedulerManager.getTriggerNames ( )

Method that returns an array of trigger names available from the server.

Returns: an array of trigger names

void com.pcbsys.nirvana.nAdminAPI.nSchedulerManager.validate ( String source ) throws nSchedulerParseException

Will validate the source and if valid will return, else will throw a nSchedulerParseException indicating further information regarding the syntax problem.

Parameters

source of the scheduler.

Exceptions

nSchedulerParseException if the source is has syntax errors.

Public Member Functions

Detailed Description

Member Function Documentation