Package org.opencms.db.storage.policy

Class CmsDefaultStoragePolicy

java.lang.Object

org.opencms.db.storage.policy.CmsDefaultStoragePolicy

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsStoragePolicy

public class CmsDefaultStoragePolicy
extends Object
implements I_CmsStoragePolicy, I_CmsConfigurationParameterHandler

Default content selection policy for the OpenCms deduplicating media storage engine (DMSE).

Content is stored in the active backend when its resource type ID is included in the configured selection and its size is strictly greater than the configured threshold. The defaults select all non-empty binary files and images (type IDs 2 and 3) with a threshold of 0 bytes.

This policy defines no path-based exceptions; matching resources below /system/ are also selected. Content which does not match remains in the regular VFS content columns (CMS_CONTENTS, CMS_OFFLINE_CONTENTS).

See Also:

• CmsStorageManager

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_THRESHOLD	The default threshold, in bytes.
static final String	PARAM_RESOURCE_TYPE_IDS	The resource type ids parameter name.
static final String	PARAM_THRESHOLD	The threshold parameter name.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
CmsDefaultStoragePolicy()	Creates a new policy with predefined default rules.

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String paramName, String paramValue)	Adds a configuration parameter to this parameter configurable class instance.
CmsParameterConfiguration	getConfiguration()	Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
void	initConfiguration()	Initializes a configuration after all parameters have been added.
boolean	isExternalStorageRequired(CmsStoragePolicyContext context)	Determines if the given content should be stored in the external storage.

Methods inherited from class java.lang.Object

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

Field Details

PARAM_RESOURCE_TYPE_IDS

public static final String PARAM_RESOURCE_TYPE_IDS

The resource type ids parameter name.

See Also:

• Constant Field Values

PARAM_THRESHOLD

public static final String PARAM_THRESHOLD

The threshold parameter name.

See Also:

• Constant Field Values

DEFAULT_THRESHOLD

public static final int DEFAULT_THRESHOLD

The default threshold, in bytes. The default value stores all non-empty binary and image files externally.

See Also:

• Constant Field Values

Constructor Details

CmsDefaultStoragePolicy

public CmsDefaultStoragePolicy()

Creates a new policy with predefined default rules.

Method Details

addConfigurationParameter

public void addConfigurationParameter(String paramName,
 String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

• I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

See Also:

• I_CmsConfigurationParameterHandler.getConfiguration()

initConfiguration

public void initConfiguration()
                       throws CmsConfigurationException

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

Throws:

CmsConfigurationException - if something goes wrong

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()

isExternalStorageRequired

public boolean isExternalStorageRequired(CmsStoragePolicyContext context)

Description copied from interface: I_CmsStoragePolicy

Determines if the given content should be stored in the external storage.

Specified by:

isExternalStorageRequired in interface I_CmsStoragePolicy

Parameters:

context - the storage policy context

Returns:

true if the file should be offloaded to the external storage, false otherwise

See Also:

• I_CmsStoragePolicy.isExternalStorageRequired(CmsStoragePolicyContext)