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

Class HistoryExpirationCriteria

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

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

All Implemented Interfaces:

org.mule.runtime.api.component.Component

public class HistoryExpirationCriteria
extends org.mule.runtime.api.component.AbstractComponent

An age based criteria about if a BatchJobInstance should be expired or not.

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
HistoryExpirationCriteria(long maxAge, TimeUnit ageUnit) 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 jobInstance should be expired from the historic records based on the relationship between BatchJobInstance.getCreationTime() and maxAge/ageUnit

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

HistoryExpirationCriteria

public HistoryExpirationCriteria(long maxAge,
                                 TimeUnit ageUnit)

Creates a new instance

Parameters:

maxAge - a value for maxAge

ageUnit - a value for ageUnit

Method Detail

shouldExpire

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

Determines if jobInstance should be expired from the historic records based on the relationship between BatchJobInstance.getCreationTime() and maxAge/ageUnit

Parameters:

jobInstance - a BatchJobInstance

Returns:

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