net.roboconf.dm.rest.client.delegates

Class SchedulerWsDelegate

java.lang.Object

net.roboconf.dm.rest.client.delegates.SchedulerWsDelegate

public class SchedulerWsDelegate
extends Object

Author:

Vincent Zurczak - Linagora

Constructor Summary

Constructors

Constructor and Description
SchedulerWsDelegate(com.sun.jersey.api.client.WebResource resource) Constructor.

Method Summary

Modifier and Type	Method and Description
String	createOrUpdateJob(String jobId, String jobName, String appName, String cmdName, String cron) Creates or updates a scheduled job.
void	deleteJob(String jobId) Deletes a scheduled job.
net.roboconf.core.model.runtime.ScheduledJob	getJobProperties(String jobId) Gets the properties of a scheduled job.
List<net.roboconf.core.model.runtime.ScheduledJob>	listAllJobs(String appName, String cmdName) Lists all the jobs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchedulerWsDelegate

public SchedulerWsDelegate(com.sun.jersey.api.client.WebResource resource)

Constructor.

Parameters:

resource - a web resource

Method Detail

listAllJobs

public List<net.roboconf.core.model.runtime.ScheduledJob> listAllJobs(String appName,
                                                                      String cmdName)

Lists all the jobs.

When no parameter is supplied, all the jobs are returned. When appName is supplied, only the jobs associated with this application are returned. When cmdName is also supplied, only the jobs associated with this application and this command are returned.

When cmdName is supplied but not appName, then no job is returned.

Returns:

a non-null list of scheduled jobs

createOrUpdateJob

public String createOrUpdateJob(String jobId,
                                String jobName,
                                String appName,
                                String cmdName,
                                String cron)
                         throws SchedulerWsException

Creates or updates a scheduled job.

Parameters:

jobId - the job's ID (null to create a new job)

jobName - the job's name

appName - the application's name

cmdName - the name of the commands file to execute

cron - the CRON expression to trigger the job

Returns:

the created (or updated) job

Throws:

SchedulerWsException - if the creation or the update failed

deleteJob

public void deleteJob(String jobId)
               throws SchedulerWsException

Deletes a scheduled job.

Parameters:

jobId - the job's ID

Throws:

SchedulerWsException - if the deletion failed

getJobProperties

public net.roboconf.core.model.runtime.ScheduledJob getJobProperties(String jobId)
                                                              throws SchedulerWsException

Gets the properties of a scheduled job.

Parameters:

jobId - the job's ID

Throws:

SchedulerWsException - if the retrieving failed