org.camunda.bpm.engine.impl

Class ManagementServiceImpl

java.lang.Object

org.camunda.bpm.engine.impl.ServiceImpl

org.camunda.bpm.engine.impl.ManagementServiceImpl

All Implemented Interfaces:

ManagementService

public class ManagementServiceImpl
extends ServiceImpl
implements ManagementService

Author:

Tom Baeyens, Joram Barrez, Falko Menge, Saeid Mizaei

Field Summary

Fields inherited from class org.camunda.bpm.engine.impl.ServiceImpl

commandExecutor

Constructor Summary

Constructors

Constructor and Description
ManagementServiceImpl()

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 removeProcessesFromCache) Deactivate a deployment for a given ProcessApplication.
void	unregisterProcessApplication(String deploymentId, boolean removeProcessesFromCache) Deactivate a deployment for a given ProcessApplication.

Methods inherited from class org.camunda.bpm.engine.impl.ServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManagementServiceImpl

public ManagementServiceImpl()

Method Detail

registerProcessApplication

public ProcessApplicationRegistration registerProcessApplication(String deploymentId,
                                                        ProcessApplicationReference reference)

Description copied from interface: ManagementService

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

Specified by:

registerProcessApplication in interface ManagementService

Parameters:

deploymentId - the Id of the deployment to activate

reference - the reference to the process application

Returns:

a new ProcessApplicationRegistration

unregisterProcessApplication

public void unregisterProcessApplication(String deploymentId,
                                boolean removeProcessesFromCache)

Description copied from interface: ManagementService

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.

Specified by:

unregisterProcessApplication in interface ManagementService

Parameters:

deploymentId - the Id of the deployment to deactivate

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

unregisterProcessApplication

public void unregisterProcessApplication(Set<String> deploymentIds,
                                boolean removeProcessesFromCache)

Description copied from interface: ManagementService

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.

Specified by:

unregisterProcessApplication in interface ManagementService

Parameters:

deploymentIds - the Ids of the deployments to deactivate

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

getProcessApplicationForDeployment

public String getProcessApplicationForDeployment(String deploymentId)

Specified by:

getProcessApplicationForDeployment in interface ManagementService

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

public Map<String,Long> getTableCount()

Description copied from interface: ManagementService

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

Specified by:

getTableCount in interface ManagementService

getTableName

public String getTableName(Class<?> activitiEntityClass)

Description copied from interface: ManagementService

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

Specified by:

getTableName in interface ManagementService

getTableMetaData

public TableMetaData getTableMetaData(String tableName)

Description copied from interface: ManagementService

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

Specified by:

getTableMetaData in interface ManagementService

executeJob

public void executeJob(String jobId)

Description copied from interface: ManagementService

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.

Specified by:

executeJob in interface ManagementService

Parameters:

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

deleteJob

public void deleteJob(String jobId)

Description copied from interface: ManagementService

Delete the job with the provided id.

Specified by:

deleteJob in interface ManagementService

Parameters:

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

setJobRetries

public void setJobRetries(String jobId,
                 int retries)

Description copied from interface: ManagementService

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.

Specified by:

setJobRetries in interface ManagementService

Parameters:

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

retries - number of retries.

setJobDuedate

public void setJobDuedate(String jobId,
                 Date newDuedate)

Description copied from interface: ManagementService

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

Specified by:

setJobDuedate in interface ManagementService

Parameters:

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

newDuedate - new date for job execution

createTablePageQuery

public TablePageQuery createTablePageQuery()

Description copied from interface: ManagementService

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

Specified by:

createTablePageQuery in interface ManagementService

createJobQuery

public JobQuery createJobQuery()

Description copied from interface: ManagementService

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

Specified by:

createJobQuery in interface ManagementService

getJobExceptionStacktrace

public String getJobExceptionStacktrace(String jobId)

Description copied from interface: ManagementService

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.

Specified by:

getJobExceptionStacktrace in interface ManagementService

Parameters:

jobId - id of the job, cannot be null.

getProperties

public Map<String,String> getProperties()

Description copied from interface: ManagementService

get the list of properties.

Specified by:

getProperties in interface ManagementService

databaseSchemaUpgrade

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

Description copied from interface: ManagementService

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

Specified by:

databaseSchemaUpgrade in interface ManagementService

createProcessDefinitionStatisticsQuery

public ProcessDefinitionStatisticsQuery createProcessDefinitionStatisticsQuery()

Description copied from interface: ManagementService

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

Specified by:

createProcessDefinitionStatisticsQuery in interface ManagementService

createActivityStatisticsQuery

public ActivityStatisticsQuery createActivityStatisticsQuery(String processDefinitionId)

Description copied from interface: ManagementService

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

Specified by:

createActivityStatisticsQuery in interface ManagementService

createDeploymentStatisticsQuery

public DeploymentStatisticsQuery createDeploymentStatisticsQuery()

Description copied from interface: ManagementService

Query for the number of process instances aggregated by deployments.

Specified by:

createDeploymentStatisticsQuery in interface ManagementService

getRegisteredDeployments

public Set<String> getRegisteredDeployments()

Description copied from interface: ManagementService

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

Specified by:

getRegisteredDeployments in interface ManagementService

registerDeploymentForJobExecutor

public void registerDeploymentForJobExecutor(String deploymentId)

Description copied from interface: ManagementService

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.

Specified by:

registerDeploymentForJobExecutor in interface ManagementService

unregisterDeploymentForJobExecutor

public void unregisterDeploymentForJobExecutor(String deploymentId)

Description copied from interface: ManagementService

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.

Specified by:

unregisterDeploymentForJobExecutor in interface ManagementService