public class ManagementServiceImpl extends ServiceImpl implements ManagementService
commandExecutor
Constructor and Description |
---|
ManagementServiceImpl() |
Modifier and Type | Method and Description |
---|---|
void |
activateJobById(String jobId)
Activates the
Job with the given id. |
void |
activateJobByJobDefinitionId(String jobDefinitionId)
Activates all
Job s of the provided job definition id. |
void |
activateJobByProcessDefinitionId(String processDefinitionId)
Activates all
Job s of the provided process definition id. |
void |
activateJobByProcessDefinitionKey(String processDefinitionKey)
Activates
Job s of the provided process definition key. |
void |
activateJobByProcessInstanceId(String processInstanceId)
Activates all
Job s 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
JobDefinition s of the provided process definition id immediately. |
void |
activateJobDefinitionByProcessDefinitionId(String processDefinitionId,
boolean activateJobs)
Activates all
JobDefinition s of the provided process definition id immediately. |
void |
activateJobDefinitionByProcessDefinitionId(String processDefinitionId,
boolean activateJobs,
Date activationDate)
Activates all
JobDefinition s of the provided process definition id. |
void |
activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey)
Activates all
JobDefinition s of the provided process definition key immediately. |
void |
activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey,
boolean activateJobs)
Activates all
JobDefinition s of the provided process definition key immediately. |
void |
activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey,
boolean activateJobs,
Date activationDate)
Activates all
JobDefinition s of the provided process definition key. |
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.
|
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.
|
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
Note: will always return an empty string
|
void |
deleteJob(String jobId)
Delete the job with the provided id.
|
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 |
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 |
setJobRetriesByJobDefinitionId(String jobDefinitionId,
int retries)
Set the number of retries of all failed
jobs
of the provided job definition id. |
void |
setProperty(String name,
String value)
Set the value for a property.
|
void |
suspendJobById(String jobId)
Suspends the
Job with the given id. |
void |
suspendJobByJobDefinitionId(String jobDefinitionId)
Suspends all
Job s of the provided job definition id. |
void |
suspendJobByProcessDefinitionId(String processDefinitionId)
Suspends all
Job s of the provided process definition id. |
void |
suspendJobByProcessDefinitionKey(String processDefinitionKey)
Activates
Job s of the provided process definition key. |
void |
suspendJobByProcessInstanceId(String processInstanceId)
Suspends all
Job s 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
JobDefinition s of the provided process definition id immediately. |
void |
suspendJobDefinitionByProcessDefinitionId(String processDefinitionId,
boolean suspendJobs,
Date suspensionDate)
Suspends all
JobDefinition s 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
JobDefinition s of the provided process definition key immediately. |
void |
suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey,
boolean suspendJobs,
Date suspensionDate)
Suspends all
JobDefinition s 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.
|
getCommandExecutor, setCommandExecutor
public ProcessApplicationRegistration registerProcessApplication(String deploymentId, ProcessApplicationReference reference)
ManagementService
registerProcessApplication
in interface ManagementService
deploymentId
- the Id of the deployment to activatereference
- the reference to the process applicationProcessApplicationRegistration
public void unregisterProcessApplication(String deploymentId, boolean removeProcessesFromCache)
ManagementService
unregisterProcessApplication
in interface ManagementService
deploymentId
- the Id of the deployment to deactivateremoveProcessesFromCache
- indicates whether the process definitions should be removed from the deployment cachepublic void unregisterProcessApplication(Set<String> deploymentIds, boolean removeProcessesFromCache)
ManagementService
unregisterProcessApplication
in interface ManagementService
deploymentIds
- the Ids of the deployments to deactivateremoveProcessesFromCache
- indicates whether the process definitions should be removed from the deployment cachepublic String getProcessApplicationForDeployment(String deploymentId)
getProcessApplicationForDeployment
in interface ManagementService
public Map<String,Long> getTableCount()
ManagementService
getTableCount
in interface ManagementService
public String getTableName(Class<?> activitiEntityClass)
ManagementService
getTableName
in interface ManagementService
public TableMetaData getTableMetaData(String tableName)
ManagementService
getTableMetaData
in interface ManagementService
public void executeJob(String jobId)
ManagementService
executeJob
in interface ManagementService
jobId
- id of the job to execute, cannot be null.public void deleteJob(String jobId)
ManagementService
deleteJob
in interface ManagementService
jobId
- id of the job to execute, cannot be null.public void setJobRetries(String jobId, int retries)
ManagementService
setJobRetries
in interface ManagementService
jobId
- id of the job to modify, cannot be null.retries
- number of retries.public void setJobRetriesByJobDefinitionId(String jobDefinitionId, int retries)
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.
setJobRetriesByJobDefinitionId
in interface ManagementService
retries
- number of retries.public void setJobDuedate(String jobId, Date newDuedate)
ManagementService
setJobDuedate
in interface ManagementService
jobId
- id of job to modify, cannot be null.newDuedate
- new date for job executionpublic TablePageQuery createTablePageQuery()
ManagementService
TablePageQuery
that can be used to fetch TablePage
containing specific sections of table row data.createTablePageQuery
in interface ManagementService
public JobQuery createJobQuery()
ManagementService
createJobQuery
in interface ManagementService
public JobDefinitionQuery createJobDefinitionQuery()
ManagementService
JobDefinitionQuery
implementation, that can be used
to dynamically query the job definitions.createJobDefinitionQuery
in interface ManagementService
public String getJobExceptionStacktrace(String jobId)
ManagementService
getJobExceptionStacktrace
in interface ManagementService
jobId
- id of the job, cannot be null.public Map<String,String> getProperties()
ManagementService
getProperties
in interface ManagementService
public void setProperty(String name, String value)
ManagementService
setProperty
in interface ManagementService
name
- the name of the property.value
- the new value for the property.public void deleteProperty(String name)
ManagementService
deleteProperty
in interface ManagementService
name
- the name of the property to deletepublic String databaseSchemaUpgrade(Connection connection, String catalog, String schema)
ManagementService
databaseSchemaUpgrade
in interface ManagementService
public ProcessDefinitionStatisticsQuery createProcessDefinitionStatisticsQuery()
ManagementService
createProcessDefinitionStatisticsQuery
in interface ManagementService
public ActivityStatisticsQuery createActivityStatisticsQuery(String processDefinitionId)
ManagementService
createActivityStatisticsQuery
in interface ManagementService
public DeploymentStatisticsQuery createDeploymentStatisticsQuery()
ManagementService
createDeploymentStatisticsQuery
in interface ManagementService
public Set<String> getRegisteredDeployments()
ManagementService
jobExecutorDeploymentAware
is set.getRegisteredDeployments
in interface ManagementService
public void registerDeploymentForJobExecutor(String deploymentId)
ManagementService
jobExecutorDeploymentAware
is set.
If set to false, the job executor will execute any job.registerDeploymentForJobExecutor
in interface ManagementService
public void unregisterDeploymentForJobExecutor(String deploymentId)
ManagementService
jobExecutorDeploymentAware
is set,
jobs for the given deployment will no longer get acquired.unregisterDeploymentForJobExecutor
in interface ManagementService
public void activateJobDefinitionById(String jobDefinitionId)
ManagementService
Activates the JobDefinition
with the given id immediately.
Note: All Job
s of the provided job definition
will be not activated.
activateJobDefinitionById
in interface ManagementService
ManagementService.activateJobById(String)
,
ManagementService.activateJobByJobDefinitionId(String)
public void activateJobDefinitionById(String jobDefinitionId, boolean activateJobs)
ManagementService
Activates the JobDefinition
with the given id immediately.
activateJobDefinitionById
in interface ManagementService
activateJobs
- If true, all the Job
s of the provided job definition
will be activated too.ManagementService.activateJobById(String)
,
ManagementService.activateJobByJobDefinitionId(String)
public void activateJobDefinitionById(String jobDefinitionId, boolean activateJobs, Date activationDate)
ManagementService
JobDefinition
with the given id.activateJobDefinitionById
in interface ManagementService
activateJobs
- If true, all the Job
s 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!ManagementService.activateJobById(String)
,
ManagementService.activateJobByJobDefinitionId(String)
public void suspendJobDefinitionById(String jobDefinitionId)
ManagementService
Suspends the JobDefinition
with the given id immediately.
Note: All Job
s of the provided job definition
will be not suspended.
suspendJobDefinitionById
in interface ManagementService
ManagementService.suspendJobById(String)
,
ManagementService.suspendJobByJobDefinitionId(String)
public void suspendJobDefinitionById(String jobDefinitionId, boolean suspendJobs)
ManagementService
JobDefinition
with the given id immediately.suspendJobDefinitionById
in interface ManagementService
suspendJobs
- If true, all the Job
s of the provided job definition
will be suspended too.ManagementService.suspendJobById(String)
,
ManagementService.suspendJobByJobDefinitionId(String)
public void suspendJobDefinitionById(String jobDefinitionId, boolean suspendJobs, Date suspensionDate)
ManagementService
JobDefinition
with the given id.suspendJobDefinitionById
in interface ManagementService
suspendJobs
- If true, all the Job
s 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!ManagementService.suspendJobById(String)
,
ManagementService.suspendJobByJobDefinitionId(String)
public void activateJobDefinitionByProcessDefinitionId(String processDefinitionId)
ManagementService
Activates all JobDefinition
s of the provided process definition id immediately.
Note: All Job
s of the provided job definition
will be not activated.
activateJobDefinitionByProcessDefinitionId
in interface ManagementService
ManagementService.activateJobByProcessDefinitionId(String)
public void activateJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean activateJobs)
ManagementService
Activates all JobDefinition
s of the provided process definition id immediately.
activateJobDefinitionByProcessDefinitionId
in interface ManagementService
activateJobs
- If true, all the Job
s of the provided job definition
will be activated too.ManagementService.activateJobByProcessDefinitionId(String)
public void activateJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean activateJobs, Date activationDate)
ManagementService
Activates all JobDefinition
s of the provided process definition id.
activateJobDefinitionByProcessDefinitionId
in interface ManagementService
activateJobs
- If true, all the Job
s 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!ManagementService.activateJobByProcessDefinitionId(String)
public void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId)
ManagementService
Suspends all JobDefinition
of the provided process definition id immediately.
Note: All Job
s of the provided job definition
will be not suspended.
suspendJobDefinitionByProcessDefinitionId
in interface ManagementService
ManagementService.suspendJobByProcessDefinitionId(String)
public void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean suspendJobs)
ManagementService
JobDefinition
s of the provided process definition id immediately.suspendJobDefinitionByProcessDefinitionId
in interface ManagementService
suspendJobs
- If true, all the Job
s of the provided job definition
will be suspended too.ManagementService.suspendJobByProcessDefinitionId(String)
public void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean suspendJobs, Date suspensionDate)
ManagementService
JobDefinition
s of the provided process definition id.suspendJobDefinitionByProcessDefinitionId
in interface ManagementService
suspendJobs
- If true, all the Job
s 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!ManagementService.suspendJobByProcessDefinitionId(String)
public void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey)
ManagementService
Activates all JobDefinition
s of the provided process definition key immediately.
Note: All Job
s of the provided job definition
will be not activated.
activateJobDefinitionByProcessDefinitionKey
in interface ManagementService
ManagementService.activateJobByProcessDefinitionKey(String)
public void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean activateJobs)
ManagementService
Activates all JobDefinition
s of the provided process definition key immediately.
activateJobDefinitionByProcessDefinitionKey
in interface ManagementService
activateJobs
- If true, all the Job
s of the provided job definition
will be activated too.ManagementService.activateJobByProcessDefinitionKey(String)
public void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean activateJobs, Date activationDate)
ManagementService
Activates all JobDefinition
s of the provided process definition key.
activateJobDefinitionByProcessDefinitionKey
in interface ManagementService
activateJobs
- If true, all the Job
s 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!ManagementService.activateJobByProcessDefinitionKey(String)
public void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey)
ManagementService
Suspends all JobDefinition
of the provided process definition key immediately.
Note: All Job
s of the provided job definition
will be not suspended.
suspendJobDefinitionByProcessDefinitionKey
in interface ManagementService
ManagementService.suspendJobByProcessDefinitionKey(String)
public void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean suspendJobs)
ManagementService
JobDefinition
s of the provided process definition key immediately.suspendJobDefinitionByProcessDefinitionKey
in interface ManagementService
suspendJobs
- If true, all the Job
s of the provided job definition
will be suspended too.ManagementService.suspendJobByProcessDefinitionKey(String)
public void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean suspendJobs, Date suspensionDate)
ManagementService
JobDefinition
s of the provided process definition key.suspendJobDefinitionByProcessDefinitionKey
in interface ManagementService
suspendJobs
- If true, all the Job
s 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!ManagementService.suspendJobByProcessDefinitionKey(String)
public void activateJobById(String jobId)
ManagementService
Activates the Job
with the given id.
activateJobById
in interface ManagementService
public void activateJobByProcessInstanceId(String processInstanceId)
ManagementService
Activates all Job
s of the provided process instance id.
activateJobByProcessInstanceId
in interface ManagementService
public void activateJobByJobDefinitionId(String jobDefinitionId)
ManagementService
Activates all Job
s of the provided job definition id.
activateJobByJobDefinitionId
in interface ManagementService
public void activateJobByProcessDefinitionId(String processDefinitionId)
ManagementService
Activates all Job
s of the provided process definition id.
activateJobByProcessDefinitionId
in interface ManagementService
public void activateJobByProcessDefinitionKey(String processDefinitionKey)
ManagementService
Activates Job
s of the provided process definition key.
activateJobByProcessDefinitionKey
in interface ManagementService
public void suspendJobById(String jobId)
ManagementService
Suspends the Job
with the given id.
suspendJobById
in interface ManagementService
public void suspendJobByJobDefinitionId(String jobDefinitionId)
ManagementService
Suspends all Job
s of the provided job definition id.
suspendJobByJobDefinitionId
in interface ManagementService
public void suspendJobByProcessInstanceId(String processInstanceId)
ManagementService
Suspends all Job
s of the provided process instance id.
suspendJobByProcessInstanceId
in interface ManagementService
public void suspendJobByProcessDefinitionId(String processDefinitionId)
ManagementService
Suspends all Job
s of the provided process definition id.
suspendJobByProcessDefinitionId
in interface ManagementService
public void suspendJobByProcessDefinitionKey(String processDefinitionKey)
ManagementService
Activates Job
s of the provided process definition key.
suspendJobByProcessDefinitionKey
in interface ManagementService
public int getHistoryLevel()
ManagementService
getHistoryLevel
in interface ManagementService
Copyright © 2018. All rights reserved.