com.pcbsys.nirvana.nAdminAPI.nSchedulerManager Class Reference

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.
void	closed (nRealmNode node)
	Called when the nRealmNode is closed, for internal use only.
void	delete (nScheduler scheduler) throws nBaseClientException
	Deletes a known scheduled entry from the server.
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.
String[]	getTaskNames ()
	Method that returns an array of task names available from the server.
String[]	getTriggerNames ()
	Method that returns an array of trigger names available from the server.
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.

---

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.

Reimplemented from com.pcbsys.nirvana.nAdminAPI.nContainer.

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.