org.camunda.bpm.engine.impl.batch

Interface BatchJobHandler<T>

All Superinterfaces:

JobHandler<BatchJobConfiguration>

All Known Implementing Classes:

AbstractBatchJobHandler, DeleteHistoricDecisionInstancesJobHandler, DeleteHistoricProcessInstancesJobHandler, DeleteProcessInstancesJobHandler, MigrationBatchJobHandler, ModificationBatchJobHandler, RestartProcessInstancesJobHandler, SetExternalTaskRetriesJobHandler, SetJobRetriesJobHandler, UpdateProcessInstancesSuspendStateJobHandler

public interface BatchJobHandler<T>
extends JobHandler<BatchJobConfiguration>

A batch job handler manages batch jobs based on the configuration T. Used by a seed job to manage lifecycle of execution jobs.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	createJobs(BatchEntity batch) Creates batch jobs for a batch.
void	deleteJobs(BatchEntity batch) Delete all jobs for a batch.
JobDeclaration<?,MessageEntity>	getJobDeclaration() Get the job declaration for batch jobs.
T	readConfiguration(byte[] serializedConfiguration) Read the serialized configuration of the batch.
byte[]	writeConfiguration(T configuration) Converts the configuration of the batch to a byte array.

Methods inherited from interface org.camunda.bpm.engine.impl.jobexecutor.JobHandler

execute, getType, newConfiguration, onDelete

Method Detail

writeConfiguration

byte[] writeConfiguration(T configuration)

Converts the configuration of the batch to a byte array.

Parameters:

configuration - the configuration object

Returns:

the serialized configuration

readConfiguration

T readConfiguration(byte[] serializedConfiguration)

Read the serialized configuration of the batch.

Parameters:

serializedConfiguration - the serialized configuration

Returns:

the deserialized configuration object

getJobDeclaration

JobDeclaration<?,MessageEntity> getJobDeclaration()

Get the job declaration for batch jobs.

Returns:

the batch job declaration

createJobs

boolean createJobs(BatchEntity batch)

Creates batch jobs for a batch.

Parameters:

batch - the batch to create jobs for

Returns:

true of no more jobs have to be created for this batch, false otherwise

deleteJobs

void deleteJobs(BatchEntity batch)

Delete all jobs for a batch.

Parameters:

batch - the batch to delete jobs for