Package org.activiti.engine.impl

Class ManagementServiceImpl

    • Constructor Detail

      • ManagementServiceImpl

        public ManagementServiceImpl()

    • Method Detail

      • getTableCount

        public java.util.Map<java.lang.String,​java.lang.Long> getTableCount()
        Description copied from interface: ManagementService
        Get the mapping containing {table name, row count} entries of the Activiti database schema.
        Specified by:
        getTableCount in interface ManagementService

      • getTableName

        public java.lang.String getTableName​(java.lang.Class<?> activitiEntityClass)
        Description copied from interface: ManagementService
        Gets the table name (including any configured prefix) for an Activiti entity like Task, Execution or the like.
        Specified by:
        getTableName in interface ManagementService

      • getTableMetaData

        public TableMetaData getTableMetaData​(java.lang.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​(java.lang.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.

      • moveTimerToExecutableJob

        public Job moveTimerToExecutableJob​(java.lang.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 Job moveJobToDeadLetterJob​(java.lang.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 Job moveDeadLetterJobToExecutableJob​(java.lang.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.

      • deleteJob

        public void deleteJob​(java.lang.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​(java.lang.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.

      • deleteDeadLetterJob

        public void deleteDeadLetterJob​(java.lang.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.

      • setJobRetries

        public void setJobRetries​(java.lang.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​(java.lang.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.

      • getJobExceptionStacktrace

        public java.lang.String getJobExceptionStacktrace​(java.lang.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 java.lang.String getTimerJobExceptionStacktrace​(java.lang.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 java.lang.String getSuspendedJobExceptionStacktrace​(java.lang.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 java.lang.String getDeadLetterJobExceptionStacktrace​(java.lang.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 java.util.Map<java.lang.String,​java.lang.String> getProperties()
        Description copied from interface: ManagementService
        get the list of properties.
        Specified by:
        getProperties in interface ManagementService

      • databaseSchemaUpgrade

        public java.lang.String databaseSchemaUpgrade​(java.sql.Connection connection,
                                              java.lang.String catalog,
                                              java.lang.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​(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

      • getEventLogEntries

        public java.util.List<EventLogEntry> getEventLogEntries​(java.lang.Long startLogNr,
                                                        java.lang.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 java.util.List<EventLogEntry> getEventLogEntriesByProcessInstanceId​(java.lang.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