ca.eandb.jdcp.client

Class ScriptFacade

java.lang.Object

ca.eandb.jdcp.client.ScriptFacade

public final class ScriptFacade
extends Object

An object provided to scripts to allow them to interface with JDCP.

Author:

Brad Kimmel

See Also:

ScriptCommand

Constructor Summary

Constructors

Constructor and Description
ScriptFacade(Configuration config) Creates a new ScriptFacade.

Method Summary

Modifier and Type	Method and Description
void	cancelJob(String jobId) Cancel the specified job.
void	cancelJob(UUID jobId) Cancel the specified job.
void	setIdleTime(int seconds) Sets the time (in seconds) that the JDCP server will instruct workers to idle if there are no jobs to be processed.
void	setJobPriority(UUID jobId, int priority) Sets the priority of the specified job.
UUID	submitJob(ParallelizableJob job) Submits a job to be processed.
UUID	submitJob(ParallelizableJob job, String description) Submits a job to be processed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptFacade

public ScriptFacade(Configuration config)

Creates a new ScriptFacade.

Parameters:

config - The application command line options.

Method Detail

setIdleTime

public void setIdleTime(int seconds)
                 throws Exception

Sets the time (in seconds) that the JDCP server will instruct workers to idle if there are no jobs to be processed.

Parameters:

seconds - The idle time (in seconds).

Throws:

Exception - if an error occurs in delegating the request to the configured job service

setJobPriority

public void setJobPriority(UUID jobId,
                           int priority)
                    throws Exception

Sets the priority of the specified job.

Parameters:

jobId - The UUID of the job for which to set the priority.

priority - The priority to assign to the job.

Throws:

Exception - if an error occurs in delegating the request to the configured job service

cancelJob

public void cancelJob(UUID jobId)
               throws Exception

Cancel the specified job.

Parameters:

jobId - The UUID identifying the job to cancel.

Throws:

Exception - if an error occurs in delegating the request to the configured job service

cancelJob

public void cancelJob(String jobId)
               throws Exception

Cancel the specified job.

Parameters:

jobId - A String representation of the UUID identifying the job to cancel.

Throws:

Exception - if an error occurs in delegating the request to the configured job service

submitJob

public UUID submitJob(ParallelizableJob job)
               throws Exception

Submits a job to be processed.

Parameters:

job - The ParallelizableJob to submit.

Returns:

The UUID identifying the submitted job.

Throws:

Exception - if an error occurs in delegating the request to the configured job service

submitJob

public UUID submitJob(ParallelizableJob job,
                      String description)
               throws Exception

Submits a job to be processed.

Parameters:

job - The ParallelizableJob to submit.

description - A description of the job.

Returns:

The UUID identifying the submitted job.

Throws:

Exception - if an error occurs in delegating the request to the configured job service