Package org.flowable.job.service.impl.persistence.entity

Class HistoryJobEntityImpl

java.lang.Object

org.flowable.common.engine.impl.persistence.entity.AbstractEntity

org.flowable.job.service.impl.persistence.entity.AbstractJobServiceEntity

org.flowable.job.service.impl.persistence.entity.HistoryJobEntityImpl

All Implemented Interfaces:

Serializable, HasRevision, Entity, HistoryJob, JobInfo, AbstractJobEntity, HistoryJobEntity, JobInfoEntity

public class HistoryJobEntityImpl
extends AbstractJobServiceEntity
implements HistoryJobEntity, Serializable

History Job entity.

Author:

Joram Barrez, Tijs Rademakers

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteArrayRef	advancedJobHandlerConfigurationByteArrayRef
protected Date	createTime
protected ByteArrayRef	customValuesByteArrayRef
protected ByteArrayRef	exceptionByteArrayRef
protected String	exceptionMessage
protected String	jobHandlerConfiguration
protected String	jobHandlerType
protected Date	lockExpirationTime
protected String	lockOwner
protected int	retries
protected String	scopeType
protected String	tenantId

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

id, isDeleted, isInserted, isUpdated, originalPersistentState, revision

Fields inherited from interface org.flowable.job.api.HistoryJob

HISTORY_JOB_TYPE

Fields inherited from interface org.flowable.job.api.JobInfo

MAX_EXCEPTION_MESSAGE_LENGTH

Constructor Summary

Constructors

Constructor	Description
HistoryJobEntityImpl()

Method Summary

Modifier and Type	Method	Description
String	getAdvancedJobHandlerConfiguration()
ByteArrayRef	getAdvancedJobHandlerConfigurationByteArrayRef()
Date	getCreateTime()	Get the job create time.
String	getCustomValues()	Get the custom values.
ByteArrayRef	getCustomValuesByteArrayRef()
protected String	getEngineType()
ByteArrayRef	getExceptionByteArrayRef()
String	getExceptionMessage()	Returns the message of the exception that occurred, the last time the job was executed.
String	getExceptionStacktrace()
protected String	getJobByteArrayRefAsString(ByteArrayRef jobByteArrayRef)
String	getJobHandlerConfiguration()	Get the job handler configuration.
String	getJobHandlerType()	Get the job handler type.
Date	getLockExpirationTime()
String	getLockOwner()
Object	getPersistentState()	Returns a representation of the object, as would be stored in the database.
int	getRetries()	Returns the number of retries this job has left.
String	getScopeType()	Get the scope type.
String	getTenantId()	Get the tenant identifier for this job.
void	setAdvancedJobHandlerConfiguration(String jobHandlerConfiguration)
void	setAdvancedJobHandlerConfigurationByteArrayRef(ByteArrayRef configurationByteArrayRef)
void	setAdvancedJobHandlerConfigurationBytes(byte[] bytes)
void	setCreateTime(Date createTime)
void	setCustomValues(String customValues)
void	setCustomValuesByteArrayRef(ByteArrayRef customValuesByteArrayRef)
void	setExceptionByteArrayRef(ByteArrayRef exceptionByteArrayRef)
void	setExceptionMessage(String exceptionMessage)
void	setExceptionStacktrace(String exception)
void	setJobHandlerConfiguration(String jobHandlerConfiguration)
void	setJobHandlerType(String jobHandlerType)
void	setLockExpirationTime(Date claimedUntil)
void	setLockOwner(String claimedBy)
void	setRetries(int retries)
void	setScopeType(String scopeType)	Set the scope type for the job.
void	setTenantId(String tenantId)
String	toString()

Methods inherited from class org.flowable.job.service.impl.persistence.entity.AbstractJobServiceEntity

getIdPrefix

Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

getId, getOriginalPersistentState, getRevision, getRevisionNext, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setRevision, setUpdated

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity

getId, getIdPrefix, getOriginalPersistentState, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setUpdated

Methods inherited from interface org.flowable.common.engine.impl.db.HasRevision

getRevision, getRevisionNext, setRevision

Methods inherited from interface org.flowable.job.api.JobInfo

getId

Field Details

retries

protected int retries

jobHandlerType

protected String jobHandlerType

jobHandlerConfiguration

protected String jobHandlerConfiguration

customValuesByteArrayRef

protected ByteArrayRef customValuesByteArrayRef

advancedJobHandlerConfigurationByteArrayRef

protected ByteArrayRef advancedJobHandlerConfigurationByteArrayRef

exceptionByteArrayRef

protected ByteArrayRef exceptionByteArrayRef

exceptionMessage

protected String exceptionMessage

lockOwner

protected String lockOwner

lockExpirationTime

protected Date lockExpirationTime

createTime

protected Date createTime

scopeType

protected String scopeType

tenantId

protected String tenantId

Constructor Details

HistoryJobEntityImpl

public HistoryJobEntityImpl()

Method Details

getPersistentState

public Object getPersistentState()

Description copied from interface: Entity

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 Entity

getRetries

public int getRetries()

Description copied from interface: JobInfo

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 AbstractJobEntity

Specified by:

getRetries in interface JobInfo

setRetries

public void setRetries(int retries)

Specified by:

setRetries in interface AbstractJobEntity

getJobHandlerType

public String getJobHandlerType()

Description copied from interface: JobInfo

Get the job handler type.

Specified by:

getJobHandlerType in interface AbstractJobEntity

Specified by:

getJobHandlerType in interface JobInfo

setJobHandlerType

public void setJobHandlerType(String jobHandlerType)

Specified by:

setJobHandlerType in interface AbstractJobEntity

getJobHandlerConfiguration

public String getJobHandlerConfiguration()

Description copied from interface: JobInfo

Get the job handler configuration.

Specified by:

getJobHandlerConfiguration in interface AbstractJobEntity

Specified by:

getJobHandlerConfiguration in interface JobInfo

setJobHandlerConfiguration

public void setJobHandlerConfiguration(String jobHandlerConfiguration)

Specified by:

setJobHandlerConfiguration in interface AbstractJobEntity

getCustomValues

public String getCustomValues()

Description copied from interface: JobInfo

Get the custom values.

Specified by:

getCustomValues in interface AbstractJobEntity

Specified by:

getCustomValues in interface JobInfo

setCustomValues

public void setCustomValues(String customValues)

Specified by:

setCustomValues in interface AbstractJobEntity

getCustomValuesByteArrayRef

public ByteArrayRef getCustomValuesByteArrayRef()

Specified by:

getCustomValuesByteArrayRef in interface AbstractJobEntity

setCustomValuesByteArrayRef

public void setCustomValuesByteArrayRef(ByteArrayRef customValuesByteArrayRef)

Specified by:

setCustomValuesByteArrayRef in interface AbstractJobEntity

getAdvancedJobHandlerConfigurationByteArrayRef

public ByteArrayRef getAdvancedJobHandlerConfigurationByteArrayRef()

Specified by:

getAdvancedJobHandlerConfigurationByteArrayRef in interface HistoryJobEntity

getAdvancedJobHandlerConfiguration

public String getAdvancedJobHandlerConfiguration()

Specified by:

getAdvancedJobHandlerConfiguration in interface HistoryJobEntity

setAdvancedJobHandlerConfigurationByteArrayRef

public void setAdvancedJobHandlerConfigurationByteArrayRef(ByteArrayRef configurationByteArrayRef)

Specified by:

setAdvancedJobHandlerConfigurationByteArrayRef in interface HistoryJobEntity

setAdvancedJobHandlerConfiguration

public void setAdvancedJobHandlerConfiguration(String jobHandlerConfiguration)

Specified by:

setAdvancedJobHandlerConfiguration in interface HistoryJobEntity

setAdvancedJobHandlerConfigurationBytes

public void setAdvancedJobHandlerConfigurationBytes(byte[] bytes)

Specified by:

setAdvancedJobHandlerConfigurationBytes in interface HistoryJobEntity

setExceptionByteArrayRef

public void setExceptionByteArrayRef(ByteArrayRef exceptionByteArrayRef)

Specified by:

setExceptionByteArrayRef in interface AbstractJobEntity

getExceptionByteArrayRef

public ByteArrayRef getExceptionByteArrayRef()

Specified by:

getExceptionByteArrayRef in interface AbstractJobEntity

getExceptionStacktrace

public String getExceptionStacktrace()

Specified by:

getExceptionStacktrace in interface AbstractJobEntity

setExceptionStacktrace

public void setExceptionStacktrace(String exception)

Specified by:

setExceptionStacktrace in interface AbstractJobEntity

getExceptionMessage

public String getExceptionMessage()

Description copied from interface: JobInfo

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 AbstractJobEntity

Specified by:

getExceptionMessage in interface JobInfo

setExceptionMessage

public void setExceptionMessage(String exceptionMessage)

Specified by:

setExceptionMessage in interface AbstractJobEntity

getTenantId

public String getTenantId()

Description copied from interface: JobInfo

Get the tenant identifier for this job.

Specified by:

getTenantId in interface AbstractJobEntity

Specified by:

getTenantId in interface JobInfo

setTenantId

public void setTenantId(String tenantId)

Specified by:

setTenantId in interface AbstractJobEntity

getCreateTime

public Date getCreateTime()

Description copied from interface: HistoryJob

Get the job create time.

Specified by:

getCreateTime in interface AbstractJobEntity

Specified by:

getCreateTime in interface HistoryJob

setCreateTime

public void setCreateTime(Date createTime)

Specified by:

setCreateTime in interface AbstractJobEntity

Specified by:

setCreateTime in interface HistoryJobEntity

getLockOwner

public String getLockOwner()

Specified by:

getLockOwner in interface JobInfoEntity

setLockOwner

public void setLockOwner(String claimedBy)

Specified by:

setLockOwner in interface JobInfoEntity

getLockExpirationTime

public Date getLockExpirationTime()

Specified by:

getLockExpirationTime in interface JobInfoEntity

setLockExpirationTime

public void setLockExpirationTime(Date claimedUntil)

Specified by:

setLockExpirationTime in interface JobInfoEntity

getScopeType

public String getScopeType()

Description copied from interface: HistoryJob

Get the scope type.

Specified by:

getScopeType in interface AbstractJobEntity

Specified by:

getScopeType in interface HistoryJob

Specified by:

getScopeType in interface JobInfoEntity

setScopeType

public void setScopeType(String scopeType)

Description copied from interface: JobInfoEntity

Set the scope type for the job. The scope type is the type which is used by the job executor to pick the jobs for executing.

For example if the job should be picked up by the CMMN Job executor then it should have the same type as the CMMN job executor.

Specified by:

setScopeType in interface AbstractJobEntity

Specified by:

setScopeType in interface JobInfoEntity

Parameters:

scopeType - the scope type for the job

getJobByteArrayRefAsString

protected String getJobByteArrayRefAsString(ByteArrayRef jobByteArrayRef)

getEngineType

protected String getEngineType()

toString

public String toString()

Overrides:

toString in class Object