org.camunda.bpm.engine.runtime.Incident Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; 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.runtime;
import java.util.Date;
/**
* An {@link Incident} represents a failure in the execution of
* a process instance.
*
*
*
* A possible failure could be for example a failed {@link 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
*
*/
public interface Incident {
/**
* Handler type for incidents created on job execution failure
*/
static final String FAILED_JOB_HANDLER_TYPE = "failedJob";
/**
* Handler type for incidents created on external task failure
*/
static final String EXTERNAL_TASK_HANDLER_TYPE = "failedExternalTask";
/**
* Returns the unique identifier for this incident.
*/
String getId();
/**
* Time when the incident happened.
*/
Date getIncidentTimestamp();
/**
* 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 Incident#FAILED_JOB_HANDLER_TYPE
* @see Incident#EXTERNAL_TASK_HANDLER_TYPE
*/
String getIncidentType();
/**
* Returns the incident message.
*/
String getIncidentMessage();
/**
* Returns the specific execution on which this
* incident has happened.
*/
String getExecutionId();
/**
* Returns the id of the activity of the process instance
* on which this incident has happened.
*/
String getActivityId();
/**
* Returns the id of the activity on which the last exception occurred.
*/
String getFailedActivityId();
/**
* Returns the specific process instance on which this
* incident has happened.
*/
String getProcessInstanceId();
/**
* Returns the id of the process definition of this
* process instance on which the incident has happened.
*/
String getProcessDefinitionId();
/**
* Returns the id of the incident on which this incident
* has been triggered.
*/
String getCauseIncidentId();
/**
* Returns the id of the root incident on which
* this transitive incident has been triggered.
*/
String getRootCauseIncidentId();
/**
* Returns the payload of this incident.
*/
String getConfiguration();
/**
* Returns the id of the tenant this incident belongs to. Can be null
* if the incident belongs to no single tenant.
*/
String getTenantId();
/**
* Returns the id of the job definition the incident belongs to. Can be null
* if the incident belongs to no job definition.
*/
String getJobDefinitionId();
/**
* Returns the history payload of this incident.
*/
String getHistoryConfiguration();
/**
* Returns the annotation of this incident
*/
String getAnnotation();
}