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
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. |
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.
|
MetricsQuery |
createMetricsQuery() |
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 |
deleteMetrics(Date timestamp)
Deletes all metrics events which are older than the specified timestamp.
|
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 database schema.
|
TableMetaData |
getTableMetaData(String tableName)
Gets the metadata (column names, column types, etc.) of a certain table.
|
String |
getTableName(Class<?> activitiEntityClass)
|
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
Jobs of the provided job definition id. |
void |
suspendJobByProcessDefinitionId(String processDefinitionId)
Suspends all
Jobs of the provided process definition id. |
void |
suspendJobByProcessDefinitionKey(String processDefinitionKey)
Activates
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.
|
getCommandExecutor, setCommandExecutorpublic ProcessApplicationRegistration registerProcessApplication(String deploymentId, ProcessApplicationReference reference)
ManagementServiceregisterProcessApplication in interface ManagementServicedeploymentId - the Id of the deployment to activatereference - the reference to the process applicationProcessApplicationRegistrationpublic void unregisterProcessApplication(String deploymentId, boolean removeProcessesFromCache)
ManagementServiceunregisterProcessApplication in interface ManagementServicedeploymentId - 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)
ManagementServiceunregisterProcessApplication in interface ManagementServicedeploymentIds - 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 ManagementServicepublic Map<String,Long> getTableCount()
ManagementServicegetTableCount in interface ManagementServicepublic String getTableName(Class<?> activitiEntityClass)
ManagementServiceTask,
Execution or the like.getTableName in interface ManagementServicepublic TableMetaData getTableMetaData(String tableName)
ManagementServicegetTableMetaData in interface ManagementServicepublic void executeJob(String jobId)
ManagementServiceexecuteJob in interface ManagementServicejobId - id of the job to execute, cannot be null.public void deleteJob(String jobId)
ManagementServicedeleteJob in interface ManagementServicejobId - id of the job to execute, cannot be null.public void setJobRetries(String jobId, int retries)
ManagementServicesetJobRetries in interface ManagementServicejobId - 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 ManagementServiceretries - number of retries.public void setJobDuedate(String jobId, Date newDuedate)
ManagementServicesetJobDuedate in interface ManagementServicejobId - id of job to modify, cannot be null.newDuedate - new date for job executionpublic TablePageQuery createTablePageQuery()
ManagementServiceTablePageQuery that can be used to fetch TablePage
containing specific sections of table row data.createTablePageQuery in interface ManagementServicepublic JobQuery createJobQuery()
ManagementServicecreateJobQuery in interface ManagementServicepublic JobDefinitionQuery createJobDefinitionQuery()
ManagementServiceJobDefinitionQuery implementation, that can be used
to dynamically query the job definitions.createJobDefinitionQuery in interface ManagementServicepublic String getJobExceptionStacktrace(String jobId)
ManagementServicegetJobExceptionStacktrace in interface ManagementServicejobId - id of the job, cannot be null.public Map<String,String> getProperties()
ManagementServicegetProperties in interface ManagementServicepublic void setProperty(String name, String value)
ManagementServicesetProperty in interface ManagementServicename - the name of the property.value - the new value for the property.public void deleteProperty(String name)
ManagementServicedeleteProperty in interface ManagementServicename - the name of the property to deletepublic String databaseSchemaUpgrade(Connection connection, String catalog, String schema)
ManagementServicedatabaseSchemaUpgrade in interface ManagementServicepublic ProcessDefinitionStatisticsQuery createProcessDefinitionStatisticsQuery()
ManagementServicecreateProcessDefinitionStatisticsQuery in interface ManagementServicepublic ActivityStatisticsQuery createActivityStatisticsQuery(String processDefinitionId)
ManagementServicecreateActivityStatisticsQuery in interface ManagementServicepublic DeploymentStatisticsQuery createDeploymentStatisticsQuery()
ManagementServicecreateDeploymentStatisticsQuery in interface ManagementServicepublic Set<String> getRegisteredDeployments()
ManagementServicejobExecutorDeploymentAware is set.getRegisteredDeployments in interface ManagementServicepublic void registerDeploymentForJobExecutor(String deploymentId)
ManagementServicejobExecutorDeploymentAware is set.
If set to false, the job executor will execute any job.registerDeploymentForJobExecutor in interface ManagementServicepublic void unregisterDeploymentForJobExecutor(String deploymentId)
ManagementServicejobExecutorDeploymentAware is set,
jobs for the given deployment will no longer get acquired.unregisterDeploymentForJobExecutor in interface ManagementServicepublic void activateJobDefinitionById(String jobDefinitionId)
ManagementServiceActivates the JobDefinition with the given id immediately.
Note: All Jobs of the provided job definition
will be not activated.
activateJobDefinitionById in interface ManagementServiceManagementService.activateJobById(String),
ManagementService.activateJobByJobDefinitionId(String)public void activateJobDefinitionById(String jobDefinitionId, boolean activateJobs)
ManagementServiceActivates the JobDefinition with the given id immediately.
activateJobDefinitionById in interface ManagementServiceactivateJobs - If true, all the Jobs of the provided job definition
will be activated too.ManagementService.activateJobById(String),
ManagementService.activateJobByJobDefinitionId(String)public void activateJobDefinitionById(String jobDefinitionId, boolean activateJobs, Date activationDate)
ManagementServiceJobDefinition with the given id.activateJobDefinitionById in interface ManagementServiceactivateJobs - 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!ManagementService.activateJobById(String),
ManagementService.activateJobByJobDefinitionId(String)public void suspendJobDefinitionById(String jobDefinitionId)
ManagementServiceSuspends the JobDefinition with the given id immediately.
Note: All Jobs of the provided job definition
will be not suspended.
suspendJobDefinitionById in interface ManagementServiceManagementService.suspendJobById(String),
ManagementService.suspendJobByJobDefinitionId(String)public void suspendJobDefinitionById(String jobDefinitionId, boolean suspendJobs)
ManagementServiceJobDefinition with the given id immediately.suspendJobDefinitionById in interface ManagementServicesuspendJobs - If true, all the Jobs of the provided job definition
will be suspended too.ManagementService.suspendJobById(String),
ManagementService.suspendJobByJobDefinitionId(String)public void suspendJobDefinitionById(String jobDefinitionId, boolean suspendJobs, Date suspensionDate)
ManagementServiceJobDefinition with the given id.suspendJobDefinitionById in interface ManagementServicesuspendJobs - 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!ManagementService.suspendJobById(String),
ManagementService.suspendJobByJobDefinitionId(String)public void activateJobDefinitionByProcessDefinitionId(String processDefinitionId)
ManagementServiceActivates all JobDefinitions of the provided process definition id immediately.
Note: All Jobs of the provided job definition
will be not activated.
activateJobDefinitionByProcessDefinitionId in interface ManagementServiceManagementService.activateJobByProcessDefinitionId(String)public void activateJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean activateJobs)
ManagementServiceActivates all JobDefinitions of the provided process definition id immediately.
activateJobDefinitionByProcessDefinitionId in interface ManagementServiceactivateJobs - If true, all the Jobs of the provided job definition
will be activated too.ManagementService.activateJobByProcessDefinitionId(String)public void activateJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean activateJobs, Date activationDate)
ManagementServiceActivates all JobDefinitions of the provided process definition id.
activateJobDefinitionByProcessDefinitionId in interface ManagementServiceactivateJobs - 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!ManagementService.activateJobByProcessDefinitionId(String)public void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId)
ManagementServiceSuspends all JobDefinition of the provided process definition id immediately.
Note: All Jobs of the provided job definition
will be not suspended.
suspendJobDefinitionByProcessDefinitionId in interface ManagementServiceManagementService.suspendJobByProcessDefinitionId(String)public void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean suspendJobs)
ManagementServiceJobDefinitions of the provided process definition id immediately.suspendJobDefinitionByProcessDefinitionId in interface ManagementServicesuspendJobs - If true, all the Jobs of the provided job definition
will be suspended too.ManagementService.suspendJobByProcessDefinitionId(String)public void suspendJobDefinitionByProcessDefinitionId(String processDefinitionId, boolean suspendJobs, Date suspensionDate)
ManagementServiceJobDefinitions of the provided process definition id.suspendJobDefinitionByProcessDefinitionId in interface ManagementServicesuspendJobs - 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!ManagementService.suspendJobByProcessDefinitionId(String)public void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey)
ManagementServiceActivates all JobDefinitions of the provided process definition key immediately.
Note: All Jobs of the provided job definition
will be not activated.
activateJobDefinitionByProcessDefinitionKey in interface ManagementServiceManagementService.activateJobByProcessDefinitionKey(String)public void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean activateJobs)
ManagementServiceActivates all JobDefinitions of the provided process definition key immediately.
activateJobDefinitionByProcessDefinitionKey in interface ManagementServiceactivateJobs - If true, all the Jobs of the provided job definition
will be activated too.ManagementService.activateJobByProcessDefinitionKey(String)public void activateJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean activateJobs, Date activationDate)
ManagementServiceActivates all JobDefinitions of the provided process definition key.
activateJobDefinitionByProcessDefinitionKey in interface ManagementServiceactivateJobs - 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!ManagementService.activateJobByProcessDefinitionKey(String)public void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey)
ManagementServiceSuspends all JobDefinition of the provided process definition key immediately.
Note: All Jobs of the provided job definition
will be not suspended.
suspendJobDefinitionByProcessDefinitionKey in interface ManagementServiceManagementService.suspendJobByProcessDefinitionKey(String)public void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean suspendJobs)
ManagementServiceJobDefinitions of the provided process definition key immediately.suspendJobDefinitionByProcessDefinitionKey in interface ManagementServicesuspendJobs - If true, all the Jobs of the provided job definition
will be suspended too.ManagementService.suspendJobByProcessDefinitionKey(String)public void suspendJobDefinitionByProcessDefinitionKey(String processDefinitionKey, boolean suspendJobs, Date suspensionDate)
ManagementServiceJobDefinitions of the provided process definition key.suspendJobDefinitionByProcessDefinitionKey in interface ManagementServicesuspendJobs - 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!ManagementService.suspendJobByProcessDefinitionKey(String)public void activateJobById(String jobId)
ManagementServiceActivates the Job with the given id.
activateJobById in interface ManagementServicepublic void activateJobByProcessInstanceId(String processInstanceId)
ManagementServiceActivates all Jobs of the provided process instance id.
activateJobByProcessInstanceId in interface ManagementServicepublic void activateJobByJobDefinitionId(String jobDefinitionId)
ManagementServiceActivates all Jobs of the provided job definition id.
activateJobByJobDefinitionId in interface ManagementServicepublic void activateJobByProcessDefinitionId(String processDefinitionId)
ManagementServiceActivates all Jobs of the provided process definition id.
activateJobByProcessDefinitionId in interface ManagementServicepublic void activateJobByProcessDefinitionKey(String processDefinitionKey)
ManagementServiceActivates Jobs of the provided process definition key.
activateJobByProcessDefinitionKey in interface ManagementServicepublic void suspendJobById(String jobId)
ManagementServiceSuspends the Job with the given id.
suspendJobById in interface ManagementServicepublic void suspendJobByJobDefinitionId(String jobDefinitionId)
ManagementServiceSuspends all Jobs of the provided job definition id.
suspendJobByJobDefinitionId in interface ManagementServicepublic void suspendJobByProcessInstanceId(String processInstanceId)
ManagementServiceSuspends all Jobs of the provided process instance id.
suspendJobByProcessInstanceId in interface ManagementServicepublic void suspendJobByProcessDefinitionId(String processDefinitionId)
ManagementServiceSuspends all Jobs of the provided process definition id.
suspendJobByProcessDefinitionId in interface ManagementServicepublic void suspendJobByProcessDefinitionKey(String processDefinitionKey)
ManagementServiceActivates Jobs of the provided process definition key.
suspendJobByProcessDefinitionKey in interface ManagementServicepublic int getHistoryLevel()
ManagementServicegetHistoryLevel in interface ManagementServicepublic MetricsQuery createMetricsQuery()
createMetricsQuery in interface ManagementServicepublic void deleteMetrics(Date timestamp)
ManagementServicedeleteMetrics in interface ManagementServicetimestamp - or nullCopyright © 2018. All rights reserved.