com.asakusafw.yaess.core

Class Job

java.lang.Object

com.asakusafw.yaess.core.Job

Direct Known Subclasses:

HandlerLifecycleJob, ScriptJob

public abstract class Job
extends Object

Represents an atomic job for YAESS.

Since:

0.2.3

Version:

0.5.0

Constructor Summary

Constructors

Constructor and Description
Job()

Method Summary

Modifier and Type	Method and Description
static String	computeTrackingId(ExecutionContext context) Computes the tracking ID for script-less job.
static String	computeTrackingId(ExecutionContext context, ExecutionScript script) Computes the tracking ID.
protected abstract void	execute(ExecutionMonitor monitor, ExecutionContext context) Executes this job.
abstract Set<String>	getBlockerIds() Returns job IDs which blocks executing this job.
abstract String	getId() Returns the ID of this job for other succeeding jobs.
abstract String	getJobLabel() Returns the target job label.
abstract String	getResourceId(ExecutionContext context) Returns the resource ID which this job requires in execution.
abstract String	getServiceLabel() Returns the service label which actually executes this job.
String	getTrackingId(ExecutionContext context) Returns the tracking ID of this job.
void	launch(ExecutionMonitor monitor, ExecutionContext context) Executes this job.

Methods inherited from class java.lang.Object

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

Constructor Detail

Job

public Job()

Method Detail

launch

public final void launch(ExecutionMonitor monitor,
                         ExecutionContext context)
                  throws InterruptedException,
                         IOException

Executes this job.

Parameters:

monitor - a progress monitor for this job

context - current execution context

Throws:

InterruptedException - if this execution is interrupted

IOException - if failed to execute this job

IllegalArgumentException - if some parameters were null

Since:

0.2.6

execute

protected abstract void execute(ExecutionMonitor monitor,
                                ExecutionContext context)
                         throws InterruptedException,
                                IOException

Executes this job.

Parameters:

monitor - a progress monitor for this job

context - current execution context

Throws:

InterruptedException - if this execution is interrupted

IOException - if failed to execute this job

getJobLabel

public abstract String getJobLabel()

Returns the target job label.

Returns:

the target job label

getServiceLabel

public abstract String getServiceLabel()

Returns the service label which actually executes this job.

Returns:

the service label

getId

public abstract String getId()

Returns the ID of this job for other succeeding jobs.

Returns:

ID of this job

getTrackingId

public String getTrackingId(ExecutionContext context)

Returns the tracking ID of this job.

Parameters:

context - current execution context

Returns:

the tracking ID

Since:

0.5.0

computeTrackingId

public static String computeTrackingId(ExecutionContext context,
                                       ExecutionScript script)

Computes the tracking ID.

Parameters:

context - target context

script - target script

Returns:

the operation ID

Since:

0.5.0

computeTrackingId

public static String computeTrackingId(ExecutionContext context)

Computes the tracking ID for script-less job.

Parameters:

context - target context

Returns:

the operation ID

Since:

0.5.0

getBlockerIds

public abstract Set<String> getBlockerIds()

Returns job IDs which blocks executing this job. Any schedulers can execute this job only if all blocker jobs are completed.

Returns:

the blocker job IDs

getResourceId

public abstract String getResourceId(ExecutionContext context)
                              throws InterruptedException,
                                     IOException

Returns the resource ID which this job requires in execution.

Parameters:

context - current execution context

Returns:

the resource ID required in this job

Throws:

InterruptedException - if this execution is interrupted

IOException - if failed to execute this job