org.jberet.spi

Class JobExecutor

java.lang.Object

org.jberet.spi.JobExecutor

All Implemented Interfaces:

Executor

public abstract class JobExecutor
extends Object
implements Executor

An executor service to be used with batch jobs. Implementations of JBeret should use this to execute batch tasks. Some tasks require special handling and therefore need to be queued before they can be run in some circumstances.

Partition jobs require some special handling with executors. Extending this in implementations will give the desired behavior to the implementing class. Note that getMaximumPoolSize() should return a value greater than 2.

Author:

James R. Perkins

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JobExecutor(Executor delegate) Creates a new executor.

Method Summary

Modifier and Type	Method and Description
void	execute(JobTask task) Executes the given task at some time in the future.
void	execute(Runnable runnable)
protected abstract int	getMaximumPoolSize() Returns the maximum number of threads allowed to be executed.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobExecutor

protected JobExecutor(Executor delegate)

Creates a new executor.

Parameters:

delegate - the executor that tasks should be submitted to when they are able to run

Method Detail

getMaximumPoolSize

protected abstract int getMaximumPoolSize()

Returns the maximum number of threads allowed to be executed. The value returned must be greater than 0.

Returns:

the maximum number of threads allowed to be executed

execute

public final void execute(Runnable runnable)

Specified by:

execute in interface Executor

execute

public final void execute(JobTask task)

Executes the given task at some time in the future.

If the JobTask.getRequiredRemainingPermits() is any value greater than 0 then the task may be queued for later execution if the number of permits used is greater than the maximum permits allowed plus the number of remaining permits required.

As an example if the maximum number of permits allowed is 5 and 4 threads are executing an invocation with 2 JobTask.getRequiredRemainingPermits() would be queued.

Parameters:

task - the task to run