org.camunda.bpm.engine.impl.incident.IncidentHandler Maven / Gradle / Ivy
/* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.camunda.bpm.engine.impl.incident;
/**
* The {@link 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
* {@link org.camunda.bpm.engine.impl.cfg.ProcessEngineConfigurationImpl#setCustomIncidentHandlers(java.util.List)}.
*
* @see FailedJobIncidentHandler
* @see org.camunda.bpm.engine.runtime.Incident
*
* @author roman.smirnov
*/
public interface IncidentHandler {
/**
* Returns the incident type this handler activates for.
*/
public String getIncidentHandlerType();
/**
* Handle an incident that arose in the context of an execution.
*/
public void handleIncident(IncidentContext context, String message);
/**
* Resolve an incident that arose in the context of an execution.
*/
public void resolveIncident(IncidentContext context);
/**
* Delete an incident that arose in the context of an execution.
*/
public void deleteIncident(IncidentContext context);
}