Package org.opencms.db.storage.policy

Class CmsStoragePolicyEngine

java.lang.Object

org.opencms.db.storage.policy.CmsStoragePolicyEngine

public class CmsStoragePolicyEngine
extends Object

Engine for evaluating storage policies to determine the appropriate storage location for binary content.

This engine allows the registration of rules and whitelist exceptions. It evaluates whether a blob should be stored in a specialized storage.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CmsStoragePolicyEngine.AndRule	A rule implementation that combines multiple rules using a logical AND operation.
static interface	CmsStoragePolicyEngine.StorageRule	Functional interface for a single storage evaluation rule.

Constructor Summary

Constructors

Constructor	Description
CmsStoragePolicyEngine()

Method Summary

Modifier and Type	Method	Description
void	addStorageRule(CmsStoragePolicyEngine.StorageRule storageRule)	Adds a rule that triggers offloading.
void	addWhitelistRule(CmsStoragePolicyEngine.StorageRule storageRule)	Adds a whitelist rule.
boolean	isWhitelisted(CmsStoragePolicyContext context)	Returns true if the given content matches any whitelist rule.
boolean	shouldStoreInStorage(CmsStoragePolicyContext context)	Evaluates 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

Constructor Details

CmsStoragePolicyEngine

public CmsStoragePolicyEngine()

Method Details

addStorageRule

public void addStorageRule(CmsStoragePolicyEngine.StorageRule storageRule)

Adds a rule that triggers offloading.

Parameters:

storageRule - the rule to add

addWhitelistRule

public void addWhitelistRule(CmsStoragePolicyEngine.StorageRule storageRule)

Adds a whitelist rule. If this rule matches, the content is always stored locally.

Parameters:

storageRule - the rule to add

isWhitelisted

public boolean isWhitelisted(CmsStoragePolicyContext context)

Returns true if the given content matches any whitelist rule.

Parameters:

context - the storage policy context

Returns:

true if whitelisted

shouldStoreInStorage

public boolean shouldStoreInStorage(CmsStoragePolicyContext context)

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

First checks the whitelist. If not whitelisted, it checks if any storage rule applies.

Parameters:

context - the storage policy context

Returns:

true if external storage is required