Package de.uka.ipd.sdq.workflow.jobs

Class JobProxy

java.lang.Object

de.uka.ipd.sdq.workflow.jobs.JobProxy

All Implemented Interfaces:

IJob

Direct Known Subclasses:

BlackboardAwareJobProxy

public class JobProxy
extends Object
implements IJob

This class allows to register a job, which will be resolved shortly before it is executed.

Constructor Summary

Constructors

Constructor	Description
JobProxy(String name, Supplier<IJob> jobSupplier)
JobProxy(Supplier<IJob> jobSupplier)

Method Summary

Modifier and Type	Method	Description
void	cleanup(IProgressMonitor monitor)	Clean up all temporary side effects of this job.
void	execute(IProgressMonitor monitor)	Execute the job.
String	getName()	Supply a name of this job.
protected IJob	supplyJob()

Methods inherited from class java.lang.Object

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

Constructor Detail

JobProxy

public JobProxy(Supplier<IJob> jobSupplier)

JobProxy

public JobProxy(String name,
                Supplier<IJob> jobSupplier)

Method Detail

supplyJob

protected IJob supplyJob()

execute

public void execute(IProgressMonitor monitor)
             throws JobFailedException,
                    UserCanceledException

Description copied from interface: IJob

Execute the job. In case of an error throw an exception with a meaningful name which can be understood by a user.

Specified by:

execute in interface IJob

Parameters:

monitor - the monitor

Throws:

JobFailedException - the job failed

UserCanceledException - the user has chosen to abort the job

cleanup

public void cleanup(IProgressMonitor monitor)
             throws CleanupFailedException

Description copied from interface: IJob

Clean up all temporary side effects of this job. This method will always be called after executing this job to remove automatically created files and to leave the environment in a state in which the whole workflow run can be started again with the same results (i.e. in which executed can be called again). Usually, cleanup is called after the whole workflow is completed to allow other jobs to use intermediate results. In some cases, cleanup can be called earlier. However, in those cases, later jobs might not be able to access the intermediate data anymore.

Specified by:

cleanup in interface IJob

Parameters:

monitor - the monitor

Throws:

CleanupFailedException - Thrown if a critical error occurred during clean up so that the whole workflow should abort cleaning up further jobs.

getName

public String getName()

Description copied from interface: IJob

Supply a name of this job. This could be used for a progress monitor.

Specified by:

getName in interface IJob

Returns:

the name of the job