Package org.camunda.bpm.engine.runtime

Interface Incident

  • All Known Implementing Classes:
    IncidentEntity
    public interface Incident
    An Incident represents a failure in the execution of a process instance.

    A possible failure could be for example a failed Job during the execution, so that the job retry is equal zero (job.retries == 0). In that case an incident will be created an the incidentType will be set to failedJobs.

    Furthermore, it is possible to create custom incidents with an individually incidentType to indicate a failure in the execution.

    Author:
    roman.smirnov

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String EXTERNAL_TASK_HANDLER_TYPE
      Handler type for incidents created on external task failure
      static java.lang.String FAILED_JOB_HANDLER_TYPE
      Handler type for incidents created on job execution failure

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getActivityId()
      Returns the id of the activity of the process instance on which this incident has happened.
      java.lang.String getAnnotation()
      Returns the annotation of this incident
      java.lang.String getCauseIncidentId()
      Returns the id of the incident on which this incident has been triggered.
      java.lang.String getConfiguration()
      Returns the payload of this incident.
      java.lang.String getExecutionId()
      Returns the specific execution on which this incident has happened.
      java.lang.String getFailedActivityId()
      Returns the id of the activity on which the last exception occurred.
      java.lang.String getHistoryConfiguration()
      Returns the history payload of this incident.
      java.lang.String getId()
      Returns the unique identifier for this incident.
      java.lang.String getIncidentMessage()
      Returns the incident message.
      java.util.Date getIncidentTimestamp()
      Time when the incident happened.
      java.lang.String getIncidentType()
      Returns the type of this incident to identify the kind of incident.
      java.lang.String getJobDefinitionId()
      Returns the id of the job definition the incident belongs to.
      java.lang.String getProcessDefinitionId()
      Returns the id of the process definition of this process instance on which the incident has happened.
      java.lang.String getProcessInstanceId()
      Returns the specific process instance on which this incident has happened.
      java.lang.String getRootCauseIncidentId()
      Returns the id of the root incident on which this transitive incident has been triggered.
      java.lang.String getTenantId()
      Returns the id of the tenant this incident belongs to.

    • Field Detail

      • FAILED_JOB_HANDLER_TYPE

        static final java.lang.String FAILED_JOB_HANDLER_TYPE
        Handler type for incidents created on job execution failure
        See Also:
        Constant Field Values

      • EXTERNAL_TASK_HANDLER_TYPE

        static final java.lang.String EXTERNAL_TASK_HANDLER_TYPE
        Handler type for incidents created on external task failure
        See Also:
        Constant Field Values

    • Method Detail

      • getId

        java.lang.String getId()
        Returns the unique identifier for this incident.

      • getIncidentTimestamp

        java.util.Date getIncidentTimestamp()
        Time when the incident happened.

      • getIncidentType

        java.lang.String getIncidentType()
        Returns the type of this incident to identify the kind of incident.

        For example: failedJobs will be returned in the case of an incident, which identify failed job during the execution of a process instance.

        See Also:
        FAILED_JOB_HANDLER_TYPE, EXTERNAL_TASK_HANDLER_TYPE

      • getIncidentMessage

        java.lang.String getIncidentMessage()
        Returns the incident message.

      • getExecutionId

        java.lang.String getExecutionId()
        Returns the specific execution on which this incident has happened.

      • getActivityId

        java.lang.String getActivityId()
        Returns the id of the activity of the process instance on which this incident has happened.

      • getFailedActivityId

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

      • getProcessInstanceId

        java.lang.String getProcessInstanceId()
        Returns the specific process instance on which this incident has happened.

      • getProcessDefinitionId

        java.lang.String getProcessDefinitionId()
        Returns the id of the process definition of this process instance on which the incident has happened.

      • getCauseIncidentId

        java.lang.String getCauseIncidentId()
        Returns the id of the incident on which this incident has been triggered.

      • getRootCauseIncidentId

        java.lang.String getRootCauseIncidentId()
        Returns the id of the root incident on which this transitive incident has been triggered.

      • getConfiguration

        java.lang.String getConfiguration()
        Returns the payload of this incident.

      • getTenantId

        java.lang.String getTenantId()
        Returns the id of the tenant this incident belongs to. Can be null if the incident belongs to no single tenant.

      • getJobDefinitionId

        java.lang.String getJobDefinitionId()
        Returns the id of the job definition the incident belongs to. Can be null if the incident belongs to no job definition.

      • getHistoryConfiguration

        java.lang.String getHistoryConfiguration()
        Returns the history payload of this incident.

      • getAnnotation

        java.lang.String getAnnotation()
        Returns the annotation of this incident