org.camunda.bpm.engine.impl.incident
Class DefaultIncidentHandler

java.lang.Object
  org.camunda.bpm.engine.impl.incident.DefaultIncidentHandler

All Implemented Interfaces:

IncidentHandler

public class DefaultIncidentHandler
extends Object
implements IncidentHandler

An incident handler that logs incidents of a certain type as instances of Incident to the engine database.

By default, the process engine has two default handlers:

• type failedJob: Indicates jobs without retries left. This incident handler is active by default and must be disabled via ProcessEngineConfiguration.setCreateIncidentOnFailedJobEnabled(boolean).
• type failedExternalTask: Indicates external tasks without retries left

  Author:

  nico.rehwaldt, roman.smirnov, Falko Menge, Thorben Lindhauer

  See Also:

  IncidentHandler

  Field Summary

  protected String

  type

  Constructor Summary

  DefaultIncidentHandler(String type)
  

  Method Summary

  Incident	createIncident(String processDefinitionId, String activityId, String executionId, String jobId, String message)
  void	deleteIncident(String processDefinitionId, String activityId, String executionId, String configuration) Delete an incident that arose in the context of an execution.
  String	getIncidentHandlerType() Returns the incident type this handler activates for.
  void	handleIncident(String processDefinitionId, String activityId, String executionId, String jobId, String message) Handle an incident that arose in the context of an execution.
  protected void	removeIncident(String processDefinitionId, String activityId, String executionId, String configuration, boolean incidentResolved)
  void	resolveIncident(String processDefinitionId, String activityId, String executionId, String configuration) Resolve an incident that arose in the context of an execution.

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Field Detail

  type

  protected String type

  Constructor Detail

  DefaultIncidentHandler

  public DefaultIncidentHandler(String type)

  Method Detail

  getIncidentHandlerType

  public String getIncidentHandlerType()

  Description copied from interface: IncidentHandler

  Returns the incident type this handler activates for.

  Specified by:

  getIncidentHandlerType in interface IncidentHandler

  handleIncident

  public void handleIncident(String processDefinitionId,
                             String activityId,
                             String executionId,
                             String jobId,
                             String message)

  Description copied from interface: IncidentHandler

  Handle an incident that arose in the context of an execution.

  Specified by:

  handleIncident in interface IncidentHandler

  createIncident

  public Incident createIncident(String processDefinitionId,
                                 String activityId,
                                 String executionId,
                                 String jobId,
                                 String message)

  resolveIncident

  public void resolveIncident(String processDefinitionId,
                              String activityId,
                              String executionId,
                              String configuration)

  Description copied from interface: IncidentHandler

  Resolve an incident that arose in the context of an execution.

  Specified by:

  resolveIncident in interface IncidentHandler

  deleteIncident

  public void deleteIncident(String processDefinitionId,
                             String activityId,
                             String executionId,
                             String configuration)

  Description copied from interface: IncidentHandler

  Delete an incident that arose in the context of an execution.

  Specified by:

  deleteIncident in interface IncidentHandler

  removeIncident

  protected void removeIncident(String processDefinitionId,
                                String activityId,
                                String executionId,
                                String configuration,
                                boolean incidentResolved)