com.groiss.wf.batch

Class BatchManager

java.lang.Object

com.groiss.wf.batch.BatchManager

All Implemented Interfaces:

TimerTask

public class BatchManager
extends Object
implements TimerTask

Starts and completes BatchJobs. Provides methods for creation of jobs and to mark them as finished.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_ON_COMPLETE

Constructor Summary

Constructors

Constructor and Description
BatchManager()

Method Summary

Modifier and Type	Method and Description
static void	abortBatchJob(ActivityInstance ai)
protected String	adaptQueryForExecutor(String q)
void	compensate(ActivityInstance ai)
static void	completeJob(BatchJob bj) Complete a started BatchJob.
static void	completeJob(BatchJob bj, int resultCode) Complete a started BatchJob.
static void	completeJob(BatchJob bj, int resultCode, String resultvalues) Complete a started BatchJob.
static void	exceptionHandlingFinished(String id)
protected static BatchAdapter	getBatchAdapter(String adapterClassName)
protected List<BatchJob>	getBatchJobs(String operationName, String query, String orderBy, Object... params)
static Pair<Date,String>	getCurrentOperation(BatchJob bj)
static Map<Long,Pair<Date,String>>	getCurrentOperations()
static BatchJob	getFreshBatchJob(BatchJob bj) Gets a current copy (a fresh incarnation) of the batch job from the database.
static boolean	hasNoCurrentOperations()
protected boolean	isMainManager()
static void	markJobError(BatchJob bj, Exception ex) Mark a BatchJob as erroneous.
static void	markJobError(BatchJob bj, int resultCode, String resultValue, Exception ex) Mark a BatchJob as erroneous.
static void	markJobFinished(BatchJob bj) Mark a a started BatchJob as finished.
static void	markJobFinished(BatchJob bj, int resultCode) Mark a started BatchJob as finished.
static void	markJobFinished(BatchJob bj, int resultCode, String resultvalues) Mark a started BatchJob as finished.
static void	markJobPoll(BatchJob bj, int resultCode, String resultValue, Throwable ex) Mark a started BatchJob as pollable.
static void	markJobPoll(BatchJob bj, Throwable ex) Mark a started BatchJob as pollable.
static void	markJobRetry(BatchJob bj, int resultCode, String resultValue, Throwable ex) Mark a created BatchJob as 'startretry'.
static void	markJobRetry(BatchJob bj, Throwable ex) Mark a created BatchJob as 'startretry'.
static void	markJobSuspendPoll(BatchJob bj, int resultCode, String resultValue, Throwable ex) Mark a created BatchJob as suspended from further poll attempts.
static void	markJobSuspendPoll(BatchJob bj, Throwable ex) Mark a created BatchJob as suspended from further poll attempts.
static void	markJobSuspendRetry(BatchJob bj, Exception ex) Mark a created BatchJob as suspended from further start attempts.
static void	markJobSuspendRetry(BatchJob bj, int resultCode, String resultValue, Exception ex) Mark a created BatchJob as suspended from further start attempts.
protected static void	pollJob(BatchJob bj, BatchAdapter adapter) Poll if a BatchJob is finished.
protected static void	pollJobHere(BatchJob bj, BatchAdapter adapter) Poll, if a BatchJob is finished in the current thread.
static void	reactivateBatchJob(ActivityInstance ai)
void	run(TimerEntry te, String args) the TimerTask interface
protected static void	startJob(BatchJob bj, BatchAdapter adapter) Start a BatchJob.
protected static void	startJobHere(BatchJob bj, BatchAdapter adapter) Start a BatchJob in the current thread.
void	submitJob(String adapterClassName) Method submitJob submits a BatchJob for later execution.
void	submitJob(String adapterClassName, String param) Method submitJob submits a BatchJob for later execution.
void	submitJob(String adapterClassName, String params, String execModes) Method submitJob submits a BatchJob for later execution.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.groiss.timer.TimerTask

abort

Field Detail

ERROR_ON_COMPLETE

public static final String ERROR_ON_COMPLETE

See Also:

Constant Field Values

Constructor Detail

BatchManager

public BatchManager()

Method Detail

getBatchAdapter

protected static BatchAdapter getBatchAdapter(String adapterClassName)

getCurrentOperation

public static Pair<Date,String> getCurrentOperation(BatchJob bj)

hasNoCurrentOperations

public static boolean hasNoCurrentOperations()

getCurrentOperations

public static Map<Long,Pair<Date,String>> getCurrentOperations()

submitJob

public void submitJob(String adapterClassName,
                      String params,
                      String execModes)
               throws Exception

Method submitJob submits a BatchJob for later execution. It creates a new BatchJob and inserts it into the database. After that, method afterCreation of the class with name adapterClassName is called.

Parameters:

adapterClassName - name of a Class implementing BatchAdapter

params - additional params for the execution can be passed in this String

execModes - attributes for behaviour variations

Throws:

Exception -
execModes is a string where the behavior modifications of a batchjob can be encoded in the following form: "STARTNOW=1,AUTOFINISH=1,NEWTHREAD=1,GOBACKONERROR=1" Behavior Variations

getFreshBatchJob

public static BatchJob getFreshBatchJob(BatchJob bj)

Gets a current copy (a fresh incarnation) of the batch job from the database.

Can be used to get the (possibly concurrently modified) current instance of the batch job.

If the configuration property ep.batch.avoid.getcurrentjobstate is set to true, the method does nothing and returns exactly the passed batchjob.

Parameters:

bj - the batch job to get a fresh copy of

Returns:

the current copy of the batch job

submitJob

public void submitJob(String adapterClassName)
               throws Exception

Method submitJob submits a BatchJob for later execution. Calls submitJob with null as params and default execModes

Throws:

Exception

submitJob

public void submitJob(String adapterClassName,
                      String param)
               throws Exception

Method submitJob submits a BatchJob for later execution. Calls submitJob with default execModes

Throws:

Exception

markJobRetry

public static void markJobRetry(BatchJob bj,
                                Throwable ex)

Mark a created BatchJob as 'startretry'. Typically used in doStart() of the BatchAdapter, if the batch job has not (yet) been marked as 'startretry' and such a retry is desired.
Runs in the same transaction as the caller. The exception does not have any special semantics for the system, it will be used to get a resultCode and a resultValue, if the BatchAdapter implements ExceptionBatchAdapter.
The BatchManager (or the assigned executor) will try to start the job on its next run.

Parameters:

bj - the BatchJob to mark

markJobRetry

public static void markJobRetry(BatchJob bj,
                                int resultCode,
                                String resultValue,
                                Throwable ex)

Mark a created BatchJob as 'startretry'. Typically used in doStart() of the BatchAdapter, if the batch job has not (yet) been marked as 'startretry' and such a retry is desired.
Runs in the same transaction as the caller. The exception does not have any special semantics. Resultcode and resultvalue do not have any special semantics for the system.
The BatchManager (or the assigned executor) will try to start the job on its next run.

Parameters:

bj - the BatchJob to mark

resultCode - the result code to set on the batchjob

resultValue - the result value to set on the batchJob

markJobError

public static void markJobError(BatchJob bj,
                                Exception ex)

Mark a BatchJob as erroneous. Typically used in doStart() or doPoll(), to avoid further start attempts or polling attempts. The batch job will be placed in state BatchJob.STARTERROR or BatchJob.FINISHERROR.
Runs in the same transaction as the caller. The exception does not have any special semantics, it will be used to get a resultCode and a resultValue, if the BatchAdapter implements ExceptionBatchAdapter.

Parameters:

bj - the BatchJob to mark

markJobError

public static void markJobError(BatchJob bj,
                                int resultCode,
                                String resultValue,
                                Exception ex)

Mark a BatchJob as erroneous. Typically used in doStart() or doPoll(), to avoid further start attempts or polling attempts. The batch job will be placed in state BatchJob.STARTERROR or BatchJob.FINISHERROR.
Runs in the same transaction as the caller. The exception does not have any special semantics, it will be used to get a resultCode and a resultValue, if the BatchAdapter implements ExceptionBatchAdapter.

Parameters:

bj - the BatchJob to mark

resultCode - the result code to set on the batchjob

resultValue - the result value to set on the batchJob

markJobSuspendRetry

public static void markJobSuspendRetry(BatchJob bj,
                                       Exception ex)

Mark a created BatchJob as suspended from further start attempts. Typically used in doStart() of the BatchAdapter, if the batch job has been marked as 'startretry' and such a retry is not desired anymore.
Runs in the same transaction as the caller. The exception does not have any special semantics, it will be used to get a resultCode and a resultValue, if the BatchAdapter implements ExceptionBatchAdapter.
The batch job will be in state BatchJob.CREATED afterwards. The BatchManager (or the assigned executor) will not try to start the job in subsequent runs.
The start attempts can be resumed again by marking the batch job via markJobRetry(BatchJob, Throwable).

Parameters:

bj - the BatchJob to mark

markJobSuspendRetry

public static void markJobSuspendRetry(BatchJob bj,
                                       int resultCode,
                                       String resultValue,
                                       Exception ex)

Mark a created BatchJob as suspended from further start attempts. Typically used in doStart() of the BatchAdapter, if the batch job has been marked as 'startretry' and such a retry is not desired anymore.
Runs in the same transaction as the caller. The exception does not have any special semantics. Resultcode and resultvalue do not have any special semantics for the system.
The batch job will be in state BatchJob.CREATED afterwards. The BatchManager (or the assigned executor) will not try to start the job in subsequent runs.
The start attempts can be resumed again by marking the batch job via markJobRetry(BatchJob, Throwable).

Parameters:

bj - the BatchJob to mark

resultCode - the result code to set on the batchjob

resultValue - the result value to set on the batchJob

markJobSuspendPoll

public static void markJobSuspendPoll(BatchJob bj,
                                      Throwable ex)

Mark a created BatchJob as suspended from further poll attempts. Typically used in doPoll() of the BatchAdapter, if the batch job has been marked as 'pollfinish' and such a polling is not desired anymore.
Runs in the same transaction as the caller. The exception does not have any special semantics, it will be used to get a resultCode and a resultValue, if the BatchAdapter implements ExceptionBatchAdapter.
The batch job will be in state BatchJob.STARTED afterwards. The BatchManager (or the assigned executor) will not try to poll for job completion in subsequent runs.
The poll attempts can be resumed again by marking the batch job via markJobPoll(BatchJob, Throwable).

Parameters:

bj - the BatchJob to mark

markJobSuspendPoll

public static void markJobSuspendPoll(BatchJob bj,
                                      int resultCode,
                                      String resultValue,
                                      Throwable ex)

Mark a created BatchJob as suspended from further poll attempts. Typically used in doPoll() of the BatchAdapter, if the batch job has been marked as 'pollfinish' and such a polling is not desired anymore.
Runs in the same transaction as the caller. The exception does not have any special semantics. Resultcode and resultvalue do not have any special semantics for the system.
The batch job will be in state BatchJob.STARTED afterwards. The BatchManager (or the assigned executor) will not try to poll for job completion in subsequent runs.
The poll attempts can be resumed again by marking the batch job via markJobPoll(BatchJob, Throwable).

Parameters:

bj - the BatchJob to mark

resultCode - the result code to set on the batchjob

resultValue - the result value to set on the batchJob

markJobPoll

public static void markJobPoll(BatchJob bj,
                               Throwable ex)

Mark a started BatchJob as pollable. Typically used in doStart() of the BatchAdapter, if the batch job has been not been marked as 'pollfinish' and such a polling is desired.
Runs in the same transaction as the caller. The exception does not have any special semantics, it will be used to get a resultCode and a resultValue, if the BatchAdapter implements ExceptionBatchAdapter.
The BatchManager (or the assigned executor) will try to poll for job completion in subsequent runs.
The poll attempts can be suspended again by marking the batch job via markJobSuspendPoll(BatchJob, Throwable).

Parameters:

bj - the BatchJob to mark

markJobPoll

public static void markJobPoll(BatchJob bj,
                               int resultCode,
                               String resultValue,
                               Throwable ex)

Mark a started BatchJob as pollable. Typically used in doStart() of the BatchAdapter, if the batch job has been not been marked as 'pollfinish' and such a polling is desired.
Runs in the same transaction as the caller. The exception does not have any special semantics. Resultcode and resultvalue do not have any special semantics for the system.
The BatchManager (or the assigned executor) will try to poll for job completion in subsequent runs.
The poll attempts can be suspended again by marking the batch job via markJobSuspendPoll(BatchJob, Throwable).

Parameters:

bj - the BatchJob to mark

resultCode - the result code to set on the batchjob

resultValue - the result value to set on the batchJob

markJobFinished

public static void markJobFinished(BatchJob bj)
                            throws Exception

Mark a a started BatchJob as finished. Typically used from an external execution context or from doPoll() in the BatchAdapter. Runs in the same transaction as the caller. Neither resultcode nor result have any special semantics for the BatchManager. Their meaning must be interpreted properly by the corresponding BatchAdapter.
The BatchManager will complete the job on its next run.

Parameters:

bj - the BatchJob to mark

Throws:

Exception - when the BatchJob is not in state BatchJob.STARTED.

markJobFinished

public static void markJobFinished(BatchJob bj,
                                   int resultCode)
                            throws Exception

Mark a started BatchJob as finished. Typically used from an external execution context or from doPoll() in the BatchAdapter. Runs in the same transaction as the caller. Neither resultcode nor result have any special semantics for the BatchManager. Their meaning must be interpreted properly by the corresponding BatchAdapter.
The BatchManager will complete the job on its next run.

Parameters:

bj - the BatchJob to mark

resultCode - an int to indicate a result condition throws Exception when the BatchJob is not in state BatchJob.STARTED.

Throws:

Exception

markJobFinished

public static void markJobFinished(BatchJob bj,
                                   int resultCode,
                                   String resultvalues)
                            throws Exception

Mark a started BatchJob as finished. Typically used from an external execution context or from doPoll() in the BatchAdapter. Runs in the same transaction as the caller. Neither resultcode nor result have any special semantics for the BatchManager. Their meaning must be interpreted properly by the corresponding BatchAdapter.
The BatchManager will complete the job on its next run.

Parameters:

bj - the BatchJob to mark

resultCode - an int to indicate a result condition

resultvalues - a String to transport some results

Throws:

Exception - when the BatchJob is not in state BatchJob.STARTED.

exceptionHandlingFinished

public static void exceptionHandlingFinished(String id)

run

public void run(TimerEntry te,
                String args)

the TimerTask interface

Specified by:

run in interface TimerTask

Parameters:

te - the persistent timer entry

args - the argument string defined in the timer entry.

isMainManager

protected boolean isMainManager()

adaptQueryForExecutor

protected String adaptQueryForExecutor(String q)

getBatchJobs

protected List<BatchJob> getBatchJobs(String operationName,
                                      String query,
                                      String orderBy,
                                      Object... params)

startJob

protected static void startJob(BatchJob bj,
                               BatchAdapter adapter)

Start a BatchJob. Create a new worker thread for the job if isNewThred of bj returns true. If bj.isAutofinish() returns true, the job is finished and completed also.

Parameters:

bj - the Batchjob to start

adapter - the corresponding adapter

startJobHere

protected static void startJobHere(BatchJob bj,
                                   BatchAdapter adapter)

Start a BatchJob in the current thread. If bj.isAutofinish() returns true, the job is finished and completed also.

Parameters:

bj - the Batchjob to start

adapter - the corresponding adapter

pollJob

protected static void pollJob(BatchJob bj,
                              BatchAdapter adapter)

Poll if a BatchJob is finished. T.B.D: Create a new worker thread for the job if isNewThred of bj returns true. T.B.D: ??? If bj.isAutofinish() returns true, the job is finished and completed also.

Parameters:

bj - the Batchjob to start

adapter - the corresponding adapter

pollJobHere

protected static void pollJobHere(BatchJob bj,
                                  BatchAdapter adapter)

Poll, if a BatchJob is finished in the current thread. T.B.D.: If so, it is also completed ?

Parameters:

bj - the Batchjob to start

adapter - the corresponding adapter

completeJob

public static void completeJob(BatchJob bj)
                        throws Exception

Complete a started BatchJob. Marks the Job as finished and then completes the Job. Also finishes the originating StepInstance.
Can be used to avoid the delay between marking a job as finished and the next run of the BatchManager. Issues BeanManager.commit() or BeanManager.rollback().
During completion, BatchAdapter.beforeCompletion(BatchJob) and BatchAdapter.afterCompletion(BatchJob, boolean) will be called. After completeJob, BatchJob.getJobstate() can be used to inquire about the outcome of the operation.

Parameters:

bj - the BatchJob to complete.

Throws:

Exception - when the BatchJob is not in state BatchJob.STARTED.

completeJob

public static void completeJob(BatchJob bj,
                               int resultCode)
                        throws Exception

Complete a started BatchJob. Marks the Job as finished and then completes the Job. Also finishes the originating StepInstance.
Can be used to avoid the delay between marking a job as finished and the next run of the BatchManager. Issues BeanManager.commit() or BeanManager.rollback().
During completion, BatchAdapter.beforeCompletion(BatchJob) and BatchAdapter.afterCompletion(BatchJob, boolean) will be called. After completeJob, BatchJob.getJobstate() can be used to inquire about the outcome of the operation.

Parameters:

bj - the BatchJob to complete.

resultCode - an int to indicate a result condition

Throws:

Exception - when the BatchJob is not in state BatchJob.STARTED.

completeJob

public static void completeJob(BatchJob bj,
                               int resultCode,
                               String resultvalues)
                        throws Exception

Complete a started BatchJob. Marks the Job as finished and then completes the Job. Also finishes the originating StepInstance.
Can be used to avoid the delay between marking a job as finished and the next run of the BatchManager. Issues BeanManager.commit() or BeanManager.rollback().
During completion, BatchAdapter.beforeCompletion(BatchJob) and BatchAdapter.afterCompletion(BatchJob, boolean) will be called. After completeJob, BatchJob.getJobstate() can be used to inquire about the outcome of the operation.

Parameters:

bj - the BatchJob to complete.

resultCode - an int to indicate a result condition

resultvalues - a String to transport some results

Throws:

Exception - when the BatchJob is not in state BatchJob.STARTED.

compensate

public void compensate(ActivityInstance ai)

abortBatchJob

public static void abortBatchJob(ActivityInstance ai)

reactivateBatchJob

public static void reactivateBatchJob(ActivityInstance ai)