ManagementServiceImpl (Flowable

java.lang.Object
- org.flowable.common.engine.impl.service.CommonServiceImpl<C>
- - org.flowable.common.engine.impl.service.CommonEngineServiceImpl<ProcessEngineConfigurationImpl>
  - - org.flowable.engine.impl.ManagementServiceImpl

All Implemented Interfaces:: ManagementService

public class ManagementServiceImpl
extends CommonEngineServiceImpl<ProcessEngineConfigurationImpl>
implements ManagementService

Author:: Tom Baeyens, Joram Barrez, Falko Menge, Saeid Mizaei

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 and Description

ManagementServiceImpl()

Constructors
Constructor and Description
`ManagementServiceImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.flowable.job.api.DeadLetterJobQuery`	`createDeadLetterJobQuery()` Returns a new DeadLetterJobQuery implementation, that can be used to dynamically query the dead letter 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`	`deleteDeadLetterJob(String jobId)` Delete the dead letter job with the provided id.
`void`	`deleteEventLogEntry(long logNr)` Delete a EventLogEntry.
`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> 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.
`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`	`getJobExceptionStacktrace(String jobId)` Returns the full stacktrace of the exception that occurs when the job with the given id was last executed.
`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`	`getTimerJobExceptionStacktrace(String jobId)` Returns the full stacktrace of the exception that occurs when the `TimerJobEntity` with the given id was last executed.
`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.Job`	`moveJobToDeadLetterJob(String jobId)` Moves a job to the dead letter job table (eg.
`org.flowable.job.api.Job`	`moveSuspendedJobToExecutableJob(String jobId)` Moves a suspendend 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

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 Detail
  - ManagementServiceImpl
```
public ManagementServiceImpl()
```
- 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 interface ManagementService
  - 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 interface ManagementService
  - getTableMetaData
```
public 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 interface ManagementService
  - 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 interface ManagementService
    
    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 interface ManagementService
    
    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 interface ManagementService
    
    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 interface ManagementService
    
    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 interface ManagementService
    
    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 org.flowable.job.api.Job moveSuspendedJobToExecutableJob(String jobId)
```
    Description copied from interface: ManagementService
    
    Moves a suspendend job from the suspended letter job table back to be an executable job. The retries are untouched.
    
    Specified by:
    
    moveSuspendedJobToExecutableJob in interface ManagementService
    
    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 interface ManagementService
    
    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 interface ManagementService
    
    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 interface ManagementService
    
    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 interface ManagementService
    
    Parameters:
    
    jobId - id of the dead letter 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 interface ManagementService
    
    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 interface ManagementService
    
    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 interface ManagementService
    
    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 interface ManagementService
    
    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 interface ManagementService
    
    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 interface ManagementService
    
    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 interface ManagementService
    
    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
    
    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.
    
    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 TablePageQuery createTablePageQuery()
```
    Description copied from interface: ManagementService
    
    Creates a TablePageQuery that can be used to fetch TablePage containing specific sections of table row data.
    
    Specified by:
    
    createTablePageQuery in interface ManagementService
  - 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 interface ManagementService
  - 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 interface ManagementService
  - 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 interface ManagementService
  - 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 interface ManagementService
  - 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 interface ManagementService
  - 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 interface ManagementService
    
    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 the TimerJobEntity with the given id was last executed. Returns null when the job has no exception stacktrace.
    
    Specified by:
    
    getTimerJobExceptionStacktrace in interface ManagementService
    
    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 the SuspendedJobEntity with the given id was last executed. Returns null when the job has no exception stacktrace.
    
    Specified by:
    
    getSuspendedJobExceptionStacktrace in interface ManagementService
    
    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 the DeadLetterJobEntity with the given id was last executed. Returns null when the job has no exception stacktrace.
    
    Specified by:
    
    getDeadLetterJobExceptionStacktrace in interface ManagementService
    
    Parameters:
    
    jobId - id of the job, cannot be null.
  - getProperties
```
public Map<String,String> getProperties()
```
    Description copied from interface: ManagementService
    
    get the list of properties.
    
    Specified by:
    
    getProperties in interface ManagementService
  - 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 interface ManagementService
  - executeCommand
```
public <T> T executeCommand(Command<T> command)
```
    Description copied from interface: ManagementService
    
    Executes a given command with the default CommandConfig.
    
    Specified by:
    
    executeCommand in interface ManagementService
    
    Parameters:
    
    command - the command, cannot be null.
    
    Returns:
    
    the result of command execution
  - executeCommand
```
public <T> T executeCommand(CommandConfig config,
                            Command<T> command)
```
    Description copied from interface: ManagementService
    
    Executes a given command with the specified CommandConfig.
    
    Specified by:
    
    executeCommand in interface ManagementService
    
    Parameters:
    
    config - the command execution configuration, cannot be null.
    
    command - the command, cannot be null.
    
    Returns:
    
    the result of command execution
  - executeCustomSql
```
public <MapperType,ResultType> ResultType executeCustomSql(CustomSqlExecution<MapperType,ResultType> customSqlExecution)
```
    Description copied from interface: ManagementService
    
    Executes the sql contained in the CustomSqlExecution parameter.
    
    Specified by:
    
    executeCustomSql in interface ManagementService
  - 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 interface ManagementService
  - 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 interface ManagementService
  - 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 interface ManagementService

Class ManagementServiceImpl

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

ManagementServiceImpl

Method Detail

getTableCount

getTableName

getTableMetaData

executeJob

executeHistoryJob

moveTimerToExecutableJob

moveJobToDeadLetterJob

moveDeadLetterJobToExecutableJob

moveSuspendedJobToExecutableJob

deleteJob

deleteTimerJob

deleteSuspendedJob

deleteDeadLetterJob

deleteHistoryJob

setJobRetries

setTimerJobRetries

rescheduleTimeDateJob

rescheduleTimeDurationJob

rescheduleTimeCycleJob

rescheduleTimerJob

createTablePageQuery

createJobQuery

createTimerJobQuery

createSuspendedJobQuery

createDeadLetterJobQuery

createHistoryJobQuery

getJobExceptionStacktrace

getTimerJobExceptionStacktrace

getSuspendedJobExceptionStacktrace

getDeadLetterJobExceptionStacktrace

getProperties

databaseSchemaUpgrade

executeCommand

executeCommand

executeCustomSql

getEventLogEntries

getEventLogEntriesByProcessInstanceId

deleteEventLogEntry