Package org.camunda.bpm.engine.impl.incident

Interface IncidentHandler

All Known Implementing Classes:

CompositeIncidentHandler, DefaultIncidentHandler

public interface IncidentHandler

The IncidentHandler interface may be implemented by components that handle and resolve incidents of a specific type that occur during the execution of a process instance.

Custom implementations of this interface may be wired through ProcessEngineConfigurationImpl.setCustomIncidentHandlers(java.util.List).

Author:

roman.smirnov

See Also:

• FailedJobIncidentHandler
• Incident

Method Summary

Modifier and Type	Method	Description
void	deleteIncident(IncidentContext context)	Called in situations in which an incident handler may wish to delete existing incidents Example: when a scope is ended or a job is deleted.
String	getIncidentHandlerType()	Returns the incident type this handler activates for.
Incident	handleIncident(IncidentContext context, String message)	Handle an incident that arose in the context of an execution.
void	resolveIncident(IncidentContext context)	Called in situations in which an incident handler may wish to resolve existing incidents The implementation receives this callback to enable it to resolve any open incidents that may exist.

Method Details

getIncidentHandlerType

String getIncidentHandlerType()

Returns the incident type this handler activates for.

handleIncident

Incident handleIncident(IncidentContext context,
 String message)

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

resolveIncident

void resolveIncident(IncidentContext context)

Called in situations in which an incident handler may wish to resolve existing incidents The implementation receives this callback to enable it to resolve any open incidents that may exist.

deleteIncident

void deleteIncident(IncidentContext context)

Called in situations in which an incident handler may wish to delete existing incidents Example: when a scope is ended or a job is deleted. The implementation receives this callback to enable it to delete any open incidents that may exist.