Package org.camunda.bpm.engine.impl

Class HistoryTimeToLiveParser

java.lang.Object

org.camunda.bpm.engine.impl.HistoryTimeToLiveParser

public class HistoryTimeToLiveParser
extends Object

Class that encapsulates the business logic of parsing HistoryTimeToLive of different deployable resources (process, definition, case).

Furthermore, it considers notifying the users with a logging message when parsing historyTimeToLive values that are the same with the default camunda modeler TTL value (see CAMUNDA_MODELER_TTL_DEFAULT_VALUE).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	HistoryTimeToLiveParser.HTTLParsedResult

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	CAMUNDA_MODELER_TTL_DEFAULT_VALUE
protected final boolean	enforceNonNullValue
protected final String	httlConfigValue
protected static final ConfigurationLogger	LOG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HistoryTimeToLiveParser(boolean enforceNonNullValue, String httlConfigValue)

Method Summary

Modifier and Type	Method	Description
static HistoryTimeToLiveParser	create()
static HistoryTimeToLiveParser	create(ProcessEngineConfigurationImpl config)
static HistoryTimeToLiveParser	create(CommandContext context)
Integer	parse(Element processElement, String definitionKey, boolean skipEnforceTtl)
Integer	parse(Case caseElement, String definitionKey, boolean skipEnforceTtl)
Integer	parse(Decision decision, String definitionKey, boolean skipEnforceTtl)
protected Integer	parseAndValidate(String historyTimeToLiveString, String definitionKey, boolean skipEnforceTtl)	Parses the given HistoryTimeToLive String expression and then executes any applicable validation before returning the parsed value.
void	validate(Integer historyTimeToLive)

Methods inherited from class java.lang.Object

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

Field Details

LOG

protected static final ConfigurationLogger LOG

CAMUNDA_MODELER_TTL_DEFAULT_VALUE

protected static final int CAMUNDA_MODELER_TTL_DEFAULT_VALUE

See Also:

• Constant Field Values

enforceNonNullValue

protected final boolean enforceNonNullValue

httlConfigValue

protected final String httlConfigValue

Constructor Details

HistoryTimeToLiveParser

protected HistoryTimeToLiveParser(boolean enforceNonNullValue,
 String httlConfigValue)

Method Details

create

public static HistoryTimeToLiveParser create()

create

public static HistoryTimeToLiveParser create(CommandContext context)

create

public static HistoryTimeToLiveParser create(ProcessEngineConfigurationImpl config)

validate

public void validate(Integer historyTimeToLive)

parse

public Integer parse(Element processElement,
 String definitionKey,
 boolean skipEnforceTtl)

parse

public Integer parse(Case caseElement,
 String definitionKey,
 boolean skipEnforceTtl)

parse

public Integer parse(Decision decision,
 String definitionKey,
 boolean skipEnforceTtl)

parseAndValidate

protected Integer parseAndValidate(String historyTimeToLiveString,
 String definitionKey,
 boolean skipEnforceTtl)
                            throws NotValidException

Parses the given HistoryTimeToLive String expression and then executes any applicable validation before returning the parsed value.

Parameters:

historyTimeToLiveString - the history time to live string expression in ISO-8601 format

definitionKey - the correlated definition key that this historyTimeToLive was fetched from (process definition key for processes, decision definition key for decisions, case definition key for cases).

skipEnforceTtl - skips enforcing the TTL.

Returns:

the parsed integer value of history time to live

Throws:

NotValidException - in case enforcement of non-null values is on and the parsed result was null