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

Class CompositeIncidentHandler

java.lang.Object

org.camunda.bpm.engine.impl.incident.CompositeIncidentHandler

All Implemented Interfaces:

IncidentHandler

public class CompositeIncidentHandler
extends Object
implements IncidentHandler

A composite incident handler that handles incidents of a certain type by the multiple handlers. The result of handling depends on main handler.

See Also:

mainIncidentHandler, IncidentHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected List<IncidentHandler>	incidentHandlers
protected IncidentHandler	mainIncidentHandler

Constructor Summary

Constructors

Constructor	Description
CompositeIncidentHandler(IncidentHandler mainIncidentHandler, List<IncidentHandler> incidentHandlers)	Constructor that takes a list of IncidentHandler that consume the incident.
CompositeIncidentHandler(IncidentHandler mainIncidentHandler, IncidentHandler... incidentHandlers)	Constructor that takes a varargs parameter IncidentHandler that consume the incident.

Method Summary

Modifier and Type	Method	Description
void	add(IncidentHandler incidentHandler)	Adds the IncidentHandler to the list of IncidentHandler that consume the incident.
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.
protected void	initializeIncidentsHandlers(IncidentHandler mainIncidentHandler, List<IncidentHandler> incidentHandlers)	Initialize incidentHandlers with data transfered from constructor
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.

Methods inherited from class java.lang.Object

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

Field Detail

mainIncidentHandler

protected IncidentHandler mainIncidentHandler

incidentHandlers

protected final List<IncidentHandler> incidentHandlers

Constructor Detail

CompositeIncidentHandler

public CompositeIncidentHandler(IncidentHandler mainIncidentHandler,
                                List<IncidentHandler> incidentHandlers)

Constructor that takes a list of IncidentHandler that consume the incident.

Parameters:

mainIncidentHandler - the main incident handler IncidentHandler that consume the incident and return result.

incidentHandlers - the list of IncidentHandler that consume the incident.

CompositeIncidentHandler

public CompositeIncidentHandler(IncidentHandler mainIncidentHandler,
                                IncidentHandler... incidentHandlers)

Constructor that takes a varargs parameter IncidentHandler that consume the incident.

Parameters:

mainIncidentHandler - the main incident handler IncidentHandler that consume the incident and return result.

incidentHandlers - the list of IncidentHandler that consume the incident.

Method Detail

initializeIncidentsHandlers

protected void initializeIncidentsHandlers(IncidentHandler mainIncidentHandler,
                                           List<IncidentHandler> incidentHandlers)

Initialize incidentHandlers with data transfered from constructor

Parameters:

incidentHandlers -

add

public void add(IncidentHandler incidentHandler)

Adds the IncidentHandler to the list of IncidentHandler that consume the incident.

Parameters:

incidentHandler - the IncidentHandler that consume the incident.

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 Incident handleIncident(IncidentContext context,
                               String message)

Description copied from interface: IncidentHandler

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

Specified by:

handleIncident in interface IncidentHandler

resolveIncident

public void resolveIncident(IncidentContext context)

Description copied from interface: IncidentHandler

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.

Specified by:

resolveIncident in interface IncidentHandler

deleteIncident

public void deleteIncident(IncidentContext context)

Description copied from interface: IncidentHandler

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.

Specified by:

deleteIncident in interface IncidentHandler