de.innovationgate.wga.server.api

Class Jobs

java.lang.Object

de.innovationgate.wga.server.api.Jobs

public class Jobs
extends Object

Provides services regarding OpenWGA Jobs

Method Summary

Modifier and Type	Method and Description
String	getLogURL(String jobName) Returns an URL under which OpenWGA publishes the log of a running job OpenWGA publishes the log of running jobs under URLs that can be retrieved by this method.
List<String>	getNames() Returns the names of currently registered jobs
boolean	isRunning(String jobName) Tests if the given job is currently running This method will also return false if a job of the given name is not defined.
void	run(String jobName) Runs a job This will run a job just like it would have been run from the OpenWGA admin client manually.
void	run(String jobName, Map<String,Object> customOptions) Runs a job This will run a job just like it would have been run from the OpenWGA admin client manually.
String	runScriptModule(String design) Runs the code of a TMLScript module as a job Running a TMLScript module as a job is equivalent to creating a job, adding a single task of type "TMLScript" to it, and specifying a TMLScript module to run.
String	runScriptModule(String design, Map<String,Object> options) Runs the code of a TMLScript module as a job Running a TMLScript module as a job is equivalent to creating a job, adding a single task of type "TMLScript" to it, and specifying a TMLScript module to run.
String	runTask(Class<? extends TaskImplementation> taskClass, Map<String,Object> options) Runs a custom Java task implementation as transient job The job created and run by this method will be transient, which means that it will be gone again after it has finished running.
void	schedule(String jobName, String scheduleStr) Adds a schedule to an existing job
void	schedule(String jobName, String cronSchedule, Date startingDate, Date endingDate) Adds a schedule to an existing job This should only be used on jobs that are registered via some Designs configuration.
void	unschedule(String jobName) Removes all schedules from an existing job
void	waitWhileRunning(String jobName, int timeout) Pauses execution until the job is no longer running or the timeout is reached Use this method if you want to continue execution of the current thread not until a certain Job has finished execution.

Methods inherited from class java.lang.Object

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

Method Detail

run

public void run(String jobName)
         throws de.innovationgate.webgate.api.WGException

Runs a job This will run a job just like it would have been run from the OpenWGA admin client manually.

Parameters:

jobName - Name of the job

Throws:

WGAServerException

JobFailedException

de.innovationgate.webgate.api.WGException

run

public void run(String jobName,
                Map<String,Object> customOptions)
         throws de.innovationgate.webgate.api.WGException

Runs a job This will run a job just like it would have been run from the OpenWGA admin client manually.

Parameters:

jobName - Name of the job

customOptions - Optional additional options that will be available to the tasks of the job via JobContext.getOption(String)

Throws:

WGAServerException

JobFailedException

de.innovationgate.webgate.api.WGException

runScriptModule

public String runScriptModule(String design)
                       throws de.innovationgate.webgate.api.WGException

Runs the code of a TMLScript module as a job Running a TMLScript module as a job is equivalent to creating a job, adding a single task of type "TMLScript" to it, and specifying a TMLScript module to run. However the job created and run by this method will be transient, which means that it will be gone again after it has finished running. The job is given a generated job name which is returned by this method and can be used to monitor it.

Parameters:

design - Design reference of the TMLScript module that is to be run as job

Returns:

The job name of the running job

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

runScriptModule

public String runScriptModule(String design,
                              Map<String,Object> options)
                       throws de.innovationgate.webgate.api.WGException

Runs the code of a TMLScript module as a job Running a TMLScript module as a job is equivalent to creating a job, adding a single task of type "TMLScript" to it, and specifying a TMLScript module to run. However the job created and run by this method will be transient, which means that it will be gone again after it has finished running. The job is given a generated job name which is returned by this method and can be used to monitor it.

Parameters:

design - Design reference of the TMLScript module that is to be run as job

options - Optional additional options that will be available to the tasks of the job via JobContext.getOption(String)

Returns:

The job name of the running job

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

runTask

public String runTask(Class<? extends TaskImplementation> taskClass,
                      Map<String,Object> options)
               throws de.innovationgate.webgate.api.WGException

Runs a custom Java task implementation as transient job The job created and run by this method will be transient, which means that it will be gone again after it has finished running. The job is given a generated job name which is returned by this method and can be used to monitor it.

Parameters:

taskClass - Class of the task implementation

options - Options given to the job

Returns:

The job name of the running job

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

isRunning

public boolean isRunning(String jobName)
                  throws de.innovationgate.webgate.api.WGException

Tests if the given job is currently running This method will also return false if a job of the given name is not defined.

Parameters:

jobName - Name of the job

Throws:

de.innovationgate.webgate.api.WGException

waitWhileRunning

public void waitWhileRunning(String jobName,
                             int timeout)
                      throws de.innovationgate.webgate.api.WGException

Pauses execution until the job is no longer running or the timeout is reached Use this method if you want to continue execution of the current thread not until a certain Job has finished execution. If no job of that name is running while calling the method then the method returns directly.

Parameters:

jobName - Name of the job

timeout - Timeout in seconds

Throws:

de.innovationgate.webgate.api.WGException

getLogURL

public String getLogURL(String jobName)
                 throws de.innovationgate.webgate.api.WGException

Returns an URL under which OpenWGA publishes the log of a running job OpenWGA publishes the log of running jobs under URLs that can be retrieved by this method. However one must be logged in as OpenWGA administrator to view the job log.

Parameters:

jobName - Name of the job

Returns:

URL of the job log

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

getNames

public List<String> getNames()
                      throws de.innovationgate.webgate.api.WGException

Returns the names of currently registered jobs

Throws:

de.innovationgate.webgate.api.WGException

schedule

public void schedule(String jobName,
                     String cronSchedule,
                     Date startingDate,
                     Date endingDate)
              throws de.innovationgate.webgate.api.WGException

Adds a schedule to an existing job This should only be used on jobs that are registered via some Designs configuration. It should not be used for those jobs not created and configured in OpenWGA admin client as a reload of the OpenWGA configuration will clear schedules added by this method on those jobs.

Parameters:

jobName - The name of the job

cronSchedule - The CRON schedule string, having the known format from CRON schedules when configuring in admin client

startingDate - The date from which the job starts running or null for no starting date

endingDate - The date on which the job ends running or null for no ending date

Throws:

de.innovationgate.webgate.api.WGException

schedule

public void schedule(String jobName,
                     String scheduleStr)
              throws de.innovationgate.webgate.api.WGException

Adds a schedule to an existing job

Parameters:

jobName - The name of the job

scheduleStr - The CRON schedule string, having the known format from CRON schedules when configuring in admin client

Throws:

de.innovationgate.webgate.api.WGException

unschedule

public void unschedule(String jobName)
                throws de.innovationgate.webgate.api.WGException

Removes all schedules from an existing job

Parameters:

jobName - The name of the job

Throws:

de.innovationgate.webgate.api.WGException