Class IncidentEntity
- java.lang.Object
-
- org.camunda.bpm.engine.impl.persistence.entity.IncidentEntity
-
- All Implemented Interfaces:
DbEntity
,HasDbReferences
,HasDbRevision
,Incident
public class IncidentEntity extends java.lang.Object implements Incident, DbEntity, HasDbRevision, HasDbReferences
- Author:
- roman.smirnov
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
activityId
protected java.lang.String
annotation
protected java.lang.String
causeIncidentId
protected java.lang.String
configuration
protected java.lang.String
executionId
protected java.lang.String
failedActivityId
protected java.lang.String
historyConfiguration
protected java.lang.String
id
protected java.lang.String
incidentMessage
protected java.util.Date
incidentTimestamp
protected java.lang.String
incidentType
protected java.lang.String
jobDefinitionId
protected static IncidentLogger
LOG
protected java.lang.String
processDefinitionId
protected java.lang.String
processInstanceId
protected int
revision
protected java.lang.String
rootCauseIncidentId
protected java.lang.String
tenantId
-
Fields inherited from interface org.camunda.bpm.engine.runtime.Incident
EXTERNAL_TASK_HANDLER_TYPE, FAILED_JOB_HANDLER_TYPE
-
-
Constructor Summary
Constructors Constructor Description IncidentEntity()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected static IncidentEntity
create(java.lang.String incidentType)
static IncidentEntity
createAndInsertIncident(java.lang.String incidentType, IncidentContext context, java.lang.String message)
java.util.List<IncidentEntity>
createRecursiveIncidents()
protected void
createRecursiveIncidents(java.lang.String rootCauseIncidentId, java.util.List<IncidentEntity> createdIncidents)
Instantiate recursive a new incident a super execution (i.e.void
delete()
boolean
equals(java.lang.Object obj)
protected void
fireHistoricIncidentEvent(HistoryEventType eventType)
java.lang.String
getActivityId()
Returns the id of the activity of the process instance on which this incident has happened.java.lang.String
getAnnotation()
Returns the annotation of this incidentjava.lang.String
getCauseIncidentId()
Returns the id of the incident on which this incident has been triggered.java.lang.String
getConfiguration()
Returns the payload of this incident.ExecutionEntity
getExecution()
java.lang.String
getExecutionId()
Returns the specific execution on which this incident has happened.java.lang.String
getFailedActivityId()
Returns the id of the activity on which the last exception occurred.java.lang.String
getHistoryConfiguration()
Returns the history payload of this incident.java.lang.String
getId()
Returns the unique identifier for this incident.java.lang.String
getIncidentMessage()
Returns the incident message.java.util.Date
getIncidentTimestamp()
Time when the incident happened.java.lang.String
getIncidentType()
Returns the type of this incident to identify the kind of incident.java.lang.String
getJobDefinitionId()
Returns the id of the job definition the incident belongs to.java.lang.Object
getPersistentState()
Returns a representation of the object, as would be stored in the database.ProcessDefinitionEntity
getProcessDefinition()
java.lang.String
getProcessDefinitionId()
Returns the id of the process definition of this process instance on which the incident has happened.java.lang.String
getProcessInstanceId()
Returns the specific process instance on which this incident has happened.java.util.Map<java.lang.String,java.lang.Class>
getReferencedEntitiesIdAndClass()
Scope: IN-MEMORY referencesjava.util.Set<java.lang.String>
getReferencedEntityIds()
Scope: IN-MEMORY referencesint
getRevision()
int
getRevisionNext()
java.lang.String
getRootCauseIncidentId()
Returns the id of the root incident on which this transitive incident has been triggered.java.lang.String
getTenantId()
Returns the id of the tenant this incident belongs to.int
hashCode()
protected static void
insert(IncidentEntity incident)
protected void
remove(boolean resolved)
void
resolve()
void
setActivityId(java.lang.String activityId)
void
setAnnotation(java.lang.String annotation)
void
setCauseIncidentId(java.lang.String causeIncidentId)
void
setConfiguration(java.lang.String configuration)
void
setExecution(ExecutionEntity execution)
void
setExecutionId(java.lang.String executionId)
void
setFailedActivityId(java.lang.String failedActivityId)
void
setHistoryConfiguration(java.lang.String historyConfiguration)
void
setId(java.lang.String id)
void
setIncidentMessage(java.lang.String incidentMessage)
void
setIncidentTimestamp(java.util.Date incidentTimestamp)
void
setIncidentType(java.lang.String incidentType)
void
setJobDefinitionId(java.lang.String jobDefinitionId)
void
setProcessDefinitionId(java.lang.String processDefinitionId)
void
setProcessInstanceId(java.lang.String processInstanceId)
void
setRevision(int revision)
void
setRootCauseIncidentId(java.lang.String rootCauseIncidentId)
void
setTenantId(java.lang.String tenantId)
java.lang.String
toString()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.camunda.bpm.engine.impl.db.HasDbReferences
getDependentEntities
-
-
-
-
Field Detail
-
LOG
protected static final IncidentLogger LOG
-
revision
protected int revision
-
id
protected java.lang.String id
-
incidentTimestamp
protected java.util.Date incidentTimestamp
-
incidentType
protected java.lang.String incidentType
-
executionId
protected java.lang.String executionId
-
activityId
protected java.lang.String activityId
-
processInstanceId
protected java.lang.String processInstanceId
-
processDefinitionId
protected java.lang.String processDefinitionId
-
causeIncidentId
protected java.lang.String causeIncidentId
-
rootCauseIncidentId
protected java.lang.String rootCauseIncidentId
-
configuration
protected java.lang.String configuration
-
incidentMessage
protected java.lang.String incidentMessage
-
tenantId
protected java.lang.String tenantId
-
jobDefinitionId
protected java.lang.String jobDefinitionId
-
historyConfiguration
protected java.lang.String historyConfiguration
-
failedActivityId
protected java.lang.String failedActivityId
-
annotation
protected java.lang.String annotation
-
-
Method Detail
-
createRecursiveIncidents
public java.util.List<IncidentEntity> createRecursiveIncidents()
-
createRecursiveIncidents
protected void createRecursiveIncidents(java.lang.String rootCauseIncidentId, java.util.List<IncidentEntity> createdIncidents)
Instantiate recursive a new incident a super execution (i.e. super process instance) which is affected from this incident. For example: a super process instance called via CallActivity a new process instance on which an incident happened, so that the super process instance has an incident too.
-
createAndInsertIncident
public static IncidentEntity createAndInsertIncident(java.lang.String incidentType, IncidentContext context, java.lang.String message)
-
create
protected static IncidentEntity create(java.lang.String incidentType)
-
insert
protected static void insert(IncidentEntity incident)
-
delete
public void delete()
-
resolve
public void resolve()
-
remove
protected void remove(boolean resolved)
-
fireHistoricIncidentEvent
protected void fireHistoricIncidentEvent(HistoryEventType eventType)
-
getReferencedEntityIds
public java.util.Set<java.lang.String> getReferencedEntityIds()
Description copied from interface:HasDbReferences
Scope: IN-MEMORY references
- Specified by:
getReferencedEntityIds
in interfaceHasDbReferences
- Returns:
- the ids of the entities that this entity references. Should only return ids for entities of the same type
-
getReferencedEntitiesIdAndClass
public java.util.Map<java.lang.String,java.lang.Class> getReferencedEntitiesIdAndClass()
Description copied from interface:HasDbReferences
Scope: IN-MEMORY references
- Specified by:
getReferencedEntitiesIdAndClass
in interfaceHasDbReferences
- Returns:
- a map of the ids and the entities' classes that this entity references. It's used when trying to determine if there was an Optimistic Locking occurrence on an INSERT or UPDATE of an object of this type.
-
getId
public java.lang.String getId()
Description copied from interface:Incident
Returns the unique identifier for this incident.
-
getIncidentTimestamp
public java.util.Date getIncidentTimestamp()
Description copied from interface:Incident
Time when the incident happened.- Specified by:
getIncidentTimestamp
in interfaceIncident
-
setIncidentTimestamp
public void setIncidentTimestamp(java.util.Date incidentTimestamp)
-
getIncidentType
public java.lang.String getIncidentType()
Description copied from interface:Incident
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.- Specified by:
getIncidentType
in interfaceIncident
- See Also:
Incident.FAILED_JOB_HANDLER_TYPE
,Incident.EXTERNAL_TASK_HANDLER_TYPE
-
setIncidentType
public void setIncidentType(java.lang.String incidentType)
-
getIncidentMessage
public java.lang.String getIncidentMessage()
Description copied from interface:Incident
Returns the incident message.- Specified by:
getIncidentMessage
in interfaceIncident
-
setIncidentMessage
public void setIncidentMessage(java.lang.String incidentMessage)
-
getExecutionId
public java.lang.String getExecutionId()
Description copied from interface:Incident
Returns the specific execution on which this incident has happened.- Specified by:
getExecutionId
in interfaceIncident
-
setExecutionId
public void setExecutionId(java.lang.String executionId)
-
getActivityId
public java.lang.String getActivityId()
Description copied from interface:Incident
Returns the id of the activity of the process instance on which this incident has happened.- Specified by:
getActivityId
in interfaceIncident
-
setActivityId
public void setActivityId(java.lang.String activityId)
-
getProcessInstanceId
public java.lang.String getProcessInstanceId()
Description copied from interface:Incident
Returns the specific process instance on which this incident has happened.- Specified by:
getProcessInstanceId
in interfaceIncident
-
setProcessInstanceId
public void setProcessInstanceId(java.lang.String processInstanceId)
-
getProcessDefinition
public ProcessDefinitionEntity getProcessDefinition()
-
getProcessDefinitionId
public java.lang.String getProcessDefinitionId()
Description copied from interface:Incident
Returns the id of the process definition of this process instance on which the incident has happened.- Specified by:
getProcessDefinitionId
in interfaceIncident
-
setProcessDefinitionId
public void setProcessDefinitionId(java.lang.String processDefinitionId)
-
getCauseIncidentId
public java.lang.String getCauseIncidentId()
Description copied from interface:Incident
Returns the id of the incident on which this incident has been triggered.- Specified by:
getCauseIncidentId
in interfaceIncident
-
setCauseIncidentId
public void setCauseIncidentId(java.lang.String causeIncidentId)
-
getRootCauseIncidentId
public java.lang.String getRootCauseIncidentId()
Description copied from interface:Incident
Returns the id of the root incident on which this transitive incident has been triggered.- Specified by:
getRootCauseIncidentId
in interfaceIncident
-
setRootCauseIncidentId
public void setRootCauseIncidentId(java.lang.String rootCauseIncidentId)
-
getConfiguration
public java.lang.String getConfiguration()
Description copied from interface:Incident
Returns the payload of this incident.- Specified by:
getConfiguration
in interfaceIncident
-
setConfiguration
public void setConfiguration(java.lang.String configuration)
-
getTenantId
public java.lang.String getTenantId()
Description copied from interface:Incident
Returns the id of the tenant this incident belongs to. Can benull
if the incident belongs to no single tenant.- Specified by:
getTenantId
in interfaceIncident
-
setTenantId
public void setTenantId(java.lang.String tenantId)
-
setJobDefinitionId
public void setJobDefinitionId(java.lang.String jobDefinitionId)
-
getJobDefinitionId
public java.lang.String getJobDefinitionId()
Description copied from interface:Incident
Returns the id of the job definition the incident belongs to. Can benull
if the incident belongs to no job definition.- Specified by:
getJobDefinitionId
in interfaceIncident
-
setExecution
public void setExecution(ExecutionEntity execution)
-
getExecution
public ExecutionEntity getExecution()
-
getPersistentState
public java.lang.Object getPersistentState()
Description copied from interface:DbEntity
Returns a representation of the object, as would be stored in the database. Used when deciding if updates have occurred to the object or not since it was last loaded.- Specified by:
getPersistentState
in interfaceDbEntity
-
setRevision
public void setRevision(int revision)
- Specified by:
setRevision
in interfaceHasDbRevision
-
getRevision
public int getRevision()
- Specified by:
getRevision
in interfaceHasDbRevision
-
getRevisionNext
public int getRevisionNext()
- Specified by:
getRevisionNext
in interfaceHasDbRevision
-
getHistoryConfiguration
public java.lang.String getHistoryConfiguration()
Description copied from interface:Incident
Returns the history payload of this incident.- Specified by:
getHistoryConfiguration
in interfaceIncident
-
setHistoryConfiguration
public void setHistoryConfiguration(java.lang.String historyConfiguration)
-
getFailedActivityId
public java.lang.String getFailedActivityId()
Description copied from interface:Incident
Returns the id of the activity on which the last exception occurred.- Specified by:
getFailedActivityId
in interfaceIncident
-
setFailedActivityId
public void setFailedActivityId(java.lang.String failedActivityId)
-
getAnnotation
public java.lang.String getAnnotation()
Description copied from interface:Incident
Returns the annotation of this incident- Specified by:
getAnnotation
in interfaceIncident
-
setAnnotation
public void setAnnotation(java.lang.String annotation)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
-