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, Askar AKhmerov

Field Summary

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

commandExecutor

Constructor Summary

Constructors

Constructor and Description
ManagementServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	activateBatchById(String batchId) Activates the Batch with the given id immediately.
void	activateJobById(String jobId) Activates the Job with the given id.
void	activateJobByJobDefinitionId(String jobDefinitionId) Activates all Jobs of the provided job definition id.
void	activateJobByProcessDefinitionId(String processDefinitionId) Activates all Jobs of the provided process definition id.
void	activateJobByProcessDefinitionKey(String processDefinitionKey) Activates Jobs of the provided process definition key.
void	activateJobByProcessInstanceId(String processInstanceId) Activates all Jobs of the provided process instance id.
void	activateJobDefinitionById(String jobDefinitionId) Activates the JobDefinition with the given id immediately.
void	activateJobDefinitionById(String jobDefinitionId, boolean activateJobs) Activates the JobDefinition with the given id immediately.
void	activateJobDefinitionById(String jobDefinitionId, boolean activateJobs, Date activationDate) Activates the JobDefinition with the given id.
void	activateJobDefinitionByProcessDefinitionId(String processDefinitionId) Activates all JobDefinitions of the provided process definition id immediately.
void	activateJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean activateJobs) Activates all JobDefinitions of the provided process definition id immediately.
void	activateJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean activateJobs, Date activationDate) Activates all JobDefinitions of the provided process definition id.
void	activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey) Activates all JobDefinitions of the provided process definition key immediately.
void	activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean activateJobs) Activates all JobDefinitions of the provided process definition key immediately.
void	activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean activateJobs, Date activationDate) Activates all JobDefinitions of the provided process definition key.
void	clearOverridingJobPriorityForJobDefinition(String jobDefinitionId) Clears the job definition's overriding job priority if set.
ActivityStatisticsQuery	createActivityStatisticsQuery(String processDefinitionId) Query for the number of activity instances aggregated by activities of a single process definition.
BatchQuery	createBatchQuery() Creates a query to search for Batch instances.
BatchStatisticsQuery	createBatchStatisticsQuery() Query for the statistics of the batch execution jobs of a batch.
DeploymentStatisticsQuery	createDeploymentStatisticsQuery() Query for the number of process instances aggregated by deployments.
JobDefinitionQuery	createJobDefinitionQuery() Returns a new JobDefinitionQuery implementation, that can be used to dynamically query the job definitions.
JobQuery	createJobQuery() Returns a new JobQuery implementation, that can be used to dynamically query the jobs.
MetricsQuery	createMetricsQuery()
ProcessDefinitionStatisticsQuery	createProcessDefinitionStatisticsQuery() Query for the number of process instances aggregated by process definitions.
SchemaLogQuery	createSchemaLogQuery() Query for entries of the database schema log.
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 Note: will always return an empty string
void	deleteBatch(String batchId, boolean cascade) Deletes a batch instance and the corresponding job definitions.
void	deleteJob(String jobId) Delete the job with the provided id.
void	deleteLicenseKey() Deletes the stored license key.
void	deleteMetrics(Date timestamp) Deletes all metrics events which are older than the specified timestamp.
void	deleteMetrics(Date timestamp, String reporter) Deletes all metrics events which are older than the specified timestamp and reported by the given reporter.
void	deleteProperty(String name) Deletes a property by name.
void	executeJob(String jobId) Forced synchronous execution of a job (eg.
int	getHistoryLevel() Get the configured history level for the process engine.
String	getJobExceptionStacktrace(String jobId) Returns the full stacktrace of the exception that occurs when the job with the given id was last executed.
String	getLicenseKey() Get the stored license key string or null if no license is set.
String	getProcessApplicationForDeployment(String deploymentId)
Map<String,String>	getProperties()
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 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 entity like Task, Execution or the like.
PurgeReport	purge() Purges the database and the deployment cache.
void	recalculateJobDuedate(String jobId, boolean creationDateBased) Triggers the recalculation for the job with the provided id.
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	reportDbMetricsNow() Forces this engine to commit its pending collected metrics to the database.
void	setJobDuedate(String jobId, Date newDuedate) Sets a new due date for the provided id.
void	setJobDuedate(String jobId, Date newDuedate, boolean cascade) Sets a new due date for the provided id.
void	setJobPriority(String jobId, long priority) Sets a new priority for the job with the provided id.
void	setJobRetries(List<String> jobIds, int retries) Sets the number of retries that jobs have left.
void	setJobRetries(String jobId, int retries) Sets the number of retries that a job has left.
Batch	setJobRetriesAsync(JobQuery jobQuery, int retries) Sets the number of retries that jobs have left asynchronously.
Batch	setJobRetriesAsync(List<String> jobIds, int retries) Sets the number of retries that jobs have left asynchronously.
Batch	setJobRetriesAsync(List<String> jobIds, JobQuery jobQuery, int retries) Sets the number of retries that jobs have left asynchronously.
Batch	setJobRetriesAsync(List<String> processInstanceIds, ProcessInstanceQuery query, int retries) Sets the number of retries that jobs have left asynchronously.
void	setJobRetriesByJobDefinitionId(String jobDefinitionId, int retries) Set the number of retries of all failed jobs of the provided job definition id.
void	setLicenseKey(String licenseKey) Set the license key.
void	setOverridingJobPriorityForJobDefinition(String jobDefinitionId, long priority) Sets an explicit priority for jobs of the given job definition.
void	setOverridingJobPriorityForJobDefinition(String jobDefinitionId, long priority, boolean cascade) Sets an explicit default priority for jobs of the given job definition.
void	setProperty(String name, String value) Set the value for a property.
void	suspendBatchById(String batchId) Suspends the Batch with the given id immediately.
void	suspendJobById(String jobId) Suspends the Job with the given id.
void	suspendJobByJobDefinitionId(String jobDefinitionId) Suspends all Jobs of the provided job definition id.
void	suspendJobByProcessDefinitionId(String processDefinitionId) Suspends all Jobs of the provided process definition id.
void	suspendJobByProcessDefinitionKey(String processDefinitionKey) Suspends Jobs of the provided process definition key.
void	suspendJobByProcessInstanceId(String processInstanceId) Suspends all Jobs of the provided process instance id.
void	suspendJobDefinitionById(String jobDefinitionId) Suspends the JobDefinition with the given id immediately.
void	suspendJobDefinitionById(String jobDefinitionId, boolean suspendJobs) Suspends the JobDefinition with the given id immediately.
void	suspendJobDefinitionById(String jobDefinitionId, boolean suspendJobs, Date suspensionDate) Suspends the JobDefinition with the given id.
void	suspendJobDefinitionByProcessDefinitionId(String processDefinitionId) Suspends all JobDefinition of the provided process definition id immediately.
void	suspendJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean suspendJobs) Suspends all JobDefinitions of the provided process definition id immediately.
void	suspendJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean suspendJobs, Date suspensionDate) Suspends all JobDefinitions of the provided process definition id.
void	suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey) Suspends all JobDefinition of the provided process definition key immediately.
void	suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean suspendJobs) Suspends all JobDefinitions of the provided process definition key immediately.
void	suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean suspendJobs, Date suspensionDate) Suspends all JobDefinitions of the provided process definition key.
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.
UpdateJobDefinitionSuspensionStateSelectBuilder	updateJobDefinitionSuspensionState() Activate or suspend job definitions using a fluent builder.
UpdateJobSuspensionStateSelectBuilder	updateJobSuspensionState() Activate or suspend jobs using a fluent builder.

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 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 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 administration 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.

setJobRetries

public void setJobRetries(List<String> jobIds,
                          int retries)

Description copied from interface: ManagementService

Sets the number of retries that jobs have 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:

jobIds - ids of the jobs to modify, cannot be null.

retries - number of retries.

setJobRetriesAsync

public Batch setJobRetriesAsync(List<String> jobIds,
                                int retries)

Description copied from interface: ManagementService

Sets the number of retries that jobs have left asynchronously. 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:

setJobRetriesAsync in interface ManagementService

Parameters:

jobIds - ids of the jobs to modify, cannot be null.

retries - number of retries.

setJobRetriesAsync

public Batch setJobRetriesAsync(JobQuery jobQuery,
                                int retries)

Description copied from interface: ManagementService

Sets the number of retries that jobs have left asynchronously. 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:

setJobRetriesAsync in interface ManagementService

Parameters:

jobQuery - query that identifies which jobs should be modified, cannot be null.

retries - number of retries.

setJobRetriesAsync

public Batch setJobRetriesAsync(List<String> jobIds,
                                JobQuery jobQuery,
                                int retries)

Description copied from interface: ManagementService

Sets the number of retries that jobs have left asynchronously. 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. Either jobIds or jobQuery has to be provided. If both are provided resulting list of affected jobs will contain jobs matching query as well as jobs defined in the list.

Specified by:

setJobRetriesAsync in interface ManagementService

Parameters:

jobIds - ids of the jobs to modify.

jobQuery - query that identifies which jobs should be modified.

retries - number of retries.

setJobRetriesAsync

public Batch setJobRetriesAsync(List<String> processInstanceIds,
                                ProcessInstanceQuery query,
                                int retries)

Description copied from interface: ManagementService

Sets the number of retries that jobs have left asynchronously. 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. Either jobIds or jobQuery has to be provided. If both are provided resulting list of affected jobs will contain jobs matching query as well as jobs defined in the list.

Specified by:

setJobRetriesAsync in interface ManagementService

Parameters:

processInstanceIds - ids of the process instances that for which jobs retries will be set

query - query that identifies process instances with jobs that have to be modified

retries - number of retries.

setJobRetriesByJobDefinitionId

public void setJobRetriesByJobDefinitionId(String jobDefinitionId,
                                           int retries)

Description copied from interface: ManagementService

Set the number of retries of all failed 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.

Incidents of the involved failed jobs will not be resolved using this method! When the execution of a job was successful the corresponding incident will be resolved.

Specified by:

setJobRetriesByJobDefinitionId in interface ManagementService

Parameters:

jobDefinitionId - id of the job definition, 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

setJobDuedate

public void setJobDuedate(String jobId,
                          Date newDuedate,
                          boolean cascade)

Description copied from interface: ManagementService

Sets a new due date for the provided id. The offset between the old and the new due date can be cascaded to all follow-up jobs. Cascading only works with timer jobs. When newDuedate is null, the job is executed with the next job executor run. In this case the cascade parameter is ignored.

Specified by:

setJobDuedate in interface ManagementService

Parameters:

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

newDuedate - new date for job execution

cascade - indicate whether follow-up jobs should be affected

recalculateJobDuedate

public void recalculateJobDuedate(String jobId,
                                  boolean creationDateBased)

Description copied from interface: ManagementService

Triggers the recalculation for the job with the provided id.

Specified by:

recalculateJobDuedate in interface ManagementService

Parameters:

jobId - id of job to recalculate, must neither be null nor empty.

creationDateBased - indicates whether the recalculation should be based on the creation date of the job or the current date

setJobPriority

public void setJobPriority(String jobId,
                           long priority)

Description copied from interface: ManagementService

Sets a new priority for the job with the provided id.

Specified by:

setJobPriority in interface ManagementService

Parameters:

jobId - the id of the job to modify, must not be null

priority - the job's new priority

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

createJobDefinitionQuery

public JobDefinitionQuery createJobDefinitionQuery()

Description copied from interface: ManagementService

Returns a new JobDefinitionQuery implementation, that can be used to dynamically query the job definitions.

Specified by:

createJobDefinitionQuery 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()

Specified by:

getProperties in interface ManagementService

Returns:

a map of all properties.

setProperty

public void setProperty(String name,
                        String value)

Description copied from interface: ManagementService

Set the value for a property.

Specified by:

setProperty in interface ManagementService

Parameters:

name - the name of the property.

value - the new value for the property.

deleteProperty

public void deleteProperty(String name)

Description copied from interface: ManagementService

Deletes a property by name. If the property does not exist, the request is ignored.

Specified by:

deleteProperty in interface ManagementService

Parameters:

name - the name of the property to delete

setLicenseKey

public void setLicenseKey(String licenseKey)

Description copied from interface: ManagementService

Set the license key.

Specified by:

setLicenseKey in interface ManagementService

Parameters:

licenseKey - the license key string.

getLicenseKey

public String getLicenseKey()

Description copied from interface: ManagementService

Get the stored license key string or null if no license is set.

Specified by:

getLicenseKey in interface ManagementService

deleteLicenseKey

public void deleteLicenseKey()

Description copied from interface: ManagementService

Deletes the stored license key. If no license key is set, the request is ignored.

Specified by:

deleteLicenseKey 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 Note: will always return an empty string

Specified by:

databaseSchemaUpgrade in interface ManagementService

purge

public PurgeReport purge()

Purges the database and the deployment cache.

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

activateJobDefinitionById

public void activateJobDefinitionById(String jobDefinitionId)

Description copied from interface: ManagementService

Activates the JobDefinition with the given id immediately.

Note: All Jobs of the provided job definition will be not activated.

Note: for more complex activate commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

activateJobDefinitionById in interface ManagementService

See Also:

ManagementService.activateJobById(String), ManagementService.activateJobByJobDefinitionId(String)

activateJobDefinitionById

public void activateJobDefinitionById(String jobDefinitionId,
                                      boolean activateJobs)

Description copied from interface: ManagementService

Activates the JobDefinition with the given id immediately.

Note: for more complex activate commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

activateJobDefinitionById in interface ManagementService

activateJobs - If true, all the Jobs of the provided job definition will be activated too.

See Also:

ManagementService.activateJobById(String), ManagementService.activateJobByJobDefinitionId(String)

activateJobDefinitionById

public void activateJobDefinitionById(String jobDefinitionId,
                                      boolean activateJobs,
                                      Date activationDate)

Description copied from interface: ManagementService

Activates the JobDefinition with the given id.

Note: for more complex activate commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

activateJobDefinitionById in interface ManagementService

activateJobs - If true, all the Jobs of the provided job definition will be activated too.

activationDate - The date on which the job definition will be activated. If null, the job definition is activated immediately. Note: The JobExecutor needs to be active to use this!

See Also:

ManagementService.activateJobById(String), ManagementService.activateJobByJobDefinitionId(String)

suspendJobDefinitionById

public void suspendJobDefinitionById(String jobDefinitionId)

Description copied from interface: ManagementService

Suspends the JobDefinition with the given id immediately.

Note: for more complex suspend commands use ManagementService.updateJobDefinitionSuspensionState().

Note: All Jobs of the provided job definition will be not suspended.

Specified by:

suspendJobDefinitionById in interface ManagementService

See Also:

ManagementService.suspendJobById(String), ManagementService.suspendJobByJobDefinitionId(String)

suspendJobDefinitionById

public void suspendJobDefinitionById(String jobDefinitionId,
                                     boolean suspendJobs)

Description copied from interface: ManagementService

Suspends the JobDefinition with the given id immediately.

Note: for more complex suspend commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

suspendJobDefinitionById in interface ManagementService

suspendJobs - If true, all the Jobs of the provided job definition will be suspended too.

See Also:

ManagementService.suspendJobById(String), ManagementService.suspendJobByJobDefinitionId(String)

suspendJobDefinitionById

public void suspendJobDefinitionById(String jobDefinitionId,
                                     boolean suspendJobs,
                                     Date suspensionDate)

Description copied from interface: ManagementService

Suspends the JobDefinition with the given id.

Note: for more complex suspend commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

suspendJobDefinitionById in interface ManagementService

suspendJobs - If true, all the Jobs of the provided job definition will be suspended too.

suspensionDate - The date on which the job definition will be suspended. If null, the job definition is suspended immediately. Note: The JobExecutor needs to be active to use this!

See Also:

ManagementService.suspendJobById(String), ManagementService.suspendJobByJobDefinitionId(String)

activateJobDefinitionByProcessDefinitionId

public void activateJobDefinitionByProcessDefinitionId(String processDefinitionId)

Description copied from interface: ManagementService

Activates all JobDefinitions of the provided process definition id immediately.

Note: All Jobs of the provided job definition will be not activated.

Note: for more complex activate commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

activateJobDefinitionByProcessDefinitionId in interface ManagementService

See Also:

ManagementService.activateJobByProcessDefinitionId(String)

activateJobDefinitionByProcessDefinitionId

public void activateJobDefinitionByProcessDefinitionId(String processDefinitionId,
                                                       boolean activateJobs)

Description copied from interface: ManagementService

Activates all JobDefinitions of the provided process definition id immediately.

Note: for more complex activate commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

activateJobDefinitionByProcessDefinitionId in interface ManagementService

activateJobs - If true, all the Jobs of the provided job definition will be activated too.

See Also:

ManagementService.activateJobByProcessDefinitionId(String)

activateJobDefinitionByProcessDefinitionId

public void activateJobDefinitionByProcessDefinitionId(String processDefinitionId,
                                                       boolean activateJobs,
                                                       Date activationDate)

Description copied from interface: ManagementService

Activates all JobDefinitions of the provided process definition id.

Note: for more complex activate commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

activateJobDefinitionByProcessDefinitionId in interface ManagementService

activateJobs - If true, all the Jobs of the provided job definition will be activated too.

activationDate - The date on which the job definition will be activated. If null, the job definition is activated immediately. Note: The JobExecutor needs to be active to use this!

See Also:

ManagementService.activateJobByProcessDefinitionId(String)

suspendJobDefinitionByProcessDefinitionId

public void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId)

Description copied from interface: ManagementService

Suspends all JobDefinition of the provided process definition id immediately.

Note: for more complex suspend commands use ManagementService.updateJobDefinitionSuspensionState().

Note: All Jobs of the provided job definition will be not suspended.

Specified by:

suspendJobDefinitionByProcessDefinitionId in interface ManagementService

See Also:

ManagementService.suspendJobByProcessDefinitionId(String)

suspendJobDefinitionByProcessDefinitionId

public void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId,
                                                      boolean suspendJobs)

Description copied from interface: ManagementService

Suspends all JobDefinitions of the provided process definition id immediately.

Note: for more complex suspend commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

suspendJobDefinitionByProcessDefinitionId in interface ManagementService

suspendJobs - If true, all the Jobs of the provided job definition will be suspended too.

See Also:

ManagementService.suspendJobByProcessDefinitionId(String)

suspendJobDefinitionByProcessDefinitionId

public void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId,
                                                      boolean suspendJobs,
                                                      Date suspensionDate)

Description copied from interface: ManagementService

Suspends all JobDefinitions of the provided process definition id.

Note: for more complex suspend commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

suspendJobDefinitionByProcessDefinitionId in interface ManagementService

suspendJobs - If true, all the Jobs of the provided job definition will be suspended too.

suspensionDate - The date on which the job definition will be suspended. If null, the job definition is suspended immediately. Note: The JobExecutor needs to be active to use this!

See Also:

ManagementService.suspendJobByProcessDefinitionId(String)

activateJobDefinitionByProcessDefinitionKey

public void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey)

Description copied from interface: ManagementService

Activates all JobDefinitions of the provided process definition key immediately.

Note: All Jobs of the provided job definition will be not activated.

Note: for more complex activate commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

activateJobDefinitionByProcessDefinitionKey in interface ManagementService

See Also:

ManagementService.activateJobByProcessDefinitionKey(String)

activateJobDefinitionByProcessDefinitionKey

public void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey,
                                                        boolean activateJobs)

Description copied from interface: ManagementService

Activates all JobDefinitions of the provided process definition key immediately.

Note: for more complex activate commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

activateJobDefinitionByProcessDefinitionKey in interface ManagementService

activateJobs - If true, all the Jobs of the provided job definition will be activated too.

See Also:

ManagementService.activateJobByProcessDefinitionKey(String)

activateJobDefinitionByProcessDefinitionKey

public void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey,
                                                        boolean activateJobs,
                                                        Date activationDate)

Description copied from interface: ManagementService

Activates all JobDefinitions of the provided process definition key.

Note: for more complex activate commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

activateJobDefinitionByProcessDefinitionKey in interface ManagementService

activateJobs - If true, all the Jobs of the provided job definition will be activated too.

activationDate - The date on which the job definition will be activated. If null, the job definition is activated immediately. Note: The JobExecutor needs to be active to use this!

See Also:

ManagementService.activateJobByProcessDefinitionKey(String)

suspendJobDefinitionByProcessDefinitionKey

public void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey)

Description copied from interface: ManagementService

Suspends all JobDefinition of the provided process definition key immediately.

Note: for more complex suspend commands use ManagementService.updateJobDefinitionSuspensionState().

Note: All Jobs of the provided job definition will be not suspended.

Specified by:

suspendJobDefinitionByProcessDefinitionKey in interface ManagementService

See Also:

ManagementService.suspendJobByProcessDefinitionKey(String)

suspendJobDefinitionByProcessDefinitionKey

public void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey,
                                                       boolean suspendJobs)

Description copied from interface: ManagementService

Suspends all JobDefinitions of the provided process definition key immediately.

Note: for more complex suspend commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

suspendJobDefinitionByProcessDefinitionKey in interface ManagementService

suspendJobs - If true, all the Jobs of the provided job definition will be suspended too.

See Also:

ManagementService.suspendJobByProcessDefinitionKey(String)

suspendJobDefinitionByProcessDefinitionKey

public void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey,
                                                       boolean suspendJobs,
                                                       Date suspensionDate)

Description copied from interface: ManagementService

Suspends all JobDefinitions of the provided process definition key.

Note: for more complex suspend commands use ManagementService.updateJobDefinitionSuspensionState().

Specified by:

suspendJobDefinitionByProcessDefinitionKey in interface ManagementService

suspendJobs - If true, all the Jobs of the provided job definition will be suspended too.

suspensionDate - The date on which the job definition will be suspended. If null, the job definition is suspended immediately. Note: The JobExecutor needs to be active to use this!

See Also:

ManagementService.suspendJobByProcessDefinitionKey(String)

updateJobDefinitionSuspensionState

public UpdateJobDefinitionSuspensionStateSelectBuilder updateJobDefinitionSuspensionState()

Description copied from interface: ManagementService

Activate or suspend job definitions using a fluent builder. Specify the job definitions by calling one of the by methods, like byJobDefinitionId. To update the suspension state call UpdateJobDefinitionSuspensionStateBuilder.activate() or UpdateJobDefinitionSuspensionStateBuilder.suspend().

Specified by:

updateJobDefinitionSuspensionState in interface ManagementService

Returns:

the builder to update the suspension state

activateJobById

public void activateJobById(String jobId)

Description copied from interface: ManagementService

Activates the Job with the given id.

Note: for more complex activate commands use ManagementService.updateJobSuspensionState().

Specified by:

activateJobById in interface ManagementService

activateJobByProcessInstanceId

public void activateJobByProcessInstanceId(String processInstanceId)

Description copied from interface: ManagementService

Activates all Jobs of the provided process instance id.

Note: for more complex activate commands use ManagementService.updateJobSuspensionState().

Specified by:

activateJobByProcessInstanceId in interface ManagementService

activateJobByJobDefinitionId

public void activateJobByJobDefinitionId(String jobDefinitionId)

Description copied from interface: ManagementService

Activates all Jobs of the provided job definition id.

Note: for more complex activate commands use ManagementService.updateJobSuspensionState().

Specified by:

activateJobByJobDefinitionId in interface ManagementService

activateJobByProcessDefinitionId

public void activateJobByProcessDefinitionId(String processDefinitionId)

Description copied from interface: ManagementService

Activates all Jobs of the provided process definition id.

Note: for more complex activate commands use ManagementService.updateJobSuspensionState().

Specified by:

activateJobByProcessDefinitionId in interface ManagementService

activateJobByProcessDefinitionKey

public void activateJobByProcessDefinitionKey(String processDefinitionKey)

Description copied from interface: ManagementService

Activates Jobs of the provided process definition key.

Note: for more complex activate commands use ManagementService.updateJobSuspensionState().

Specified by:

activateJobByProcessDefinitionKey in interface ManagementService

suspendJobById

public void suspendJobById(String jobId)

Description copied from interface: ManagementService

Suspends the Job with the given id.

Note: for more complex suspend commands use ManagementService.updateJobSuspensionState().

Specified by:

suspendJobById in interface ManagementService

suspendJobByJobDefinitionId

public void suspendJobByJobDefinitionId(String jobDefinitionId)

Description copied from interface: ManagementService

Suspends all Jobs of the provided job definition id.

Note: for more complex suspend commands use ManagementService.updateJobSuspensionState().

Specified by:

suspendJobByJobDefinitionId in interface ManagementService

suspendJobByProcessInstanceId

public void suspendJobByProcessInstanceId(String processInstanceId)

Description copied from interface: ManagementService

Suspends all Jobs of the provided process instance id.

Note: for more complex suspend commands use ManagementService.updateJobSuspensionState().

Specified by:

suspendJobByProcessInstanceId in interface ManagementService

suspendJobByProcessDefinitionId

public void suspendJobByProcessDefinitionId(String processDefinitionId)

Description copied from interface: ManagementService

Suspends all Jobs of the provided process definition id.

Note: for more complex suspend commands use ManagementService.updateJobSuspensionState().

Specified by:

suspendJobByProcessDefinitionId in interface ManagementService

suspendJobByProcessDefinitionKey

public void suspendJobByProcessDefinitionKey(String processDefinitionKey)

Description copied from interface: ManagementService

Suspends Jobs of the provided process definition key.

Note: for more complex suspend commands use ManagementService.updateJobSuspensionState().

Specified by:

suspendJobByProcessDefinitionKey in interface ManagementService

updateJobSuspensionState

public UpdateJobSuspensionStateSelectBuilder updateJobSuspensionState()

Description copied from interface: ManagementService

Activate or suspend jobs using a fluent builder. Specify the jobs by calling one of the by methods, like byJobId. To update the suspension state call UpdateJobSuspensionStateBuilder.activate() or UpdateJobSuspensionStateBuilder.suspend().

Specified by:

updateJobSuspensionState in interface ManagementService

Returns:

the builder to update the suspension state

getHistoryLevel

public int getHistoryLevel()

Description copied from interface: ManagementService

Get the configured history level for the process engine.

Specified by:

getHistoryLevel in interface ManagementService

Returns:

the history level

createMetricsQuery

public MetricsQuery createMetricsQuery()

Specified by:

createMetricsQuery in interface ManagementService

Returns:

a new metrics Query.

deleteMetrics

public void deleteMetrics(Date timestamp)

Description copied from interface: ManagementService

Deletes all metrics events which are older than the specified timestamp. If the timestamp is null, all metrics will be deleted

Specified by:

deleteMetrics in interface ManagementService

Parameters:

timestamp - or null

deleteMetrics

public void deleteMetrics(Date timestamp,
                          String reporter)

Description copied from interface: ManagementService

Deletes all metrics events which are older than the specified timestamp and reported by the given reporter. If a parameter is null, all metric events are matched in that regard.

Specified by:

deleteMetrics in interface ManagementService

Parameters:

timestamp - or null

reporter - or null

reportDbMetricsNow

public void reportDbMetricsNow()

Description copied from interface: ManagementService

Forces this engine to commit its pending collected metrics to the database.

Specified by:

reportDbMetricsNow in interface ManagementService

setOverridingJobPriorityForJobDefinition

public void setOverridingJobPriorityForJobDefinition(String jobDefinitionId,
                                                     long priority)

Description copied from interface: ManagementService

Sets an explicit priority for jobs of the given job definition. Jobs created after invoking this method receive the given priority. This setting overrides any setting specified in the BPMN 2.0 XML.

The overriding priority can be cleared by using the method ManagementService.clearOverridingJobPriorityForJobDefinition(String).

Specified by:

setOverridingJobPriorityForJobDefinition in interface ManagementService

Parameters:

jobDefinitionId - the id of the job definition to set the priority for

priority - the priority to set;

setOverridingJobPriorityForJobDefinition

public void setOverridingJobPriorityForJobDefinition(String jobDefinitionId,
                                                     long priority,
                                                     boolean cascade)

Description copied from interface: ManagementService

Sets an explicit default priority for jobs of the given job definition. Jobs created after invoking this method receive the given priority. This setting overrides any setting specified in the BPMN 2.0 XML.

If cascade is true, priorities of already existing jobs are updated accordingly.

The overriding priority can be cleared by using the method ManagementService.clearOverridingJobPriorityForJobDefinition(String).

Specified by:

setOverridingJobPriorityForJobDefinition in interface ManagementService

Parameters:

jobDefinitionId - the id of the job definition to set the priority for

priority - the priority to set

cascade - if true, priorities of existing jobs of the given definition are changed as well

clearOverridingJobPriorityForJobDefinition

public void clearOverridingJobPriorityForJobDefinition(String jobDefinitionId)

Description copied from interface: ManagementService

Clears the job definition's overriding job priority if set. After invoking this method, new jobs of the given definition receive the priority as specified in the BPMN 2.0 XML or the global default priority.

Existing job instance priorities remain unchanged.

Specified by:

clearOverridingJobPriorityForJobDefinition in interface ManagementService

Parameters:

jobDefinitionId - the id of the job definition for which to clear the overriding priority

createBatchQuery

public BatchQuery createBatchQuery()

Description copied from interface: ManagementService

Creates a query to search for Batch instances.

Specified by:

createBatchQuery in interface ManagementService

deleteBatch

public void deleteBatch(String batchId,
                        boolean cascade)

Description copied from interface: ManagementService

Deletes a batch instance and the corresponding job definitions. If cascade is set to true the historic batch instances and the historic jobs logs are also removed.

Specified by:

deleteBatch in interface ManagementService

suspendBatchById

public void suspendBatchById(String batchId)

Description copied from interface: ManagementService

Suspends the Batch with the given id immediately.

Note: All JobDefinitions and Jobs related to the provided batch will be suspended.

Specified by:

suspendBatchById in interface ManagementService

activateBatchById

public void activateBatchById(String batchId)

Description copied from interface: ManagementService

Activates the Batch with the given id immediately.

Note: All JobDefinitions and Jobs related to the provided batch will be activated.

Specified by:

activateBatchById in interface ManagementService

createBatchStatisticsQuery

public BatchStatisticsQuery createBatchStatisticsQuery()

Description copied from interface: ManagementService

Query for the statistics of the batch execution jobs of a batch.

Specified by:

createBatchStatisticsQuery in interface ManagementService

createSchemaLogQuery

public SchemaLogQuery createSchemaLogQuery()

Description copied from interface: ManagementService

Query for entries of the database schema log.

Specified by:

createSchemaLogQuery in interface ManagementService