Package org.camunda.bpm.engine.impl.jobexecutor.historycleanup

Class HistoryCleanupJobHandler

java.lang.Object

org.camunda.bpm.engine.impl.jobexecutor.historycleanup.HistoryCleanupJobHandler

All Implemented Interfaces:

JobHandler<HistoryCleanupJobHandlerConfiguration>

public class HistoryCleanupJobHandler
extends java.lang.Object
implements JobHandler<HistoryCleanupJobHandlerConfiguration>

Job handler for history cleanup job.

Author:

Svetlana Dorokhova

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TYPE

Constructor Summary

Constructors

Constructor	Description
HistoryCleanupJobHandler()

Method Summary

Modifier and Type	Method	Description
void	execute(HistoryCleanupJobHandlerConfiguration configuration, ExecutionEntity execution, CommandContext commandContext, java.lang.String tenantId)
protected HistoryCleanupRemovalTime	getTimeBasedHandler()
java.lang.String	getType()
protected HistoryCleanupHandler	initCleanupHandler(HistoryCleanupJobHandlerConfiguration configuration, CommandContext commandContext)
protected boolean	isHistoryCleanupStrategyRemovalTimeBased(CommandContext commandContext)
protected boolean	isWithinBatchWindow(CommandContext commandContext)
HistoryCleanupJobHandlerConfiguration	newConfiguration(java.lang.String canonicalString)
void	onDelete(HistoryCleanupJobHandlerConfiguration configuration, JobEntity jobEntity)	Clean up before job is deleted.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

HistoryCleanupJobHandler

public HistoryCleanupJobHandler()

Method Detail

execute

public void execute(HistoryCleanupJobHandlerConfiguration configuration,
                    ExecutionEntity execution,
                    CommandContext commandContext,
                    java.lang.String tenantId)

Specified by:

execute in interface JobHandler<HistoryCleanupJobHandlerConfiguration>

getTimeBasedHandler

protected HistoryCleanupRemovalTime getTimeBasedHandler()

initCleanupHandler

protected HistoryCleanupHandler initCleanupHandler(HistoryCleanupJobHandlerConfiguration configuration,
                                                   CommandContext commandContext)

isHistoryCleanupStrategyRemovalTimeBased

protected boolean isHistoryCleanupStrategyRemovalTimeBased(CommandContext commandContext)

isWithinBatchWindow

protected boolean isWithinBatchWindow(CommandContext commandContext)

newConfiguration

public HistoryCleanupJobHandlerConfiguration newConfiguration(java.lang.String canonicalString)

Specified by:

newConfiguration in interface JobHandler<HistoryCleanupJobHandlerConfiguration>

getType

public java.lang.String getType()

Specified by:

getType in interface JobHandler<HistoryCleanupJobHandlerConfiguration>

onDelete

public void onDelete(HistoryCleanupJobHandlerConfiguration configuration,
                     JobEntity jobEntity)

Description copied from interface: JobHandler

Clean up before job is deleted. Like removing of auxiliary entities specific for this job handler.

Specified by:

onDelete in interface JobHandler<HistoryCleanupJobHandlerConfiguration>

Parameters:

configuration - the job handler configuration

jobEntity - the job entity to be deleted