com.mulesoft.mule.runtime.module.batch.engine.history

Class HistoryExpirationPolicy

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

com.mulesoft.mule.runtime.module.batch.engine.history.HistoryExpirationPolicy

All Implemented Interfaces:

org.mule.runtime.api.component.Component

public final class HistoryExpirationPolicy
extends org.mule.runtime.api.component.AbstractComponent

Determines if a BatchJobInstance should be expired from the historic records.

Regardless of the provided criteria, it will never expire instances which are on an executable state.

Since:

3.8.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.api.component.Component

org.mule.runtime.api.component.Component.Annotations

Field Summary

Fields inherited from class org.mule.runtime.api.component.AbstractComponent

ANNOTATION_NAME, LOCATION_KEY, ROOT_CONTAINER_NAME_KEY

Fields inherited from interface org.mule.runtime.api.component.Component

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

Constructor Summary

Constructors

Constructor and Description
HistoryExpirationPolicy(HistoryExpirationCriteria criteria) Creates a new instance

Method Summary

Modifier and Type	Method and Description
boolean	shouldExpire(com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance jobInstance) Determines if the jobInstance should be expired from the historic records.

Methods inherited from class org.mule.runtime.api.component.AbstractComponent

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation, initRootContainerName, setAnnotations

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryExpirationPolicy

public HistoryExpirationPolicy(HistoryExpirationCriteria criteria)

Creates a new instance

Parameters:

criteria - a HistoryExpirationCriteria. Cannot be null

Throws:

IllegalArgumentException - if criteria is null

Method Detail

shouldExpire

public boolean shouldExpire(com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance jobInstance)

Determines if the jobInstance should be expired from the historic records.

If jobInstance is on an executable state, then it returns false. Otherwise, the decision is delegated to the criteria

Parameters:

jobInstance - a BatchJobInstance

Returns:

true if the jobInstance can be expired from the historic records. false otherwise