org.camunda.bpm.engine.batch.Batch 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.batch;
import org.camunda.bpm.engine.ManagementService;
/**
* A batch represents a number of jobs which
* execute a number of commands asynchronously.
*
*
Batches have three types of jobs:
*
* - Seed jobs: Create execution jobs
*
- Execution jobs: Execute the actual action
*
- Monitor jobs: Manage the batch once all execution jobs have been created
* (e.g. responsible for deletion of the Batch after completion).
*
*
*
All three job types have independent job definitions. They can be controlled individually
* (e.g. suspension) and are independently represented in the historic job log.
*/
public interface Batch {
String TYPE_PROCESS_INSTANCE_MIGRATION = "instance-migration";
String TYPE_PROCESS_INSTANCE_MODIFICATION = "instance-modification";
String TYPE_PROCESS_INSTANCE_RESTART = "instance-restart";
String TYPE_PROCESS_INSTANCE_DELETION = "instance-deletion";
String TYPE_PROCESS_INSTANCE_UPDATE_SUSPENSION_STATE = "instance-update-suspension-state";
String TYPE_HISTORIC_PROCESS_INSTANCE_DELETION = "historic-instance-deletion";
String TYPE_HISTORIC_DECISION_INSTANCE_DELETION = "historic-decision-instance-deletion";
String TYPE_SET_JOB_RETRIES = "set-job-retries";
String TYPE_SET_EXTERNAL_TASK_RETRIES = "set-external-task-retries";
String TYPE_PROCESS_SET_REMOVAL_TIME = "process-set-removal-time";
String TYPE_DECISION_SET_REMOVAL_TIME = "decision-set-removal-time";
String TYPE_BATCH_SET_REMOVAL_TIME = "batch-set-removal-time";
/**
* @return the id of the batch
*/
String getId();
/**
* @return the type of the batch
*/
String getType();
/**
* @return the number of batch execution jobs required to complete the batch
*/
int getTotalJobs();
/**
* @return the number of batch execution jobs already created by the seed job
*/
int getJobsCreated();
/**
* @return number of batch jobs created per batch seed job invocation
*/
int getBatchJobsPerSeed();
/**
* @return the number of invocations executed per batch job
*/
int getInvocationsPerBatchJob();
/**
* @return the id of the batch seed job definition
*/
String getSeedJobDefinitionId();
/**
* @return the id of the batch monitor job definition
*/
String getMonitorJobDefinitionId();
/**
* @return the id of the batch job definition
*/
String getBatchJobDefinitionId();
/**
* @return the batch's tenant id or null
*/
String getTenantId();
/**
* @return the batch creator's user id
*/
String getCreateUserId();
/**
*
* Indicates whether this batch is suspended. If a batch is suspended,
* the batch jobs will not be acquired by the job executor.
*
*
*
* Note: It is still possible to manually suspend and activate
* jobs and job definitions using the {@link ManagementService}, which will
* not change the suspension state of the batch.
*
*
* @return true if this batch is currently suspended, false otherwise
* @see ManagementService#suspendBatchById(String)
* @see ManagementService#activateBatchById(String)
*/
boolean isSuspended();
}