Package org.camunda.bpm.engine.history

Interface HistoricJobLog

All Known Implementing Classes:
HistoricJobLogEventEntity
public interface HistoricJobLog

The HistoricJobLog is used to have a log containing information about job execution. The log provides details about the complete lifecycle of a job:

  • job created
  • job execution failed
  • job execution successful
  • job was deleted
An instance of HistoricJobLog represents a state in the lifecycle of a job.
Since:
7.3
Author:
Roman Smirnov

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getActivityId()
    Returns the id of the activity on which the associated job was created.
    String
    getBatchId()
    Returns the ID of the batch associated with the job or null if no batch is associated with the job.
    String
    getDeploymentId()
    Returns the specific deployment id on which the associated job was created.
    String
    getExecutionId()
    Returns the specific execution id on which the associated job was created.
    String
    getFailedActivityId()
    Returns the id of the activity on which the last exception occurred.
    String
    getHostname()
    Returns the name of the host where the Process Engine that added this job log runs.
    String
    getId()
    Returns the unique identifier for this historic job log.
    String
    getJobDefinitionConfiguration()
    Returns the job definition configuration type of the associated job.
    String
    getJobDefinitionId()
    Returns the id of the job definition on which the associated job was created.
    String
    getJobDefinitionType()
    Returns the job definition type of the associated job.
    Date
    getJobDueDate()
    Returns the due date of the associated job when this log occurred.
    String
    getJobExceptionMessage()
    Returns the message of the exception that occurred by executing the associated job.
    String
    getJobId()
    Returns the id of the associated job.
    long
    getJobPriority()
    Returns the priority of the associated job when this log entry was created.
    int
    getJobRetries()
    Returns the retries of the associated job before the associated job has been executed and when this log occurred.
    String
    getProcessDefinitionId()
    Returns the specific process definition id on which the associated job was created.
    String
    getProcessDefinitionKey()
    Returns the specific process definition key on which the associated job was created.
    String
    getProcessInstanceId()
    Returns the specific process instance id on which the associated job was created.
    Date
    getRemovalTime()
    The time the historic job log will be removed.
    String
    getRootProcessInstanceId()
    Returns the specific root process instance id of the process instance on which the associated job was created.
    String
    getTenantId()
    Returns the id of the tenant this job log entry belongs to.
    Date
    getTimestamp()
    Returns the time when this log occurred.
    boolean
    isCreationLog()
    Returns true when this log represents the creation of the associated job.
    boolean
    isDeletionLog()
    Returns true when this log represents the deletion of the associated job.
    boolean
    isFailureLog()
    Returns true when this log represents the failed execution of the associated job.
    boolean
    isSuccessLog()
    Returns true when this log represents the successful execution of the associated job.

  • Method Details

    • getId

      String getId()
      Returns the unique identifier for this historic job log.

    • getTimestamp

      Date getTimestamp()
      Returns the time when this log occurred.

    • getJobId

      String getJobId()
      Returns the id of the associated job.

    • getJobDueDate

      Date getJobDueDate()
      Returns the due date of the associated job when this log occurred.

    • getJobRetries

      int getJobRetries()
      Returns the retries of the associated job before the associated job has been executed and when this log occurred.

    • getJobPriority

      long getJobPriority()
      Returns the priority of the associated job when this log entry was created.
      Since:
      7.4

    • getJobExceptionMessage

      String getJobExceptionMessage()
      Returns the message of the exception that occurred by executing the associated job. To get the full exception stacktrace, use HistoryService.getHistoricJobLogExceptionStacktrace(String)

    • getJobDefinitionId

      String getJobDefinitionId()
      Returns the id of the job definition on which the associated job was created.

    • getJobDefinitionType

      String getJobDefinitionType()
      Returns the job definition type of the associated job.

    • getJobDefinitionConfiguration

      String getJobDefinitionConfiguration()
      Returns the job definition configuration type of the associated job.

    • getActivityId

      String getActivityId()
      Returns the id of the activity on which the associated job was created.

    • getFailedActivityId

      String getFailedActivityId()
      Returns the id of the activity on which the last exception occurred.

    • getExecutionId

      String getExecutionId()
      Returns the specific execution id on which the associated job was created.

    • getRootProcessInstanceId

      String getRootProcessInstanceId()
      Returns the specific root process instance id of the process instance on which the associated job was created.

    • getProcessInstanceId

      String getProcessInstanceId()
      Returns the specific process instance id on which the associated job was created.

    • getProcessDefinitionId

      String getProcessDefinitionId()
      Returns the specific process definition id on which the associated job was created.

    • getProcessDefinitionKey

      String getProcessDefinitionKey()
      Returns the specific process definition key on which the associated job was created.

    • getDeploymentId

      String getDeploymentId()
      Returns the specific deployment id on which the associated job was created.

    • getTenantId

      String getTenantId()
      Returns the id of the tenant this job log entry belongs to. Can be null if the job log entry belongs to no single tenant.

    • getHostname

      String getHostname()
      Returns the name of the host where the Process Engine that added this job log runs.

    • isCreationLog

      boolean isCreationLog()
      Returns true when this log represents the creation of the associated job.

    • isFailureLog

      boolean isFailureLog()
      Returns true when this log represents the failed execution of the associated job.

    • isSuccessLog

      boolean isSuccessLog()
      Returns true when this log represents the successful execution of the associated job.

    • isDeletionLog

      boolean isDeletionLog()
      Returns true when this log represents the deletion of the associated job.

    • getRemovalTime

      Date getRemovalTime()
      The time the historic job log will be removed.

    • getBatchId

      String getBatchId()
      Returns the ID of the batch associated with the job or null if no batch is associated with the job.
      Returns:
      the ID of the batch associated with the job