Package org.flowable.cmmn.engine.impl

Class CmmnManagementServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<CmmnEngineConfiguration>

org.flowable.cmmn.engine.impl.CmmnManagementServiceImpl

All Implemented Interfaces:

CmmnManagementService

public class CmmnManagementServiceImpl
extends CommonEngineServiceImpl<CmmnEngineConfiguration>
implements CmmnManagementService

Author:

Joram Barrez

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor	Description
CmmnManagementServiceImpl(CmmnEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method	Description
void	bulkMoveDeadLetterJobs(Collection<String> jobIds, int retries)	Moves a bulk of jobs that are in the dead letter job table back to the executable job table, and resets the retries (as the retries was 0 when it was put into the dead letter job table).
void	bulkMoveDeadLetterJobsToHistoryJobs(Collection<String> jobIds, int retries)	Moves a bulk of jobs that are in the dead letter job table back to be history jobs, and resets the retries (as the retries was 0 when it was put into the dead letter job table).
BatchBuilder	createBatchBuilder()
BatchPartBuilder	createBatchPartBuilder(Batch batch)
BatchPartQuery	createBatchPartQuery()	Returns a new BatchPartQuery implementation, that can be used to dynamically query the batch parts.
BatchQuery	createBatchQuery()	Returns a new BatchQuery implementation, that can be used to dynamically query the batches.
ChangeTenantIdBuilder	createChangeTenantIdBuilder(String fromTenantId, String toTenantId)	Create a ChangeTenantIdBuilder that can be used to change the tenant id of the case instances and all the related instances.
CmmnExternalWorkerTransitionBuilder	createCmmnExternalWorkerTransitionBuilder(String externalJobId, String workerId)	Create a CmmnExternalWorkerTransitionBuilder that can be used to transition the status of the external worker job.
DeadLetterJobQuery	createDeadLetterJobQuery()	Returns a new DeadLetterJobQuery implementation, that can be used to query the dead letter jobs.
ExternalWorkerJobAcquireBuilder	createExternalWorkerJobAcquireBuilder()	Create an ExternalWorkerJobAcquireBuilder that can be used to acquire jobs for an external worker.
ExternalWorkerJobFailureBuilder	createExternalWorkerJobFailureBuilder(String externalJobId, String workerId)	Create an ExternalWorkerJobFailureBuilder that can be used to fail an external worker job.
ExternalWorkerJobQuery	createExternalWorkerJobQuery()	Returns a new ExternalWorkerJobQuery implementation, that can be used to dynamically query the external worker jobs.
HistoryJobQuery	createHistoryJobQuery()	Returns a new HistoryJobQuery implementation, that can be used to dynamically query the history jobs.
JobQuery	createJobQuery()	Returns a new JobQuery implementation, that can be used to query the jobs.
SuspendedJobQuery	createSuspendedJobQuery()	Returns a new SuspendedJobQuery implementation, that can be used to query the suspended jobs.
TimerJobQuery	createTimerJobQuery()	Returns a new TimerJobQuery implementation, that can be used to query the timer jobs.
void	deleteBatch(String batchId)
void	deleteDeadLetterJob(String jobId)	Delete the dead letter job with the provided id.
void	deleteHistoryJob(String jobId)	Delete the history job with the provided id.
void	deleteJob(String jobId)	Delete the job with the provided id.
void	deleteSuspendedJob(String jobId)	Delete the suspended job with the provided id.
void	deleteTimerJob(String jobId)	Delete the timer job with the provided id.
<T> T	executeCommand(Command<T> command)
<T> T	executeCommand(CommandConfig config, Command<T> command)
void	executeHistoryJob(String historyJobId)	Forced synchronous execution of a historyJob (eg.
void	executeJob(String jobId)	Forced synchronous execution of a job (eg.
String	getDeadLetterJobExceptionStacktrace(String jobId)	Returns the full stacktrace of the exception that occurs when the deadletter job with the given id was last executed.
String	getExternalWorkerJobErrorDetails(String jobId)	Returns the full error details that were passed to the External worker Job when the job was last failed.
String	getHistoryJobHistoryJson(String historyJobId)	Get the advanced configuration (storing the history json data) of a HistoryJob.
String	getJobExceptionStacktrace(String jobId)	Returns the full stacktrace of the exception that occurs when the job with the given id was last executed.
String	getSuspendedJobExceptionStacktrace(String jobId)	Returns the full stacktrace of the exception that occurs when the suspended with the given id was last executed.
Map<String,Long>	getTableCounts()	Returns a map containing {tableName, rowCount} values.
Collection<String>	getTableNames()	Returns all relational database tables of the engine.
String	getTimerJobExceptionStacktrace(String jobId)	Returns the full stacktrace of the exception that occurs when the timer job with the given id was last executed.
void	handleHistoryCleanupTimerJob()
Job	moveDeadLetterJobToExecutableJob(String jobId, int retries)	Moves a job that is in the dead letter job table back to be an executable job, and resetting the retries (as the retries were probably 0 when it was put into the dead letter job table).
HistoryJob	moveDeadLetterJobToHistoryJob(String jobId, int retries)	Moves a job that is in the dead letter job table back to be a history job, and resetting the retries (as the retries was 0 when it was put into the dead letter job table).
Job	moveJobToDeadLetterJob(String jobId)	Moves a job to the dead letter job table (eg.
Job	moveSuspendedJobToExecutableJob(String jobId)	Moves a suspended job from the suspended letter job table back to be an executable job.
Job	moveTimerToExecutableJob(String jobId)	Moves a timer job to the executable job table (eg.
Job	rescheduleTimeDateJob(String jobId, Date timeDate)	Reschedule a timer job with a new date value.
Job	rescheduleTimeDateValueJob(String jobId, String timeDateValue)	Reschedule a timer job with a time date value.
Job	rescheduleTimerEventListenerInstanceWithDate(String eventListenerInstanceId, Date timeDate)	Reschedule a timer event listener instance with a new date value.
Job	rescheduleTimerEventListenerInstanceWithDateValue(String eventListenerInstanceId, String timeDateValue)	Reschedule a timer event listener instance with a time date value.
void	setJobRetries(String jobId, int retries)	Sets the number of retries that a job has left.
void	setTimerJobRetries(String jobId, int retries)	Sets the number of retries that a timer job has left.
void	unacquireAllExternalWorkerJobsForWorker(String workerId)	Unaquire all locked external worker jobs for worker.
void	unacquireAllExternalWorkerJobsForWorker(String workerId, String tenantId)	Unaquire all locked external worker jobs for worker and tenant.
void	unacquireExternalWorkerJob(String jobId, String workerId)	Unaquire a locked external worker job.

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

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

Constructor Details

CmmnManagementServiceImpl

public CmmnManagementServiceImpl(CmmnEngineConfiguration engineConfiguration)

Method Details

getTableCounts

public Map<String,Long> getTableCounts()

Description copied from interface: CmmnManagementService

Returns a map containing {tableName, rowCount} values.

Specified by:

getTableCounts in interface CmmnManagementService

getTableNames

public Collection<String> getTableNames()

Description copied from interface: CmmnManagementService

Returns all relational database tables of the engine.

Specified by:

getTableNames in interface CmmnManagementService

executeJob

public void executeJob(String jobId)

Description copied from interface: CmmnManagementService

Forced synchronous execution of a job (eg. for administration or testing). The job will be executed, even if the case instance is suspended.

Specified by:

executeJob in interface CmmnManagementService

Parameters:

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

executeHistoryJob

public void executeHistoryJob(String historyJobId)

Description copied from interface: CmmnManagementService

Forced synchronous execution of a historyJob (eg. for administration or testing).

Specified by:

executeHistoryJob in interface CmmnManagementService

Parameters:

historyJobId - id of the historyjob to execute, cannot be null.

getHistoryJobHistoryJson

public String getHistoryJobHistoryJson(String historyJobId)

Description copied from interface: CmmnManagementService

Get the advanced configuration (storing the history json data) of a HistoryJob.

Specified by:

getHistoryJobHistoryJson in interface CmmnManagementService

Parameters:

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

deleteHistoryJob

public void deleteHistoryJob(String jobId)

Description copied from interface: CmmnManagementService

Delete the history job with the provided id.

Specified by:

deleteHistoryJob in interface CmmnManagementService

Parameters:

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

moveTimerToExecutableJob

public Job moveTimerToExecutableJob(String jobId)

Description copied from interface: CmmnManagementService

Moves a timer job to the executable job table (eg. for administration or testing). The timer job will be moved, even if the case instance is suspended.

Specified by:

moveTimerToExecutableJob in interface CmmnManagementService

Parameters:

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

moveJobToDeadLetterJob

public Job moveJobToDeadLetterJob(String jobId)

Description copied from interface: CmmnManagementService

Moves a job to the dead letter job table (eg. for administration or testing). The job will be moved, even if the case instance is suspended or there are retries left.

Specified by:

moveJobToDeadLetterJob in interface CmmnManagementService

Parameters:

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

moveDeadLetterJobToExecutableJob

public Job moveDeadLetterJobToExecutableJob(String jobId,
 int retries)

Description copied from interface: CmmnManagementService

Moves a job that is in the dead letter job table back to be an executable job, and resetting the retries (as the retries were probably 0 when it was put into the dead letter job table).

Specified by:

moveDeadLetterJobToExecutableJob in interface CmmnManagementService

Parameters:

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

retries - the number of retries (value greater than 0) which will be set on the job.

bulkMoveDeadLetterJobs

public void bulkMoveDeadLetterJobs(Collection<String> jobIds,
 int retries)

Description copied from interface: CmmnManagementService

Moves a bulk of jobs that are in the dead letter job table back to the executable job table, and resets the retries (as the retries was 0 when it was put into the dead letter job table).

Specified by:

bulkMoveDeadLetterJobs in interface CmmnManagementService

Parameters:

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

retries - the number of retries (value greater than 0) which will be set on the jobs.

bulkMoveDeadLetterJobsToHistoryJobs

public void bulkMoveDeadLetterJobsToHistoryJobs(Collection<String> jobIds,
 int retries)

Description copied from interface: CmmnManagementService

Moves a bulk of jobs that are in the dead letter job table back to be history jobs, and resets the retries (as the retries was 0 when it was put into the dead letter job table).

Specified by:

bulkMoveDeadLetterJobsToHistoryJobs in interface CmmnManagementService

Parameters:

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

retries - the number of retries (value greater than 0) which will be set on the jobs.

moveDeadLetterJobToHistoryJob

public HistoryJob moveDeadLetterJobToHistoryJob(String jobId,
 int retries)

Description copied from interface: CmmnManagementService

Moves a job that is in the dead letter job table back to be a history job, and resetting the retries (as the retries was 0 when it was put into the dead letter job table).

Specified by:

moveDeadLetterJobToHistoryJob in interface CmmnManagementService

Parameters:

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

retries - the number of retries (value greater than 0) which will be set on the job.

moveSuspendedJobToExecutableJob

public Job moveSuspendedJobToExecutableJob(String jobId)

Description copied from interface: CmmnManagementService

Moves a suspended job from the suspended letter job table back to be an executable job. The retries are untouched.

Specified by:

moveSuspendedJobToExecutableJob in interface CmmnManagementService

Parameters:

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

deleteJob

public void deleteJob(String jobId)

Description copied from interface: CmmnManagementService

Delete the job with the provided id.

Specified by:

deleteJob in interface CmmnManagementService

Parameters:

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

deleteTimerJob

public void deleteTimerJob(String jobId)

Description copied from interface: CmmnManagementService

Delete the timer job with the provided id.

Specified by:

deleteTimerJob in interface CmmnManagementService

Parameters:

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

deleteSuspendedJob

public void deleteSuspendedJob(String jobId)

Description copied from interface: CmmnManagementService

Delete the suspended job with the provided id.

Specified by:

deleteSuspendedJob in interface CmmnManagementService

Parameters:

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

deleteDeadLetterJob

public void deleteDeadLetterJob(String jobId)

Description copied from interface: CmmnManagementService

Delete the dead letter job with the provided id.

Specified by:

deleteDeadLetterJob in interface CmmnManagementService

Parameters:

jobId - id of the dead letter job to delete, cannot be null.

setJobRetries

public void setJobRetries(String jobId,
 int retries)

Description copied from interface: CmmnManagementService

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 CmmnManagementService

Parameters:

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

retries - number of retries.

setTimerJobRetries

public void setTimerJobRetries(String jobId,
 int retries)

Description copied from interface: CmmnManagementService

Sets the number of retries that a timer job has left. Whenever the JobExecutor fails to execute a timer 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:

setTimerJobRetries in interface CmmnManagementService

Parameters:

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

retries - number of retries.

rescheduleTimeDateJob

public Job rescheduleTimeDateJob(String jobId,
 Date timeDate)

Description copied from interface: CmmnManagementService

Reschedule a timer job with a new date value.

Specified by:

rescheduleTimeDateJob in interface CmmnManagementService

Parameters:

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

timeDate - A fixed date

rescheduleTimeDateValueJob

public Job rescheduleTimeDateValueJob(String jobId,
 String timeDateValue)

Description copied from interface: CmmnManagementService

Reschedule a timer job with a time date value.

Specified by:

rescheduleTimeDateValueJob in interface CmmnManagementService

Parameters:

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

timeDateValue - A fixed date in ISO 8601 format, when job will be fired

rescheduleTimerEventListenerInstanceWithDate

public Job rescheduleTimerEventListenerInstanceWithDate(String eventListenerInstanceId,
 Date timeDate)

Description copied from interface: CmmnManagementService

Reschedule a timer event listener instance with a new date value.

Specified by:

rescheduleTimerEventListenerInstanceWithDate in interface CmmnManagementService

Parameters:

eventListenerInstanceId - id of the timer event listener instance to reschedule, cannot be null.

timeDate - A fixed date

rescheduleTimerEventListenerInstanceWithDateValue

public Job rescheduleTimerEventListenerInstanceWithDateValue(String eventListenerInstanceId,
 String timeDateValue)

Description copied from interface: CmmnManagementService

Reschedule a timer event listener instance with a time date value.

Specified by:

rescheduleTimerEventListenerInstanceWithDateValue in interface CmmnManagementService

Parameters:

eventListenerInstanceId - id of the timer event listener instance to reschedule, cannot be null.

timeDateValue - A fixed date in ISO 8601 format, when job will be fired

createJobQuery

public JobQuery createJobQuery()

Description copied from interface: CmmnManagementService

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

Specified by:

createJobQuery in interface CmmnManagementService

createExternalWorkerJobQuery

public ExternalWorkerJobQuery createExternalWorkerJobQuery()

Description copied from interface: CmmnManagementService

Returns a new ExternalWorkerJobQuery implementation, that can be used to dynamically query the external worker jobs.

Specified by:

createExternalWorkerJobQuery in interface CmmnManagementService

createTimerJobQuery

public TimerJobQuery createTimerJobQuery()

Description copied from interface: CmmnManagementService

Returns a new TimerJobQuery implementation, that can be used to query the timer jobs.

Specified by:

createTimerJobQuery in interface CmmnManagementService

createSuspendedJobQuery

public SuspendedJobQuery createSuspendedJobQuery()

Description copied from interface: CmmnManagementService

Returns a new SuspendedJobQuery implementation, that can be used to query the suspended jobs.

Specified by:

createSuspendedJobQuery in interface CmmnManagementService

createDeadLetterJobQuery

public DeadLetterJobQuery createDeadLetterJobQuery()

Description copied from interface: CmmnManagementService

Returns a new DeadLetterJobQuery implementation, that can be used to query the dead letter jobs.

Specified by:

createDeadLetterJobQuery in interface CmmnManagementService

getJobExceptionStacktrace

public String getJobExceptionStacktrace(String jobId)

Description copied from interface: CmmnManagementService

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 CmmnManagementService

Parameters:

jobId - id of the job, cannot be null.

getTimerJobExceptionStacktrace

public String getTimerJobExceptionStacktrace(String jobId)

Description copied from interface: CmmnManagementService

Returns the full stacktrace of the exception that occurs when the timer job with the given id was last executed. Returns null when the job has no exception stacktrace.

Specified by:

getTimerJobExceptionStacktrace in interface CmmnManagementService

Parameters:

jobId - id of the job, cannot be null.

getSuspendedJobExceptionStacktrace

public String getSuspendedJobExceptionStacktrace(String jobId)

Description copied from interface: CmmnManagementService

Returns the full stacktrace of the exception that occurs when the suspended with the given id was last executed. Returns null when the job has no exception stacktrace.

Specified by:

getSuspendedJobExceptionStacktrace in interface CmmnManagementService

Parameters:

jobId - id of the job, cannot be null.

getDeadLetterJobExceptionStacktrace

public String getDeadLetterJobExceptionStacktrace(String jobId)

Description copied from interface: CmmnManagementService

Returns the full stacktrace of the exception that occurs when the deadletter job with the given id was last executed. Returns null when the job has no exception stacktrace.

Specified by:

getDeadLetterJobExceptionStacktrace in interface CmmnManagementService

Parameters:

jobId - id of the job, cannot be null.

getExternalWorkerJobErrorDetails

public String getExternalWorkerJobErrorDetails(String jobId)

Description copied from interface: CmmnManagementService

Returns the full error details that were passed to the External worker Job when the job was last failed. Returns null when the job has no error details.

Specified by:

getExternalWorkerJobErrorDetails in interface CmmnManagementService

Parameters:

jobId - id of the job, cannot be null.

handleHistoryCleanupTimerJob

public void handleHistoryCleanupTimerJob()

Specified by:

handleHistoryCleanupTimerJob in interface CmmnManagementService

createBatchQuery

public BatchQuery createBatchQuery()

Description copied from interface: CmmnManagementService

Returns a new BatchQuery implementation, that can be used to dynamically query the batches.

Specified by:

createBatchQuery in interface CmmnManagementService

createBatchBuilder

public BatchBuilder createBatchBuilder()

Specified by:

createBatchBuilder in interface CmmnManagementService

createBatchPartQuery

public BatchPartQuery createBatchPartQuery()

Description copied from interface: CmmnManagementService

Returns a new BatchPartQuery implementation, that can be used to dynamically query the batch parts.

Specified by:

createBatchPartQuery in interface CmmnManagementService

createBatchPartBuilder

public BatchPartBuilder createBatchPartBuilder(Batch batch)

Specified by:

createBatchPartBuilder in interface CmmnManagementService

deleteBatch

public void deleteBatch(String batchId)

Specified by:

deleteBatch in interface CmmnManagementService

createHistoryJobQuery

public HistoryJobQuery createHistoryJobQuery()

Description copied from interface: CmmnManagementService

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

Specified by:

createHistoryJobQuery in interface CmmnManagementService

createExternalWorkerJobAcquireBuilder

public ExternalWorkerJobAcquireBuilder createExternalWorkerJobAcquireBuilder()

Description copied from interface: CmmnManagementService

Create an ExternalWorkerJobAcquireBuilder that can be used to acquire jobs for an external worker.

Specified by:

createExternalWorkerJobAcquireBuilder in interface CmmnManagementService

createExternalWorkerJobFailureBuilder

public ExternalWorkerJobFailureBuilder createExternalWorkerJobFailureBuilder(String externalJobId,
 String workerId)

Description copied from interface: CmmnManagementService

Create an ExternalWorkerJobFailureBuilder that can be used to fail an external worker job.

Specified by:

createExternalWorkerJobFailureBuilder in interface CmmnManagementService

Parameters:

externalJobId - the id of the external worker job

workerId - the id of the worker doing the action

createCmmnExternalWorkerTransitionBuilder

public CmmnExternalWorkerTransitionBuilder createCmmnExternalWorkerTransitionBuilder(String externalJobId,
 String workerId)

Description copied from interface: CmmnManagementService

Create a CmmnExternalWorkerTransitionBuilder that can be used to transition the status of the external worker job.

Specified by:

createCmmnExternalWorkerTransitionBuilder in interface CmmnManagementService

unacquireExternalWorkerJob

public void unacquireExternalWorkerJob(String jobId,
 String workerId)

Description copied from interface: CmmnManagementService

Unaquire a locked external worker job.

Specified by:

unacquireExternalWorkerJob in interface CmmnManagementService

unacquireAllExternalWorkerJobsForWorker

public void unacquireAllExternalWorkerJobsForWorker(String workerId)

Description copied from interface: CmmnManagementService

Unaquire all locked external worker jobs for worker.

Specified by:

unacquireAllExternalWorkerJobsForWorker in interface CmmnManagementService

unacquireAllExternalWorkerJobsForWorker

public void unacquireAllExternalWorkerJobsForWorker(String workerId,
 String tenantId)

Description copied from interface: CmmnManagementService

Unaquire all locked external worker jobs for worker and tenant.

Specified by:

unacquireAllExternalWorkerJobsForWorker in interface CmmnManagementService

createChangeTenantIdBuilder

public ChangeTenantIdBuilder createChangeTenantIdBuilder(String fromTenantId,
 String toTenantId)

Description copied from interface: CmmnManagementService

Create a ChangeTenantIdBuilder that can be used to change the tenant id of the case instances and all the related instances. See CmmnChangeTenantIdEntityTypes for related instances.

You must provide the source tenant id and the destination tenant id. All instances from the source tenant id in the CMMN scope will be changed to the target tenant id.

Specified by:

createChangeTenantIdBuilder in interface CmmnManagementService

executeCommand

public <T> T executeCommand(Command<T> command)

executeCommand

public <T> T executeCommand(CommandConfig config,
 Command<T> command)