org.camunda.bpm.engine.impl.batch.BatchJobHandler Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.camunda.bpm.engine.impl.batch;
import org.camunda.bpm.engine.impl.jobexecutor.JobDeclaration;
import org.camunda.bpm.engine.impl.jobexecutor.JobHandler;
import org.camunda.bpm.engine.impl.persistence.entity.MessageEntity;
/**
* A batch job handler manages batch jobs based
* on the configuration {@link T}.
*
* Used by a seed job to manage lifecycle of execution jobs.
*/
public interface BatchJobHandler extends JobHandler {
/**
* Converts the configuration of the batch to a byte array.
*
* @param configuration the configuration object
* @return the serialized configuration
*/
byte[] writeConfiguration(T configuration);
/**
* Read the serialized configuration of the batch.
*
* @param serializedConfiguration the serialized configuration
* @return the deserialized configuration object
*/
T readConfiguration(byte[] serializedConfiguration);
/**
* Get the job declaration for batch jobs.
*
* @return the batch job declaration
*/
JobDeclaration getJobDeclaration();
/**
* Creates batch jobs for a batch.
*
* @param batch the batch to create jobs for
* @return true of no more jobs have to be created for this batch, false otherwise
*/
boolean createJobs(BatchEntity batch);
/**
* Delete all jobs for a batch.
*
* @param batch the batch to delete jobs for
*/
void deleteJobs(BatchEntity batch);
/**
* Determine the number of invocations ber patch job. This can be defined by
* the related batch job handler specifically or otherwise taken from the
* engine configuration.
*
* @param batchType
* the batch's type to help determine any engine configuration
* related to it
* @param configuration
* the configuration object
* @return the number of invocations ber patch job
*/
int calculateInvocationsPerBatchJob(String batchType, T configuration);
}