org.camunda.bpm.engine

Interface ManagementService

All Known Implementing Classes:

ManagementServiceImpl

public interface ManagementService

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, Joram Barrez, Falko Menge, Thorben Lindhauer

Method Summary

Methods

Modifier and Type	Method and Description
ActivityStatisticsQuery	createActivityStatisticsQuery(String processDefinitionId) Query for the number of activity instances aggregated by activities of a single process definition.
DeploymentStatisticsQuery	createDeploymentStatisticsQuery() Query for the number of process instances aggregated by deployments.
JobQuery	createJobQuery() Returns a new JobQuery implementation, that can be used to dynamically query the jobs.
ProcessDefinitionStatisticsQuery	createProcessDefinitionStatisticsQuery() Query for the number of process instances aggregated by process definitions.
TablePageQuery	createTablePageQuery() Creates a TablePageQuery that can be used to fetch TablePage containing specific sections of table row data.
String	databaseSchemaUpgrade(Connection connection, String catalog, String schema) programmatic schema update on a given connection returning feedback about what happened
void	deleteJob(String jobId) Delete the job with the provided id.
void	executeJob(String jobId) Forced synchronous execution of a job (eg.
String	getJobExceptionStacktrace(String jobId) Returns the full stacktrace of the exception that occurs when the job with the given id was last executed.
String	getProcessApplicationForDeployment(String deploymentId)
Map<String,String>	getProperties() get the list of properties.
Set<String>	getRegisteredDeployments() Get the deployments that are registered the engine's job executor.
Map<String,Long>	getTableCount() Get the mapping containing {table name, row count} entries of the Activiti database schema.
TableMetaData	getTableMetaData(String tableName) Gets the metadata (column names, column types, etc.) of a certain table.
String	getTableName(Class<?> activitiEntityClass) Gets the table name (including any configured prefix) for an Activiti entity like Task, Execution or the like.
void	registerDeploymentForJobExecutor(String deploymentId) Register a deployment for the engine's job executor.
ProcessApplicationRegistration	registerProcessApplication(String deploymentId, ProcessApplicationReference reference) Activate a deployment for a given ProcessApplication.
void	setJobDuedate(String jobId, Date newDuedate) Sets a new due date for the provided id.
void	setJobRetries(String jobId, int retries) Sets the number of retries that a job has left.
void	unregisterDeploymentForJobExecutor(String deploymentId) Unregister a deployment for the engine's job executor.
void	unregisterProcessApplication(Set<String> deploymentIds, boolean removeProcessDefinitionsFromCache) Deactivate a deployment for a given ProcessApplication.
void	unregisterProcessApplication(String deploymentId, boolean removeProcessDefinitionsFromCache) Deactivate a deployment for a given ProcessApplication.

Method Detail

registerProcessApplication

ProcessApplicationRegistration registerProcessApplication(String deploymentId,
                                                        ProcessApplicationReference reference)

Activate a deployment for a given ProcessApplication. The effect of this method is twofold:

1. The process engine will execute atomic operations within the context of that ProcessApplication
2. The job executor will start acquiring jobs from that deployment

Parameters:

deploymentId - the Id of the deployment to activate

reference - the reference to the process application

Returns:

a new ProcessApplicationRegistration

unregisterProcessApplication

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.

Parameters:

deploymentId - the Id of the deployment to deactivate

removeProcessDefinitionsFromCache - indicates whether the process definitions should be removed from the deployment cache

unregisterProcessApplication

void unregisterProcessApplication(Set<String> deploymentIds,
                                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.

Parameters:

deploymentIds - the Ids of the deployments to deactivate

removeProcessDefinitionsFromCache - indicates whether the process definitions should be removed from the deployment cache

getProcessApplicationForDeployment

String getProcessApplicationForDeployment(String deploymentId)

Returns:

the name of the process application that is currently registered for the given deployment or 'null' if no process application is currently registered.

getTableCount

Map<String,Long> getTableCount()

Get the mapping containing {table name, row count} entries of the Activiti database schema.

getTableName

String getTableName(Class<?> activitiEntityClass)

Gets the table name (including any configured prefix) for an Activiti entity like Task, Execution or the like.

getTableMetaData

TableMetaData getTableMetaData(String tableName)

Gets the metadata (column names, column types, etc.) of a certain table. Returns null when no table exists with the given name.

createTablePageQuery

TablePageQuery createTablePageQuery()

Creates a TablePageQuery that can be used to fetch TablePage containing specific sections of table row data.

createJobQuery

JobQuery createJobQuery()

Returns a new JobQuery implementation, that can be used to dynamically query the jobs.

executeJob

void executeJob(String jobId)

Forced synchronous execution of a job (eg. for administation or testing) The job will be executed, even if the process definition and/or the process instance is in suspended state.

Parameters:

jobId - id of the job to execute, cannot be null.

Throws:

ProcessEngineException - when there is no job with the given id.

deleteJob

void deleteJob(String jobId)

Delete the job with the provided id.

Parameters:

jobId - id of the job to execute, cannot be null.

Throws:

ProcessEngineException - when there is no job with the given id.

setJobRetries

void setJobRetries(String jobId,
                 int retries)

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.

Parameters:

jobId - id of the job to modify, cannot be null.

retries - number of retries.

setJobDuedate

void setJobDuedate(String jobId,
                 Date newDuedate)

Sets a new due date for the provided id. When newDuedate is null, the job is executed with the next job executor run.

Parameters:

jobId - id of job to modify, cannot be null.

newDuedate - new date for job execution

getJobExceptionStacktrace

String getJobExceptionStacktrace(String jobId)

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.

Parameters:

jobId - id of the job, cannot be null.

Throws:

ProcessEngineException - when no job exists with the given id.

getProperties

Map<String,String> getProperties()

get the list of properties.

databaseSchemaUpgrade

String databaseSchemaUpgrade(Connection connection,
                           String catalog,
                           String schema)

programmatic schema update on a given connection returning feedback about what happened

createProcessDefinitionStatisticsQuery

ProcessDefinitionStatisticsQuery createProcessDefinitionStatisticsQuery()

Query for the number of process instances aggregated by process definitions.

createDeploymentStatisticsQuery

DeploymentStatisticsQuery createDeploymentStatisticsQuery()

Query for the number of process instances aggregated by deployments.

createActivityStatisticsQuery

ActivityStatisticsQuery createActivityStatisticsQuery(String processDefinitionId)

Query for the number of activity instances aggregated by activities of a single process definition.

getRegisteredDeployments

Set<String> getRegisteredDeployments()

Get the deployments that are registered the engine's job executor. This set is only relevant, if the engine configuration property jobExecutorDeploymentAware is set.

registerDeploymentForJobExecutor

void registerDeploymentForJobExecutor(String deploymentId)

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.

unregisterDeploymentForJobExecutor

void unregisterDeploymentForJobExecutor(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.