org.camunda.bpm.engine.ManagementService Maven / Gradle / Ivy
/* Licensed under the Apache License, Version 2.0 (the "License");
* 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;
import java.sql.Connection;
import java.util.Date;
import java.util.Map;
import java.util.Set;
import org.camunda.bpm.application.ProcessApplicationReference;
import org.camunda.bpm.application.ProcessApplicationRegistration;
import org.camunda.bpm.engine.impl.jobexecutor.JobExecutor;
import org.camunda.bpm.engine.management.ActivityStatisticsQuery;
import org.camunda.bpm.engine.management.DeploymentStatisticsQuery;
import org.camunda.bpm.engine.management.JobDefinition;
import org.camunda.bpm.engine.management.JobDefinitionQuery;
import org.camunda.bpm.engine.management.ProcessDefinitionStatisticsQuery;
import org.camunda.bpm.engine.management.TableMetaData;
import org.camunda.bpm.engine.management.TablePage;
import org.camunda.bpm.engine.management.TablePageQuery;
import org.camunda.bpm.engine.runtime.Incident;
import org.camunda.bpm.engine.runtime.Job;
import org.camunda.bpm.engine.runtime.JobQuery;
/**
* Service for admin and maintenance operations on the process engine.
*
* These operations will typically not be used in a workflow driven application,
* but are used in for example the operational console.
*
* @author Tom Baeyens
* @author Joram Barrez
* @author Falko Menge
* @author Thorben Lindhauer
*/
public interface ManagementService {
/**
* Activate a deployment for a given ProcessApplication. The effect of this
* method is twofold:
*
* - The process engine will execute atomic operations within the context of
* that ProcessApplication
* - The job executor will start acquiring jobs from that deployment
*
*
* @param deploymentId
* the Id of the deployment to activate
* @param reference
* the reference to the process application
* @return a new {@link ProcessApplicationRegistration}
*/
ProcessApplicationRegistration registerProcessApplication(String deploymentId, ProcessApplicationReference reference);
/**
* Deactivate a deployment for a given ProcessApplication. This removes the association
* between the process engine and the process application and optionally removes the associated
* process definitions from the cache.
*
* @param deploymentId
* the Id of the deployment to deactivate
* @param removeProcessDefinitionsFromCache
* indicates whether the process definitions should be removed from the deployment cache
* @return true if the registration was cleared
*/
void unregisterProcessApplication(String deploymentId, boolean removeProcessDefinitionsFromCache);
/**
* Deactivate a deployment for a given ProcessApplication. This removes the association
* between the process engine and the process application and optionally removes the associated
* process definitions from the cache.
*
* @param deploymentIds
* the Ids of the deployments to deactivate
* @param removeProcessDefinitionsFromCache
* indicates whether the process definitions should be removed from the deployment cache
* @return true if the registration was cleared
*/
void unregisterProcessApplication(Set deploymentIds, boolean removeProcessDefinitionsFromCache);
/**
* @return the name of the process application that is currently registered for
* the given deployment or 'null' if no process application is
* currently registered.
*/
String getProcessApplicationForDeployment(String deploymentId);
/**
* Get the mapping containing {table name, row count} entries of the
* Activiti database schema.
*/
Map getTableCount();
/**
* Gets the table name (including any configured prefix) for an Activiti entity like Task, Execution or the like.
*/
String getTableName(Class activitiEntityClass);
/**
* Gets the metadata (column names, column types, etc.) of a certain table.
* Returns null when no table exists with the given name.
*/
TableMetaData getTableMetaData(String tableName);
/**
* Creates a {@link TablePageQuery} that can be used to fetch {@link TablePage}
* containing specific sections of table row data.
*/
TablePageQuery createTablePageQuery();
/**
* Returns a new JobQuery implementation, that can be used
* to dynamically query the jobs.
*/
JobQuery createJobQuery();
/**
* Returns a new {@link JobDefinitionQuery} implementation, that can be used
* to dynamically query the job definitions.
*/
JobDefinitionQuery createJobDefinitionQuery();
/**
* Forced synchronous execution of a job (eg. for administration or testing)
* The job will be executed, even if the process definition and/or the process instance
* is in suspended state.
*
* @param jobId id of the job to execute, cannot be null.
* @throws ProcessEngineException when there is no job with the given id.
*/
void executeJob(String jobId);
/**
* Delete the job with the provided id.
* @param jobId id of the job to execute, cannot be null.
* @throws ProcessEngineException when there is no job with the given id.
*/
void deleteJob(String jobId);
/**
* Activates the {@link JobDefinition} with the given id immediately.
*
*
* Note: All {@link Job}s of the provided job definition
* will be not activated.
*
*
* @throws ProcessEngineException if the job definition id is equal null.
*
* @see #activateJobById(String)
* @see #activateJobByJobDefinitionId(String)
*/
void activateJobDefinitionById(String jobDefinitionId);
/**
* Activates all {@link JobDefinition}s of the provided process definition id immediately.
*
*
* Note: All {@link Job}s of the provided job definition
* will be not activated.
*
*
* @throws ProcessEngineException if the process definition id is equal null.
*
* @see #activateJobByProcessDefinitionId(String)
*/
void activateJobDefinitionByProcessDefinitionId(String processDefinitionId);
/**
* Activates all {@link JobDefinition}s of the provided process definition key immediately.
*
*
* Note: All {@link Job}s of the provided job definition
* will be not activated.
*
*
* @throws ProcessEngineException if the process definition key is equal null.
*
* @see #activateJobByProcessDefinitionKey(String)
*/
void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey);
/**
* Activates the {@link JobDefinition} with the given id immediately.
*
* @param activateJobs If true, all the {@link Job}s of the provided job definition
* will be activated too.
*
* @throws ProcessEngineException if the job definition id is equal null.
*
* @see #activateJobById(String)
* @see #activateJobByJobDefinitionId(String)
*/
void activateJobDefinitionById(String jobDefinitionId, boolean activateJobs);
/**
* Activates all {@link JobDefinition}s of the provided process definition id immediately.
*
* @param activateJobs If true, all the {@link Job}s of the provided job definition
* will be activated too.
*
* @throws ProcessEngineException if the process definition id is equal null.
*
* @see #activateJobByProcessDefinitionId(String)
*/
void activateJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean activateJobs);
/**
* Activates all {@link JobDefinition}s of the provided process definition key immediately.
*
* @param activateJobs If true, all the {@link Job}s of the provided job definition
* will be activated too.
*
* @throws ProcessEngineException if the process definition key is equal null.
*
* @see #activateJobByProcessDefinitionKey(String)
*/
void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean activateJobs);
/**
* Activates the {@link JobDefinition} with the given id.
*
* @param activateJobs If true, all the {@link Job}s of the provided job definition
* will be activated too.
*
* @param activationDate The date on which the job definition will be activated. If null, the
* job definition is activated immediately.
* Note: The {@link JobExecutor} needs to be active to use this!
*
* @throws ProcessEngineException if the job definition id is equal null.
*
* @see #activateJobById(String)
* @see #activateJobByJobDefinitionId(String)
*/
void activateJobDefinitionById(String jobDefinitionId, boolean activateJobs, Date activationDate);
/**
* Activates all {@link JobDefinition}s of the provided process definition id.
*
* @param activateJobs If true, all the {@link Job}s of the provided job definition
* will be activated too.
*
* @param activationDate The date on which the job definition will be activated. If null, the
* job definition is activated immediately.
* Note: The {@link JobExecutor} needs to be active to use this!
*
* @throws ProcessEngineException if the process definition id is equal null.
*
* @see #activateJobByProcessDefinitionId(String)
*/
void activateJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean activateJobs, Date activationDate);
/**
* Activates all {@link JobDefinition}s of the provided process definition key.
*
* @param activateJobs If true, all the {@link Job}s of the provided job definition
* will be activated too.
*
* @param activationDate The date on which the job definition will be activated. If null, the
* job definition is activated immediately.
* Note: The {@link JobExecutor} needs to be active to use this!
*
* @throws ProcessEngineException if the process definition key is equal null.
*
* @see #activateJobByProcessDefinitionKey(String)
*/
void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean activateJobs, Date activationDate);
/**
* Suspends the {@link JobDefinition} with the given id immediately.
*
*
* Note: All {@link Job}s of the provided job definition
* will be not suspended.
*
*
* @throws ProcessEngineException if no such job definition can be found.
*
* @see #suspendJobById(String)
* @see #suspendJobByJobDefinitionId(String)
*/
void suspendJobDefinitionById(String jobDefinitionId);
/**
* Suspends all {@link JobDefinition} of the provided process definition id immediately.
*
*
* Note: All {@link Job}s of the provided job definition
* will be not suspended.
*
*
* @throws ProcessEngineException if the process definition id is equal null.
*
* @see #suspendJobByProcessDefinitionId(String)
*/
void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId);
/**
* Suspends all {@link JobDefinition} of the provided process definition key immediately.
*
*
* Note: All {@link Job}s of the provided job definition
* will be not suspended.
*
*
* @throws ProcessEngineException if the process definition key is equal null.
*
* @see #suspendJobByProcessDefinitionKey(String)
*/
void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey);
/**
* Suspends the {@link JobDefinition} with the given id immediately.
*
* @param suspendJobs If true, all the {@link Job}s of the provided job definition
* will be suspended too.
*
* @throws ProcessEngineException if the job definition id is equal null.
*
* @see #suspendJobById(String)
* @see #suspendJobByJobDefinitionId(String)
*/
void suspendJobDefinitionById(String jobDefinitionId, boolean suspendJobs);
/**
* Suspends all {@link JobDefinition}s of the provided process definition id immediately.
*
* @param suspendJobs If true, all the {@link Job}s of the provided job definition
* will be suspended too.
*
* @throws ProcessEngineException if the process definition id is equal null.
*
* @see #suspendJobByProcessDefinitionId(String)
*/
void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean suspendJobs);
/**
* Suspends all {@link JobDefinition}s of the provided process definition key immediately.
*
* @param suspendJobs If true, all the {@link Job}s of the provided job definition
* will be suspended too.
*
* @throws ProcessEngineException if the process definition key is equal null.
*
* @see #suspendJobByProcessDefinitionKey(String)
*/
void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean suspendJobs);
/**
* Suspends the {@link JobDefinition} with the given id.
*
* @param suspendJobs If true, all the {@link Job}s of the provided job definition
* will be suspended too.
*
* @param suspensionDate The date on which the job definition will be suspended. If null, the
* job definition is suspended immediately.
* Note: The {@link JobExecutor} needs to be active to use this!
*
* @throws ProcessEngineException if the job definition id is equal null.
*
* @see #suspendJobById(String)
* @see #suspendJobByJobDefinitionId(String)
*/
void suspendJobDefinitionById(String jobDefinitionId, boolean suspendJobs, Date suspensionDate);
/**
* Suspends all {@link JobDefinition}s of the provided process definition id.
*
* @param suspendJobs If true, all the {@link Job}s of the provided job definition
* will be suspended too.
*
* @param suspensionDate The date on which the job definition will be suspended. If null, the
* job definition is suspended immediately.
* Note: The {@link JobExecutor} needs to be active to use this!
*
* @throws ProcessEngineException if the process definition id is equal null.
*
* @see #suspendJobByProcessDefinitionId(String)
*/
void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean suspendJobs, Date suspensionDate);
/**
* Suspends all {@link JobDefinition}s of the provided process definition key.
*
* @param suspendJobs If true, all the {@link Job}s of the provided job definition
* will be suspended too.
*
* @param suspensionDate The date on which the job definition will be suspended. If null, the
* job definition is suspended immediately.
* Note: The {@link JobExecutor} needs to be active to use this!
*
* @throws ProcessEngineException if the process definition key is equal null.
*
* @see #suspendJobByProcessDefinitionKey(String)
*/
void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean suspendJobs, Date suspensionDate);
/**
* Activates the {@link Job} with the given id.
*
* @throws ProcessEngineException if the job id is equal null.
*/
void activateJobById(String jobId);
/**
* Activates all {@link Job}s of the provided job definition id.
*
* @throws ProcessEngineException if the job definition id is equal null.
*/
void activateJobByJobDefinitionId(String jobDefinitionId);
/**
* Activates all {@link Job}s of the provided process instance id.
*
* @throws ProcessEngineException if the process instance id is equal null.
*/
void activateJobByProcessInstanceId(String processInstanceId);
/**
* Activates all {@link Job}s of the provided process definition id.
*
* @throws ProcessEngineException if the process definition id is equal null.
*/
void activateJobByProcessDefinitionId(String processDefinitionId);
/**
* Activates {@link Job}s of the provided process definition key.
*
* @throws ProcessEngineException if the process definition key is equal null.
*/
void activateJobByProcessDefinitionKey(String processDefinitionKey);
/**
* Suspends the {@link Job} with the given id.
*
* @throws ProcessEngineException if the job id is equal null.
*/
void suspendJobById(String jobId);
/**
* Suspends all {@link Job}s of the provided job definition id.
*
* @throws ProcessEngineException if the job definition id is equal null.
*/
void suspendJobByJobDefinitionId(String jobDefinitionId);
/**
* Suspends all {@link Job}s of the provided process instance id.
*
* @throws ProcessEngineException if the process instance id is equal null.
*/
void suspendJobByProcessInstanceId(String processInstanceId);
/**
* Suspends all {@link Job}s of the provided process definition id.
*
* @throws ProcessEngineException if the process definition id is equal null.
*/
void suspendJobByProcessDefinitionId(String processDefinitionId);
/**
* Activates {@link Job}s of the provided process definition key.
*
* @throws ProcessEngineException if the process definition key is equal null.
*/
void suspendJobByProcessDefinitionKey(String processDefinitionKey);
/**
* Sets the number of retries that a job has left.
*
* Whenever the JobExecutor fails to execute a job, this value is decremented.
* When it hits zero, the job is supposed to be dead and not retried again.
* In that case, this method can be used to increase the number of retries.
* @param jobId id of the job to modify, cannot be null.
* @param retries number of retries.
*/
void setJobRetries(String jobId, int retries);
/**
*
* Set the number of retries of all failed {@link Job jobs}
* of the provided job definition id.
*
*
*
* Whenever the JobExecutor fails to execute a job, this value is decremented.
* When it hits zero, the job is supposed to be failed and
* not retried again. In that case, this method can be used to increase the
* number of retries.
*
*
*
* {@link Incident Incidents} of the involved failed {@link Job jobs} will not
* be resolved using this method! When the execution of a job was successful
* the corresponding incident will be resolved.
*
*
* @param jobdefinitionId id of the job definition, cannot be null.
* @param retries number of retries.
*/
void setJobRetriesByJobDefinitionId(String jobDefinitionId, int retries);
/**
* Sets a new due date for the provided id.
* When newDuedate is null, the job is executed with the next
* job executor run.
* @param jobId id of job to modify, cannot be null.
* @param newDuedate new date for job execution
*/
void setJobDuedate(String jobId, Date newDuedate);
/**
* Returns the full stacktrace of the exception that occurs when the job
* with the given id was last executed. Returns null when the job has no
* exception stacktrace.
* @param jobId id of the job, cannot be null.
* @throws ProcessEngineException when no job exists with the given id.
*/
String getJobExceptionStacktrace(String jobId);
/** get the list of properties. */
Map getProperties();
/** Set the value for a property.
*
* @param name the name of the property.
* @param value the new value for the property.
*/
void setProperty(String name, String value);
/** programmatic schema update on a given connection returning feedback about what happened */
String databaseSchemaUpgrade(Connection connection, String catalog, String schema);
/**
* Query for the number of process instances aggregated by process definitions.
*/
ProcessDefinitionStatisticsQuery createProcessDefinitionStatisticsQuery();
/**
* Query for the number of process instances aggregated by deployments.
*/
DeploymentStatisticsQuery createDeploymentStatisticsQuery();
/**
* Query for the number of activity instances aggregated by activities of a single process definition.
*/
ActivityStatisticsQuery createActivityStatisticsQuery(String processDefinitionId);
/**
* Get the deployments that are registered the engine's job executor.
* This set is only relevant, if the engine configuration property jobExecutorDeploymentAware is set.
*/
Set getRegisteredDeployments();
/**
* Register a deployment for the engine's job executor.
* This is required, if the engine configuration property jobExecutorDeploymentAware is set.
* If set to false, the job executor will execute any job.
*/
void registerDeploymentForJobExecutor(String deploymentId);
/**
* Unregister a deployment for the engine's job executor.
* If the engine configuration property jobExecutorDeploymentAware is set,
* jobs for the given deployment will no longer get acquired.
*/
void unregisterDeploymentForJobExecutor(String deploymentId);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy