Package org.opencms.loader

Class CmsImageCacheFactory

java.lang.Object

org.opencms.loader.CmsImageCacheFactory

public final class CmsImageCacheFactory
extends Object

Creates the external image cache selected in opencms.properties.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_IMAGE_CACHE_PREFIX	Prefix for the direct image cache configuration.
static final String	PARAM_IMAGE_CACHE_TYPE	Property selecting the image cache type.

Method Summary

Modifier and Type	Method	Description
static I_CmsImageCache	create(CmsParameterConfiguration configuration)	Creates the configured external image cache.
static void	validateConfiguration(CmsParameterConfiguration configuration)	Validates the image cache settings and separation from active and legacy data storage.

Methods inherited from class java.lang.Object

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

Field Details

PARAM_IMAGE_CACHE_PREFIX

public static final String PARAM_IMAGE_CACHE_PREFIX

Prefix for the direct image cache configuration.

See Also:

• Constant Field Values

PARAM_IMAGE_CACHE_TYPE

public static final String PARAM_IMAGE_CACHE_TYPE

Property selecting the image cache type.

See Also:

• Constant Field Values

Method Details

create

public static I_CmsImageCache create(CmsParameterConfiguration configuration)
                              throws CmsConfigurationException

Creates the configured external image cache.

Parameters:

configuration - the runtime property configuration

Returns:

the configured cache, or null for the classic RFS image cache

Throws:

CmsConfigurationException - if the configuration is invalid or the cache is unavailable

validateConfiguration

public static void validateConfiguration(CmsParameterConfiguration configuration)
                                  throws CmsConfigurationException

Validates the image cache settings and separation from active and legacy data storage.

This does not open a cache or access S3, so offline maintenance tools can use the same validation.

Parameters:

configuration - the runtime property configuration

Throws:

CmsConfigurationException - if the configuration is invalid