Package org.opencms.db

Class CmsOnlineFolderOptions

java.lang.Object

org.opencms.db.CmsOnlineFolderOptions

public class CmsOnlineFolderOptions
extends Object

Configuration parameters for the 'online folder' feature.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_FLEX_CACHE_DELAY	Configuration key for the flex cache clear delay.
static final String	PARAM_INDEXING_INTERVAL	Configuration key for the indexing interval.

Constructor Summary

Constructors

Constructor	Description
CmsOnlineFolderOptions(List<String> paths, CmsParameterConfiguration params)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
long	getFlexCacheDelay()	Gets the duration that has to pass after an instant publish event with no further instant publish events before the Flex cache is cleared.
long	getIndexingInterval()	Gets the amount of time across which (non-deletion) changes from instant publish events are combined for indexing.
CmsParameterConfiguration	getParams()	Gets the additional parameters.
List<String>	getPaths()	Gets the configured paths.

Methods inherited from class java.lang.Object

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

Field Details

PARAM_INDEXING_INTERVAL

public static final String PARAM_INDEXING_INTERVAL

Configuration key for the indexing interval.

See Also:

• Constant Field Values

PARAM_FLEX_CACHE_DELAY

public static final String PARAM_FLEX_CACHE_DELAY

Configuration key for the flex cache clear delay.

See Also:

• Constant Field Values

Constructor Details

CmsOnlineFolderOptions

public CmsOnlineFolderOptions(List<String> paths,
 CmsParameterConfiguration params)

Creates a new instance.

Parameters:

paths - the paths to be used as online folders

params - additional parameters

Method Details

getFlexCacheDelay

public long getFlexCacheDelay()

Gets the duration that has to pass after an instant publish event with no further instant publish events before the Flex cache is cleared.

Returns:

the flex cache delay

getIndexingInterval

public long getIndexingInterval()

Gets the amount of time across which (non-deletion) changes from instant publish events are combined for indexing.

Returns:

the indexing interval

getParams

public CmsParameterConfiguration getParams()

Gets the additional parameters.

Returns:

the additional parameters

getPaths

public List<String> getPaths()

Gets the configured paths.

Returns:

the configured paths