Package org.flowable.engine.impl
Class ManagementServiceImpl
- java.lang.Object
-
- org.flowable.common.engine.impl.service.CommonServiceImpl<C>
-
- org.flowable.common.engine.impl.service.CommonEngineServiceImpl<org.flowable.engine.impl.cfg.ProcessEngineConfigurationImpl>
-
- org.flowable.engine.impl.ManagementServiceImpl
-
- All Implemented Interfaces:
ManagementService
public class ManagementServiceImpl extends org.flowable.common.engine.impl.service.CommonEngineServiceImpl<org.flowable.engine.impl.cfg.ProcessEngineConfigurationImpl> implements ManagementService
- Author:
- Tom Baeyens, Joram Barrez, Falko Menge, Saeid Mizaei
-
-
Constructor Summary
Constructors Constructor Description ManagementServiceImpl(org.flowable.engine.impl.cfg.ProcessEngineConfigurationImpl processEngineConfiguration)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
bulkMoveDeadLetterJobs(Collection<String> jobIds, 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).void
bulkMoveDeadLetterJobsToHistoryJobs(Collection<String> jobIds, 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).org.flowable.batch.api.BatchBuilder
createBatchBuilder()
org.flowable.batch.api.BatchPartBuilder
createBatchPartBuilder(org.flowable.batch.api.Batch batch)
org.flowable.batch.api.BatchPartQuery
createBatchPartQuery()
Returns a new BatchPartQuery implementation, that can be used to dynamically query the batch parts.org.flowable.batch.api.BatchQuery
createBatchQuery()
Returns a new BatchQuery implementation, that can be used to dynamically query the batches.org.flowable.common.engine.api.tenant.ChangeTenantIdBuilder
createChangeTenantIdBuilder(String fromTenantId, String toTenantId)
Create aChangeTenantIdBuilder
that can be used to change the tenant id of the process instances and all the related instances.org.flowable.job.api.DeadLetterJobQuery
createDeadLetterJobQuery()
Returns a new DeadLetterJobQuery implementation, that can be used to dynamically query the dead letter jobs.ExternalWorkerCompletionBuilder
createExternalWorkerCompletionBuilder(String externalJobId, String workerId)
Create anExternalWorkerCompletionBuilder
that can be used to transition the status of the external worker job.org.flowable.job.api.ExternalWorkerJobAcquireBuilder
createExternalWorkerJobAcquireBuilder()
Create anExternalWorkerJobAcquireBuilder
that can be used to acquire jobs for an external worker.org.flowable.job.api.ExternalWorkerJobFailureBuilder
createExternalWorkerJobFailureBuilder(String externalJobId, String workerId)
Create anExternalWorkerJobFailureBuilder
that can be used to fail an external worker job.org.flowable.job.api.ExternalWorkerJobQuery
createExternalWorkerJobQuery()
Returns a new ExternalWorkerJobQuery implementation, that can be used to dynamically query the external worker jobs.org.flowable.job.api.HistoryJobQuery
createHistoryJobQuery()
Returns a new HistoryJobQuery implementation, that can be used to dynamically query the history jobs.org.flowable.job.api.JobQuery
createJobQuery()
Returns a new JobQuery implementation, that can be used to dynamically query the jobs.org.flowable.job.api.SuspendedJobQuery
createSuspendedJobQuery()
Returns a new SuspendedJobQuery implementation, that can be used to dynamically query the suspended jobs.org.flowable.common.engine.api.management.TablePageQuery
createTablePageQuery()
Creates aTablePageQuery
that can be used to fetchTablePage
containing specific sections of table row data.org.flowable.job.api.TimerJobQuery
createTimerJobQuery()
Returns a new TimerJobQuery implementation, that can be used to dynamically query the timer jobs.String
databaseSchemaUpgrade(Connection connection, String catalog, String schema)
programmatic schema update on a given connection returning feedback about what happenedvoid
deleteBatch(String batchId)
void
deleteDeadLetterJob(String jobId)
Delete the dead letter job with the provided id.void
deleteEventLogEntry(long logNr)
Delete a EventLogEntry.void
deleteExternalWorkerJob(String jobId)
Delete the external worker 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(org.flowable.common.engine.impl.interceptor.Command<T> command)
Executes a given command with the defaultCommandConfig
.<T> T
executeCommand(org.flowable.common.engine.impl.interceptor.CommandConfig config, org.flowable.common.engine.impl.interceptor.Command<T> command)
Executes a given command with the specifiedCommandConfig
.<MapperType,ResultType>
ResultTypeexecuteCustomSql(org.flowable.common.engine.impl.cmd.CustomSqlExecution<MapperType,ResultType> customSqlExecution)
Executes the sql contained in theCustomSqlExecution
parameter.void
executeHistoryJob(String historyJobId)
Forced synchronous execution of a history job (eg.void
executeJob(String jobId)
Forced synchronous execution of a job (eg.List<org.flowable.batch.api.Batch>
findBatchesBySearchKey(String searchKey)
List<org.flowable.batch.api.BatchPart>
findBatchPartsByBatchId(String batchId)
List<org.flowable.batch.api.BatchPart>
findBatchPartsByBatchIdAndStatus(String batchId, String status)
org.flowable.job.api.Job
findJobByCorrelationId(String jobCorrelationId)
Find a job by a correlation id.List<org.flowable.batch.api.Batch>
getAllBatches()
String
getBatchDocument(String batchId)
org.flowable.batch.api.BatchPart
getBatchPart(String batchPartId)
String
getBatchPartDocument(String batchPartId)
String
getDeadLetterJobExceptionStacktrace(String jobId)
Returns the full stacktrace of the exception that occurs when theDeadLetterJobEntity
with the given id was last executed.List<EventLogEntry>
getEventLogEntries(Long startLogNr, Long pageSize)
Returns a list of event log entries, describing everything the engine has processed.List<EventLogEntry>
getEventLogEntriesByProcessInstanceId(String processInstanceId)
Returns a list of event log entries for a specific process instance id.String
getExternalWorkerJobErrorDetails(String jobId)
Returns the full error details that were passed to theExternalWorkerJobEntity
when the job was last failed.String
getHistoryJobHistoryJson(String historyJobId)
Get the advanced configuration (storing the history json data) of aHistoryJob
.String
getJobExceptionStacktrace(String jobId)
Returns the full stacktrace of the exception that occurs when the job with the given id was last executed.org.flowable.common.engine.impl.lock.LockManager
getLockManager(String lockName)
Acquire a lock manager for the requested lock.Map<String,String>
getProperties()
get the list of properties.String
getSuspendedJobExceptionStacktrace(String jobId)
Returns the full stacktrace of the exception that occurs when theSuspendedJobEntity
with the given id was last executed.Map<String,Long>
getTableCount()
Get the mapping containing {table name, row count} entries of the database schema.org.flowable.common.engine.api.management.TableMetaData
getTableMetaData(String tableName)
Gets the metadata (column names, column types, etc.) of a certain table.String
getTableName(Class<?> entityClass)
Gets the table name (including any configured prefix) for an entity like Task, Execution or the like.String
getTableName(Class<?> entityClass, boolean includePrefix)
Gets the table name for an entity like Task, Execution or the like.String
getTimerJobExceptionStacktrace(String jobId)
Returns the full stacktrace of the exception that occurs when theTimerJobEntity
with the given id was last executed.void
handleHistoryCleanupTimerJob()
org.flowable.job.api.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 was 0 when it was put into the dead letter job table).org.flowable.job.api.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).org.flowable.job.api.Job
moveJobToDeadLetterJob(String jobId)
Moves a job to the dead letter job table (eg.org.flowable.job.api.Job
moveSuspendedJobToExecutableJob(String jobId)
Moves a suspended job from the suspended letter job table back to be an executable job.org.flowable.job.api.Job
moveTimerToExecutableJob(String jobId)
Moves a timer job to the executable job table (eg.org.flowable.job.api.Job
rescheduleTimeCycleJob(String jobId, String timeCycle)
Reschedule a timer job with a time cycle.org.flowable.job.api.Job
rescheduleTimeDateJob(String jobId, String timeDate)
Reschedule a timer job with a time date.org.flowable.job.api.Job
rescheduleTimeDurationJob(String jobId, String timeDuration)
Reschedule a timer job with a time duration.org.flowable.job.api.Job
rescheduleTimerJob(String jobId, String timeDate, String timeDuration, String timeCycle, String endDate, String calendarName)
Reschedule a timer job.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.-
Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl
getCommandExecutor, setCommandExecutor
-
-
-
-
Method Detail
-
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 interfaceManagementService
-
getTableName
public String getTableName(Class<?> entityClass)
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 interfaceManagementService
-
getTableName
public String getTableName(Class<?> entityClass, boolean includePrefix)
Description copied from interface:ManagementService
Gets the table name for an entity like Task, Execution or the like.- Specified by:
getTableName
in interfaceManagementService
-
getTableMetaData
public org.flowable.common.engine.api.management.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 interfaceManagementService
-
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 interfaceManagementService
- Parameters:
jobId
- id of the job to execute, cannot be null.
-
executeHistoryJob
public void executeHistoryJob(String historyJobId)
Description copied from interface:ManagementService
Forced synchronous execution of a history job (eg. for administration or testing).- Specified by:
executeHistoryJob
in interfaceManagementService
- Parameters:
historyJobId
- id of the history job to execute, cannot be null.
-
getHistoryJobHistoryJson
public String getHistoryJobHistoryJson(String historyJobId)
Description copied from interface:ManagementService
Get the advanced configuration (storing the history json data) of aHistoryJob
.- Specified by:
getHistoryJobHistoryJson
in interfaceManagementService
- Parameters:
historyJobId
- id of the history job to execute, cannot be null.
-
moveTimerToExecutableJob
public org.flowable.job.api.Job moveTimerToExecutableJob(String jobId)
Description copied from interface:ManagementService
Moves a timer job to the executable job table (eg. for administration or testing). The timer job will be moved, even if the process definition and/or the process instance is in suspended state.- Specified by:
moveTimerToExecutableJob
in interfaceManagementService
- Parameters:
jobId
- id of the timer job to move, cannot be null.
-
moveJobToDeadLetterJob
public org.flowable.job.api.Job moveJobToDeadLetterJob(String jobId)
Description copied from interface:ManagementService
Moves a job to the dead letter job table (eg. for administration or testing). The job will be moved, even if the process definition and/or the process instance has retries left.- Specified by:
moveJobToDeadLetterJob
in interfaceManagementService
- Parameters:
jobId
- id of the job to move, cannot be null.
-
moveDeadLetterJobToExecutableJob
public org.flowable.job.api.Job moveDeadLetterJobToExecutableJob(String jobId, int retries)
Description copied from interface:ManagementService
Moves a job that is in the dead letter job table back to be an executable job, and resetting the retries (as the retries was 0 when it was put into the dead letter job table).- Specified by:
moveDeadLetterJobToExecutableJob
in interfaceManagementService
- 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.
-
moveDeadLetterJobToHistoryJob
public org.flowable.job.api.HistoryJob moveDeadLetterJobToHistoryJob(String jobId, int retries)
Description copied from interface:ManagementService
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 interfaceManagementService
- 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:ManagementService
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:
bulkMoveDeadLetterJobs
in interfaceManagementService
- 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:ManagementService
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:
bulkMoveDeadLetterJobsToHistoryJobs
in interfaceManagementService
- 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.
-
moveSuspendedJobToExecutableJob
public org.flowable.job.api.Job moveSuspendedJobToExecutableJob(String jobId)
Description copied from interface:ManagementService
Moves a suspended job from the suspended letter job table back to be an executable job. The retries are untouched.- Specified by:
moveSuspendedJobToExecutableJob
in interfaceManagementService
- Parameters:
jobId
- id of the job to move, 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 interfaceManagementService
- Parameters:
jobId
- id of the job to delete, cannot be null.
-
deleteTimerJob
public void deleteTimerJob(String jobId)
Description copied from interface:ManagementService
Delete the timer job with the provided id.- Specified by:
deleteTimerJob
in interfaceManagementService
- Parameters:
jobId
- id of the timer job to delete, cannot be null.
-
deleteSuspendedJob
public void deleteSuspendedJob(String jobId)
Description copied from interface:ManagementService
Delete the suspended job with the provided id.- Specified by:
deleteSuspendedJob
in interfaceManagementService
- Parameters:
jobId
- id of the suspended job to delete, cannot be null.
-
deleteDeadLetterJob
public void deleteDeadLetterJob(String jobId)
Description copied from interface:ManagementService
Delete the dead letter job with the provided id.- Specified by:
deleteDeadLetterJob
in interfaceManagementService
- Parameters:
jobId
- id of the dead letter job to delete, cannot be null.
-
deleteExternalWorkerJob
public void deleteExternalWorkerJob(String jobId)
Description copied from interface:ManagementService
Delete the external worker job with the provided id.- Specified by:
deleteExternalWorkerJob
in interfaceManagementService
- Parameters:
jobId
- id of the external worker job to delete, cannot be null.
-
deleteHistoryJob
public void deleteHistoryJob(String jobId)
Description copied from interface:ManagementService
Delete the history job with the provided id.- Specified by:
deleteHistoryJob
in interfaceManagementService
- Parameters:
jobId
- id of the history job to delete, 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 interfaceManagementService
- 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:ManagementService
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 interfaceManagementService
- Parameters:
jobId
- id of the timer job to modify, cannot be null.retries
- number of retries.
-
rescheduleTimeDateJob
public org.flowable.job.api.Job rescheduleTimeDateJob(String jobId, String timeDate)
Description copied from interface:ManagementService
Reschedule a timer job with a time date.- Specified by:
rescheduleTimeDateJob
in interfaceManagementService
- Parameters:
jobId
- id of the timer job to reschedule, cannot be null.timeDate
- A fixed date in ISO 8601 format, when job will be fired
-
rescheduleTimeDurationJob
public org.flowable.job.api.Job rescheduleTimeDurationJob(String jobId, String timeDuration)
Description copied from interface:ManagementService
Reschedule a timer job with a time duration.- Specified by:
rescheduleTimeDurationJob
in interfaceManagementService
- Parameters:
jobId
- id of the timer job to reschedule, cannot be null.timeDuration
- How long the timer should run before it is fired in ISO 8601 format. For example, PT10D means the timer will run for 10 days before it fires.
-
rescheduleTimeCycleJob
public org.flowable.job.api.Job rescheduleTimeCycleJob(String jobId, String timeCycle)
Description copied from interface:ManagementService
Reschedule a timer job with a time cycle.- Specified by:
rescheduleTimeCycleJob
in interfaceManagementService
- Parameters:
jobId
- id of the timer job to reschedule, cannot be null.timeCycle
- Specifies a repeating interval at which the timer will fire in ISO 8601 format. For example R3/PT10H means the timer will fire three timers in intervals of 10 hours.
-
rescheduleTimerJob
public org.flowable.job.api.Job rescheduleTimerJob(String jobId, String timeDate, String timeDuration, String timeCycle, String endDate, String calendarName)
Description copied from interface:ManagementService
Reschedule a timer job.- Specified by:
rescheduleTimerJob
in interfaceManagementService
- Parameters:
jobId
- id of the timer job to reschedule, cannot be null.timeDate
- A fixed date in ISO 8601 format, when job will be firedtimeDuration
- How long the timer should run before it is fired in ISO 8601 format. For example, PT10D means the timer will run for 10 days before it fires.timeCycle
- Specifies a repeating interval at which the timer will fire in ISO 8601 format. For example R3/PT10H means the timer will fire three timers in intervals of 10 hours.endDate
- The date at which the application will stop creating additional jobs. The value should be provided in ISO8601 format. For example "2015-02-25T16:42:11+00:00".calendarName
- The name of a business calendar defined in the process engine configuration. If null the default business calendars is used.
-
createTablePageQuery
public org.flowable.common.engine.api.management.TablePageQuery createTablePageQuery()
Description copied from interface:ManagementService
Creates aTablePageQuery
that can be used to fetchTablePage
containing specific sections of table row data.- Specified by:
createTablePageQuery
in interfaceManagementService
-
createJobQuery
public org.flowable.job.api.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 interfaceManagementService
-
createExternalWorkerJobQuery
public org.flowable.job.api.ExternalWorkerJobQuery createExternalWorkerJobQuery()
Description copied from interface:ManagementService
Returns a new ExternalWorkerJobQuery implementation, that can be used to dynamically query the external worker jobs.- Specified by:
createExternalWorkerJobQuery
in interfaceManagementService
-
createTimerJobQuery
public org.flowable.job.api.TimerJobQuery createTimerJobQuery()
Description copied from interface:ManagementService
Returns a new TimerJobQuery implementation, that can be used to dynamically query the timer jobs.- Specified by:
createTimerJobQuery
in interfaceManagementService
-
createSuspendedJobQuery
public org.flowable.job.api.SuspendedJobQuery createSuspendedJobQuery()
Description copied from interface:ManagementService
Returns a new SuspendedJobQuery implementation, that can be used to dynamically query the suspended jobs.- Specified by:
createSuspendedJobQuery
in interfaceManagementService
-
createDeadLetterJobQuery
public org.flowable.job.api.DeadLetterJobQuery createDeadLetterJobQuery()
Description copied from interface:ManagementService
Returns a new DeadLetterJobQuery implementation, that can be used to dynamically query the dead letter jobs.- Specified by:
createDeadLetterJobQuery
in interfaceManagementService
-
createHistoryJobQuery
public org.flowable.job.api.HistoryJobQuery createHistoryJobQuery()
Description copied from interface:ManagementService
Returns a new HistoryJobQuery implementation, that can be used to dynamically query the history jobs.- Specified by:
createHistoryJobQuery
in interfaceManagementService
-
findJobByCorrelationId
public org.flowable.job.api.Job findJobByCorrelationId(String jobCorrelationId)
Description copied from interface:ManagementService
Find a job by a correlation id.- Specified by:
findJobByCorrelationId
in interfaceManagementService
-
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 interfaceManagementService
- Parameters:
jobId
- id of the job, cannot be null.
-
getTimerJobExceptionStacktrace
public String getTimerJobExceptionStacktrace(String jobId)
Description copied from interface:ManagementService
Returns the full stacktrace of the exception that occurs when theTimerJobEntity
with the given id was last executed. Returns null when the job has no exception stacktrace.- Specified by:
getTimerJobExceptionStacktrace
in interfaceManagementService
- Parameters:
jobId
- id of the job, cannot be null.
-
getSuspendedJobExceptionStacktrace
public String getSuspendedJobExceptionStacktrace(String jobId)
Description copied from interface:ManagementService
Returns the full stacktrace of the exception that occurs when theSuspendedJobEntity
with the given id was last executed. Returns null when the job has no exception stacktrace.- Specified by:
getSuspendedJobExceptionStacktrace
in interfaceManagementService
- Parameters:
jobId
- id of the job, cannot be null.
-
getDeadLetterJobExceptionStacktrace
public String getDeadLetterJobExceptionStacktrace(String jobId)
Description copied from interface:ManagementService
Returns the full stacktrace of the exception that occurs when theDeadLetterJobEntity
with the given id was last executed. Returns null when the job has no exception stacktrace.- Specified by:
getDeadLetterJobExceptionStacktrace
in interfaceManagementService
- Parameters:
jobId
- id of the job, cannot be null.
-
getExternalWorkerJobErrorDetails
public String getExternalWorkerJobErrorDetails(String jobId)
Description copied from interface:ManagementService
Returns the full error details that were passed to theExternalWorkerJobEntity
when the job was last failed. Returns null when the job has no error details.- Specified by:
getExternalWorkerJobErrorDetails
in interfaceManagementService
- Parameters:
jobId
- id of the job, cannot be null.
-
handleHistoryCleanupTimerJob
public void handleHistoryCleanupTimerJob()
- Specified by:
handleHistoryCleanupTimerJob
in interfaceManagementService
-
getAllBatches
public List<org.flowable.batch.api.Batch> getAllBatches()
- Specified by:
getAllBatches
in interfaceManagementService
-
findBatchesBySearchKey
public List<org.flowable.batch.api.Batch> findBatchesBySearchKey(String searchKey)
- Specified by:
findBatchesBySearchKey
in interfaceManagementService
-
getBatchDocument
public String getBatchDocument(String batchId)
- Specified by:
getBatchDocument
in interfaceManagementService
-
getBatchPart
public org.flowable.batch.api.BatchPart getBatchPart(String batchPartId)
- Specified by:
getBatchPart
in interfaceManagementService
-
findBatchPartsByBatchId
public List<org.flowable.batch.api.BatchPart> findBatchPartsByBatchId(String batchId)
- Specified by:
findBatchPartsByBatchId
in interfaceManagementService
-
findBatchPartsByBatchIdAndStatus
public List<org.flowable.batch.api.BatchPart> findBatchPartsByBatchIdAndStatus(String batchId, String status)
- Specified by:
findBatchPartsByBatchIdAndStatus
in interfaceManagementService
-
getBatchPartDocument
public String getBatchPartDocument(String batchPartId)
- Specified by:
getBatchPartDocument
in interfaceManagementService
-
createBatchQuery
public org.flowable.batch.api.BatchQuery createBatchQuery()
Description copied from interface:ManagementService
Returns a new BatchQuery implementation, that can be used to dynamically query the batches.- Specified by:
createBatchQuery
in interfaceManagementService
-
createBatchBuilder
public org.flowable.batch.api.BatchBuilder createBatchBuilder()
- Specified by:
createBatchBuilder
in interfaceManagementService
-
createBatchPartQuery
public org.flowable.batch.api.BatchPartQuery createBatchPartQuery()
Description copied from interface:ManagementService
Returns a new BatchPartQuery implementation, that can be used to dynamically query the batch parts.- Specified by:
createBatchPartQuery
in interfaceManagementService
-
createBatchPartBuilder
public org.flowable.batch.api.BatchPartBuilder createBatchPartBuilder(org.flowable.batch.api.Batch batch)
- Specified by:
createBatchPartBuilder
in interfaceManagementService
-
deleteBatch
public void deleteBatch(String batchId)
- Specified by:
deleteBatch
in interfaceManagementService
-
getProperties
public Map<String,String> getProperties()
Description copied from interface:ManagementService
get the list of properties.- Specified by:
getProperties
in interfaceManagementService
-
databaseSchemaUpgrade
public String databaseSchemaUpgrade(Connection connection, String catalog, String schema)
Description copied from interface:ManagementService
programmatic schema update on a given connection returning feedback about what happened- Specified by:
databaseSchemaUpgrade
in interfaceManagementService
-
executeCommand
public <T> T executeCommand(org.flowable.common.engine.impl.interceptor.Command<T> command)
Description copied from interface:ManagementService
Executes a given command with the defaultCommandConfig
.- Specified by:
executeCommand
in interfaceManagementService
- Parameters:
command
- the command, cannot be null.- Returns:
- the result of command execution
-
executeCommand
public <T> T executeCommand(org.flowable.common.engine.impl.interceptor.CommandConfig config, org.flowable.common.engine.impl.interceptor.Command<T> command)
Description copied from interface:ManagementService
Executes a given command with the specifiedCommandConfig
.- Specified by:
executeCommand
in interfaceManagementService
- Parameters:
config
- the command execution configuration, cannot be null.command
- the command, cannot be null.- Returns:
- the result of command execution
-
getLockManager
public org.flowable.common.engine.impl.lock.LockManager getLockManager(String lockName)
Description copied from interface:ManagementService
Acquire a lock manager for the requested lock. This is a stateless call, this means that every time a lock manager is requested a new one would be created. Make sure that you release the lock once you are done.- Specified by:
getLockManager
in interfaceManagementService
- Parameters:
lockName
- the name of the lock that is being requested- Returns:
- the lock manager for the given lock
-
executeCustomSql
public <MapperType,ResultType> ResultType executeCustomSql(org.flowable.common.engine.impl.cmd.CustomSqlExecution<MapperType,ResultType> customSqlExecution)
Description copied from interface:ManagementService
Executes the sql contained in theCustomSqlExecution
parameter.- Specified by:
executeCustomSql
in interfaceManagementService
-
getEventLogEntries
public List<EventLogEntry> getEventLogEntries(Long startLogNr, Long pageSize)
Description copied from interface:ManagementService
Returns a list of event log entries, describing everything the engine has processed. Note that the event logging must specifically must be enabled in the process engine configuration. Passing null as arguments will effectively fetch ALL event log entries. Be careful, as this list might be huge!- Specified by:
getEventLogEntries
in interfaceManagementService
-
getEventLogEntriesByProcessInstanceId
public List<EventLogEntry> getEventLogEntriesByProcessInstanceId(String processInstanceId)
Description copied from interface:ManagementService
Returns a list of event log entries for a specific process instance id. Note that the event logging must specifically must be enabled in the process engine configuration. Passing null as arguments will effectively fetch ALL event log entries. Be careful, as this list might be huge!- Specified by:
getEventLogEntriesByProcessInstanceId
in interfaceManagementService
-
deleteEventLogEntry
public void deleteEventLogEntry(long logNr)
Description copied from interface:ManagementService
Delete a EventLogEntry. Typically only used in testing, as deleting log entries defeats the whole purpose of keeping a log.- Specified by:
deleteEventLogEntry
in interfaceManagementService
-
createExternalWorkerJobAcquireBuilder
public org.flowable.job.api.ExternalWorkerJobAcquireBuilder createExternalWorkerJobAcquireBuilder()
Description copied from interface:ManagementService
Create anExternalWorkerJobAcquireBuilder
that can be used to acquire jobs for an external worker.- Specified by:
createExternalWorkerJobAcquireBuilder
in interfaceManagementService
-
createExternalWorkerJobFailureBuilder
public org.flowable.job.api.ExternalWorkerJobFailureBuilder createExternalWorkerJobFailureBuilder(String externalJobId, String workerId)
Description copied from interface:ManagementService
Create anExternalWorkerJobFailureBuilder
that can be used to fail an external worker job.- Specified by:
createExternalWorkerJobFailureBuilder
in interfaceManagementService
- Parameters:
externalJobId
- the id of the external worker jobworkerId
- the id of the worker doing the action
-
createExternalWorkerCompletionBuilder
public ExternalWorkerCompletionBuilder createExternalWorkerCompletionBuilder(String externalJobId, String workerId)
Description copied from interface:ManagementService
Create anExternalWorkerCompletionBuilder
that can be used to transition the status of the external worker job.- Specified by:
createExternalWorkerCompletionBuilder
in interfaceManagementService
-
createChangeTenantIdBuilder
public org.flowable.common.engine.api.tenant.ChangeTenantIdBuilder createChangeTenantIdBuilder(String fromTenantId, String toTenantId)
Description copied from interface:ManagementService
Create aChangeTenantIdBuilder
that can be used to change the tenant id of the process instances and all the related instances. SeeBpmnChangeTenantIdEntityTypes
for related instances.You must provide the source tenant id and the destination tenant id. All instances from the source tenant id in the BPMN scope will be changed to the target tenant id.
- Specified by:
createChangeTenantIdBuilder
in interfaceManagementService
-
-