public class NullAdapter extends java.lang.Object implements BatchAdapter
BatchAdapter
.
Does logging but nothing else.Constructor and Description |
---|
NullAdapter() |
Modifier and Type | Method and Description |
---|---|
void |
afterCompletion(BatchJob job,
boolean commit)
The afterCompletion method notifies a BatchAdapter that a batchjob has completed.
|
void |
afterCreation(BatchJob job)
The afterCreation method notifies a batch adapter that a batchjob has been created.
|
void |
beforeCompletion(BatchJob job)
The beforeCompletion method notifies a BatchAdapter that a BatchJob is about to complete.
|
void |
doCompensate(BatchJob job) |
void |
doStart(BatchJob job)
The doStart Method is responsible for starting the batch job.
|
void |
startup()
Startup is called when the adapter is instantiated by the BatchManager.
|
public void startup() throws java.lang.Exception
BatchAdapter
startup
in interface BatchAdapter
java.lang.Exception
public void afterCreation(BatchJob job) throws java.lang.Exception
BatchAdapter
This usually happens via a Batchmanager.submitJob()
call.
It can be used to collect parameters from the process context.
If it makes any changes to the job
, job.update()
must be called.
It is typically executed from a preprocessing method of a Task
and is expected to
complete quickly.
If an Exception is thrown by afterCreation, this exception is not catched and will manifest in the context of the caller (usually a preprocessing method).
afterCreation
in interface BatchAdapter
job
- a BatchJobjava.lang.Exception
public void doStart(BatchJob job) throws java.lang.Exception
BatchAdapter
It has to start the batch job in some external execution context. If it runs in the JVM itself, it is expected to complete quickly. The method is executed via the Batch Timer for each BatchJob, which is in state BatchJob.CREATED and whose starttime is either null or not in the future.
If an exception is thrown by doStart, the BatchManager places the job in state BatchJob.STARTERROR and a ROLLBACK is done! No further action is carried out by the system with this BatchJob. So either doStart itself has to take appropriate actions, or an administrator must check for jobs in this state manually.
doStart
in interface BatchAdapter
job
- a BatchJobjava.lang.Exception
public void beforeCompletion(BatchJob job) throws java.lang.Exception
BatchAdapter
The method can be used to transfer results from the execution context of the finished jobs to the process context.
If an exception is thrown by beforeCompletion, the BatchManager places the job in state BatchJob.FINISHERROR. No further action is carried out by the system with this BatchJob. So either beforeCompletion itself takes appropriate actions, or handling is done in afterCompletion, or an administrator must check for jobs in this state manually.
beforeCompletion
in interface BatchAdapter
job
- a BatchJobjava.lang.Exception
public void afterCompletion(BatchJob job, boolean commit) throws java.lang.Exception
BatchAdapter
afterCompletion
in interface BatchAdapter
job
- a BatchJobcommit
- True if the job has been completed, false if there were errors.java.lang.Exception
public void doCompensate(BatchJob job) throws java.lang.Exception
doCompensate
in interface BatchAdapter
java.lang.Exception
@enterprise 9.0.33982 Copyright © 2001-2023 Groiss Informatics GmbH. All Rights Reserved.