Package org.camunda.bpm.engine.impl.persistence.entity

Class JobEntity

    • Field Detail

      • executionId

        protected java.lang.String executionId

      • processDefinitionId

        protected java.lang.String processDefinitionId

      • processDefinitionKey

        protected java.lang.String processDefinitionKey

      • retries

        protected int retries

      • suspensionState

        protected int suspensionState

      • jobHandlerType

        protected java.lang.String jobHandlerType

      • jobHandlerConfiguration

        protected java.lang.String jobHandlerConfiguration

      • exceptionByteArrayId

        protected java.lang.String exceptionByteArrayId

      • exceptionMessage

        protected java.lang.String exceptionMessage

      • deploymentId

        protected java.lang.String deploymentId

      • jobDefinitionId

        protected java.lang.String jobDefinitionId

      • priority

        protected long priority

      • tenantId

        protected java.lang.String tenantId

      • createTime

        protected java.util.Date createTime

      • activityId

        protected java.lang.String activityId

      • sequenceCounter

        protected long sequenceCounter

      • lastFailureLogId

        protected java.lang.String lastFailureLogId

      • failedActivityId

        protected java.lang.String failedActivityId

      • persistedDependentEntities

        protected java.util.Map<java.lang.String,​java.lang.Class> persistedDependentEntities

    • Constructor Detail

      • JobEntity

        public JobEntity()

    • Method Detail

      • preExecute

        protected void preExecute​(CommandContext commandContext)

      • postExecute

        protected void postExecute​(CommandContext commandContext)

      • insert

        public void insert()

      • delete

        public void delete()

      • delete

        public void delete​(boolean incidentResolved)

      • 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 interface DbEntity
        Overrides:
        getPersistentState in class AcquirableJobEntity

      • getSequenceCounter

        public long getSequenceCounter()

      • setSequenceCounter

        public void setSequenceCounter​(long sequenceCounter)

      • incrementSequenceCounter

        public void incrementSequenceCounter()

      • getExecutionId

        public java.lang.String getExecutionId()
        Description copied from interface: Job
        Returns the specific execution on which the job was created.
        Specified by:
        getExecutionId in interface Job

      • setExecutionId

        public void setExecutionId​(java.lang.String executionId)

      • ensureExecutionInitialized

        protected void ensureExecutionInitialized()

      • getRetries

        public int getRetries()
        Description copied from interface: Job
        Returns the number of retries this job has left. Whenever the jobexecutor fails to execute the job, this value is decremented. When it hits zero, the job is supposed to be dead and not retried again (ie a manual retry is required then).
        Specified by:
        getRetries in interface Job

      • setRetries

        public void setRetries​(int retries)

      • setRetriesFromPersistence

        public void setRetriesFromPersistence​(int retries)

      • createFailedJobIncident

        protected void createFailedJobIncident()

      • removeFailedJobIncident

        protected void removeFailedJobIncident​(boolean incidentResolved)

      • createIncidentContext

        protected IncidentContext createIncidentContext()

      • getExceptionStacktrace

        public java.lang.String getExceptionStacktrace()

      • setSuspensionState

        public void setSuspensionState​(int state)

      • getSuspensionState

        public int getSuspensionState()

      • isSuspended

        public boolean isSuspended()
        Description copied from interface: Job
        Indicates whether this job is suspended. If a job is suspended, the job will be not acquired by the job executor.
        Specified by:
        isSuspended in interface Job
        Returns:
        true if this Job is currently suspended.

      • getProcessDefinitionId

        public java.lang.String getProcessDefinitionId()
        Description copied from interface: Job
        Returns the id of the process definition which created the job.
        Specified by:
        getProcessDefinitionId in interface Job

      • setProcessDefinitionId

        public void setProcessDefinitionId​(java.lang.String processDefinitionId)

      • getProcessDefinitionKey

        public java.lang.String getProcessDefinitionKey()
        Description copied from interface: Job
        Returns the key of the process definition which created the job.
        Specified by:
        getProcessDefinitionKey in interface Job

      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(java.lang.String processDefinitionKey)

      • setExceptionStacktrace

        public void setExceptionStacktrace​(java.lang.String exception)

      • getJobHandler

        protected JobHandler getJobHandler()

      • getJobHandlerType

        public java.lang.String getJobHandlerType()

      • setJobHandlerType

        public void setJobHandlerType​(java.lang.String jobHandlerType)

      • getJobHandlerConfigurationRaw

        public java.lang.String getJobHandlerConfigurationRaw()

      • setJobHandlerConfigurationRaw

        public void setJobHandlerConfigurationRaw​(java.lang.String jobHandlerConfiguration)

      • getExceptionMessage

        public java.lang.String getExceptionMessage()
        Description copied from interface: Job
        Returns the message of the exception that occurred, the last time the job was executed. Returns null when no exception occurred. To get the full exception stacktrace, use ManagementService.getJobExceptionStacktrace(String)
        Specified by:
        getExceptionMessage in interface Job

      • getJobDefinitionId

        public java.lang.String getJobDefinitionId()
        Description copied from interface: Job
        The id of the JobDefinition for this job.
        Specified by:
        getJobDefinitionId in interface Job

      • setJobDefinitionId

        public void setJobDefinitionId​(java.lang.String jobDefinitionId)

      • setJobDefinition

        public void setJobDefinition​(JobDefinition jobDefinition)

      • ensureJobDefinitionInitialized

        protected void ensureJobDefinitionInitialized()

      • setExceptionMessage

        public void setExceptionMessage​(java.lang.String exceptionMessage)

      • getExceptionByteArrayId

        public java.lang.String getExceptionByteArrayId()

      • getExceptionByteArray

        protected ByteArrayEntity getExceptionByteArray()

      • ensureExceptionByteArrayInitialized

        protected void ensureExceptionByteArrayInitialized()

      • clearFailedJobException

        protected void clearFailedJobException()

      • getDeploymentId

        public java.lang.String getDeploymentId()
        Description copied from interface: Job
        Returns the id of the deployment in which context the job was created.
        Specified by:
        getDeploymentId in interface Job

      • setDeploymentId

        public void setDeploymentId​(java.lang.String deploymentId)

      • isInInconsistentLockState

        public boolean isInInconsistentLockState()

      • resetLock

        public void resetLock()

      • getActivityId

        public java.lang.String getActivityId()

      • setActivityId

        public void setActivityId​(java.lang.String activityId)

      • getPriority

        public long getPriority()
        Description copied from interface: Job
        The job's priority that is a hint to job acquisition.
        Specified by:
        getPriority in interface Job

      • setPriority

        public void setPriority​(long priority)

      • getTenantId

        public java.lang.String getTenantId()
        Description copied from interface: Job
        The id of the tenant this job belongs to. Can be null if the job belongs to no single tenant.
        Specified by:
        getTenantId in interface Job

      • setTenantId

        public void setTenantId​(java.lang.String tenantId)

      • getCreateTime

        public java.util.Date getCreateTime()
        Description copied from interface: Job
        The date/time when this job has been created
        Specified by:
        getCreateTime in interface Job

      • setCreateTime

        public void setCreateTime​(java.util.Date createTime)

      • ensureActivityIdInitialized

        protected void ensureActivityIdInitialized()

      • unlock

        public void unlock()
        Unlock from current lock owner

      • getType

        public abstract java.lang.String getType()

      • getReferencedEntityIds

        public java.util.Set<java.lang.String> getReferencedEntityIds()
        Description copied from interface: HasDbReferences

        Scope: IN-MEMORY references

        Specified by:
        getReferencedEntityIds in interface HasDbReferences
        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 interface HasDbReferences
        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.

      • getDependentEntities

        public java.util.Map<java.lang.String,​java.lang.Class> getDependentEntities()
        Description copied from interface: HasDbReferences

        Scope: PERSISTED references

        Specified by:
        getDependentEntities in interface HasDbReferences

      • getLastFailureLogId

        public java.lang.String getLastFailureLogId()

      • setLastFailureLogId

        public void setLastFailureLogId​(java.lang.String lastFailureLogId)

      • getFailedActivityId

        public java.lang.String getFailedActivityId()
        Description copied from interface: Job
        Returns the id of the activity on which the last exception occurred.
        Specified by:
        getFailedActivityId in interface Job

      • setFailedActivityId

        public void setFailedActivityId​(java.lang.String failedActivityId)