com.norconex.jef4.exec

Class SystemCommandJob

java.lang.Object

com.norconex.jef4.exec.SystemCommandJob

All Implemented Interfaces:

IJob

public class SystemCommandJob
extends Object
implements IJob

JEF job for executing an arbitrary number of commands. The job progress is relative to the number of commands to be processed. This is ideal for submitting a batch of small commands where execution time is not long enough to track individual command progresses. For long-running commands, you may want to create a custom job where you can keep track of the command progress and translate that somehow into a job progress (whenever possible).

Since:

1.1

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
SystemCommandJob(String id, String... commands) Creates a JEF job for executing system commands.
SystemCommandJob(String id, com.norconex.commons.lang.exec.SystemCommand... commands) Creates a JEF job for executing system commands.

Method Summary

Modifier and Type	Method and Description
void	execute(JobStatusUpdater statusUpdater, JobSuite suite) Executes this job.
String	getId() Gets the job unique identifier.
void	stop(IJobStatus status, JobSuite suite) Default implementation of this method will check if the SystemCommand it runs is currently holding to a Process process instance and destroys them.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemCommandJob

public SystemCommandJob(String id,
                        String... commands)

Creates a JEF job for executing system commands. This is a convenience constructor for taking multiple systems commands as string, every commands supplied are converted to SystemCommand instances internally.

Parameters:

id - job id

commands - array of individual commands to be executed

See Also:

SystemCommandJob(String, SystemCommand[])

SystemCommandJob

public SystemCommandJob(String id,
                        com.norconex.commons.lang.exec.SystemCommand... commands)

Creates a JEF job for executing system commands.

Parameters:

id - job id

commands - commands to be executed

Method Detail

getId

public String getId()

Description copied from interface: IJob

Gets the job unique identifier. All characters are valid and regular words can be used, as long as the returned string is unique.

Specified by:

getId in interface IJob

Returns:

job unique identifier

execute

public void execute(JobStatusUpdater statusUpdater,
                    JobSuite suite)

Description copied from interface: IJob

Executes this job. Implementors are responsible for updating execution progress on the given JobProgress.

Specified by:

execute in interface IJob

Parameters:

statusUpdater - status updater

suite - job suite this job is part of

stop

public void stop(IJobStatus status,
                 JobSuite suite)

Default implementation of this method will check if the SystemCommand it runs is currently holding to a Process process instance and destroys them. If no such instance is found, and even if one is found, there are no guarantees what will happen. Implementors having better ways to stop the invoked command should overwrite this method.

Specified by:

stop in interface IJob

Parameters:

status - current job status

suite - job suite this job is part of

Since:

2.0