public interface ManagementService
Modifier and Type | Method and Description |
---|---|
org.flowable.batch.api.BatchBuilder |
createBatchBuilder() |
org.flowable.batch.api.BatchQuery |
createBatchQuery()
Returns a new BatchQuery implementation, that can be used to dynamically query the batches.
|
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 an
ExternalWorkerCompletionBuilder that can be used to transition the status of the external worker job. |
org.flowable.job.api.ExternalWorkerJobAcquireBuilder |
createExternalWorkerJobAcquireBuilder()
Create an
ExternalWorkerJobAcquireBuilder that can be used to acquire jobs for an external worker. |
org.flowable.job.api.ExternalWorkerJobFailureBuilder |
createExternalWorkerJobFailureBuilder(String externalJobId,
String workerId)
Create an
ExternalWorkerJobFailureBuilder 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.
|
TablePageQuery |
createTablePageQuery()
Creates a
TablePageQuery that can be used to fetch TablePage 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 happened
|
void |
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(Command<T> command)
Executes a given command with the default
CommandConfig . |
<T> T |
executeCommand(CommandConfig config,
Command<T> command)
Executes a given command with the specified
CommandConfig . |
<MapperType,ResultType> |
executeCustomSql(CustomSqlExecution<MapperType,ResultType> customSqlExecution)
Executes the sql contained in the
CustomSqlExecution 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 the
DeadLetterJobEntity 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 the
ExternalWorkerJobEntity 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.
|
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 the
SuspendedJobEntity with the given id was last executed. |
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<?> 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 the
TimerJobEntity 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.
|
Map<String,Long> getTableCount()
String getTableName(Class<?> entityClass)
String getTableName(Class<?> entityClass, boolean includePrefix)
TableMetaData getTableMetaData(String tableName)
TablePageQuery createTablePageQuery()
TablePageQuery
that can be used to fetch TablePage
containing specific sections of table row data.org.flowable.job.api.JobQuery createJobQuery()
org.flowable.job.api.ExternalWorkerJobQuery createExternalWorkerJobQuery()
org.flowable.job.api.TimerJobQuery createTimerJobQuery()
org.flowable.job.api.SuspendedJobQuery createSuspendedJobQuery()
org.flowable.job.api.DeadLetterJobQuery createDeadLetterJobQuery()
org.flowable.job.api.HistoryJobQuery createHistoryJobQuery()
org.flowable.job.api.Job findJobByCorrelationId(String jobCorrelationId)
void executeJob(String jobId)
jobId
- id of the job to execute, cannot be null.FlowableObjectNotFoundException
- when there is no job with the given id.void executeHistoryJob(String historyJobId)
historyJobId
- id of the history job to execute, cannot be null.FlowableObjectNotFoundException
- when there is no historyJob with the given id.String getHistoryJobHistoryJson(String historyJobId)
HistoryJob
.historyJobId
- id of the history job to execute, cannot be null.FlowableObjectNotFoundException
- when there is no historyJob with the given id.org.flowable.job.api.Job moveTimerToExecutableJob(String jobId)
jobId
- id of the timer job to move, cannot be null.FlowableObjectNotFoundException
- when there is no job with the given id.org.flowable.job.api.Job moveJobToDeadLetterJob(String jobId)
jobId
- id of the job to move, cannot be null.FlowableObjectNotFoundException
- when there is no job with the given id.org.flowable.job.api.Job moveDeadLetterJobToExecutableJob(String jobId, int retries)
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.FlowableObjectNotFoundException
- when there is no job with the given id.FlowableIllegalArgumentException
- when the job cannot be moved to be an executable job (e.g. because it's a history job)org.flowable.job.api.HistoryJob moveDeadLetterJobToHistoryJob(String jobId, int retries)
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.FlowableObjectNotFoundException
- when there is no job with the given id.FlowableIllegalArgumentException
- when the job cannot be moved to be a history job (e.g. because it's not history job)org.flowable.job.api.Job moveSuspendedJobToExecutableJob(String jobId)
jobId
- id of the job to move, cannot be null.FlowableObjectNotFoundException
- when there is no job with the given id.void deleteJob(String jobId)
jobId
- id of the job to delete, cannot be null.FlowableObjectNotFoundException
- when there is no job with the given id.void deleteTimerJob(String jobId)
jobId
- id of the timer job to delete, cannot be null.FlowableObjectNotFoundException
- when there is no job with the given id.void deleteSuspendedJob(String jobId)
jobId
- id of the suspended job to delete, cannot be null.FlowableObjectNotFoundException
- when there is no job with the given id.void deleteDeadLetterJob(String jobId)
jobId
- id of the dead letter job to delete, cannot be null.FlowableObjectNotFoundException
- when there is no job with the given id.void deleteExternalWorkerJob(String jobId)
jobId
- id of the external worker job to delete, cannot be null.FlowableObjectNotFoundException
- when there is no job with the given id.void deleteHistoryJob(String jobId)
jobId
- id of the history job to delete, cannot be null.FlowableObjectNotFoundException
- when there is no job with the given id.void setJobRetries(String jobId, int retries)
jobId
- id of the job to modify, cannot be null.retries
- number of retries.void setTimerJobRetries(String jobId, int retries)
jobId
- id of the timer job to modify, cannot be null.retries
- number of retries.org.flowable.job.api.Job rescheduleTimeDateJob(String jobId, String timeDate)
jobId
- id of the timer job to reschedule, cannot be null.timeDate
- A fixed date in ISO 8601 format, when job will be firedorg.flowable.job.api.Job rescheduleTimeDurationJob(String jobId, String timeDuration)
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.org.flowable.job.api.Job rescheduleTimeCycleJob(String jobId, String timeCycle)
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.org.flowable.job.api.Job rescheduleTimerJob(String jobId, String timeDate, String timeDuration, String timeCycle, String endDate, String calendarName)
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.String getJobExceptionStacktrace(String jobId)
jobId
- id of the job, cannot be null.FlowableObjectNotFoundException
- when no job exists with the given id.String getTimerJobExceptionStacktrace(String jobId)
TimerJobEntity
with the given id was last executed. Returns null when the job has no exception stacktrace.jobId
- id of the job, cannot be null.FlowableObjectNotFoundException
- when no job exists with the given id.String getSuspendedJobExceptionStacktrace(String jobId)
SuspendedJobEntity
with the given id was last executed. Returns null when the job has no exception stacktrace.jobId
- id of the job, cannot be null.FlowableObjectNotFoundException
- when no job exists with the given id.String getDeadLetterJobExceptionStacktrace(String jobId)
DeadLetterJobEntity
with the given id was last executed. Returns null when the job has no exception stacktrace.jobId
- id of the job, cannot be null.FlowableObjectNotFoundException
- when no job exists with the given id.String getExternalWorkerJobErrorDetails(String jobId)
ExternalWorkerJobEntity
when the job was last failed. Returns null when the job has no error details.jobId
- id of the job, cannot be null.FlowableObjectNotFoundException
- when no job exists with the given id.void handleHistoryCleanupTimerJob()
List<org.flowable.batch.api.Batch> getAllBatches()
org.flowable.batch.api.BatchPart getBatchPart(String batchPartId)
List<org.flowable.batch.api.BatchPart> findBatchPartsByBatchId(String batchId)
List<org.flowable.batch.api.BatchPart> findBatchPartsByBatchIdAndStatus(String batchId, String status)
org.flowable.batch.api.BatchQuery createBatchQuery()
org.flowable.batch.api.BatchBuilder createBatchBuilder()
void deleteBatch(String batchId)
String databaseSchemaUpgrade(Connection connection, String catalog, String schema)
<T> T executeCommand(Command<T> command)
CommandConfig
.command
- the command, cannot be null.<T> T executeCommand(CommandConfig config, Command<T> command)
CommandConfig
.config
- the command execution configuration, cannot be null.command
- the command, cannot be null.LockManager getLockManager(String lockName)
lockName
- the name of the lock that is being requested<MapperType,ResultType> ResultType executeCustomSql(CustomSqlExecution<MapperType,ResultType> customSqlExecution)
CustomSqlExecution
parameter.List<EventLogEntry> getEventLogEntries(Long startLogNr, Long pageSize)
List<EventLogEntry> getEventLogEntriesByProcessInstanceId(String processInstanceId)
void deleteEventLogEntry(long logNr)
org.flowable.job.api.ExternalWorkerJobAcquireBuilder createExternalWorkerJobAcquireBuilder()
ExternalWorkerJobAcquireBuilder
that can be used to acquire jobs for an external worker.org.flowable.job.api.ExternalWorkerJobFailureBuilder createExternalWorkerJobFailureBuilder(String externalJobId, String workerId)
ExternalWorkerJobFailureBuilder
that can be used to fail an external worker job.externalJobId
- the id of the external worker jobworkerId
- the id of the worker doing the actionExternalWorkerCompletionBuilder createExternalWorkerCompletionBuilder(String externalJobId, String workerId)
ExternalWorkerCompletionBuilder
that can be used to transition the status of the external worker job.Copyright © 2021 Flowable. All rights reserved.