org.opencms.ade.containerpage.inherited

类 CmsContainerConfigurationCache

java.lang.Object

org.opencms.ade.containerpage.inherited.CmsContainerConfigurationCache

所有已实现的接口:

I_CmsGlobalConfigurationCache

public class CmsContainerConfigurationCache
extends java.lang.Object
implements I_CmsGlobalConfigurationCache

A cache class for storing inherited container configurations.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	INHERITANCE_CONFIG_FILE_NAME The standard file name for inherited container configurations.
static org.apache.commons.logging.Log	LOG The logger instance for this class.
protected boolean	m_initialized A flag which indicates whether this cache is initialized.

构造器概要

构造器

构造器和说明
CmsContainerConfigurationCache(CmsObject cms, java.lang.String name) Creates a new cache instance for inherited containers.

方法概要

方法

限定符和类型	方法和说明
void	clear() Clears the cache.
protected java.lang.String	getBasePath(java.lang.String rootPath) Returns the base path for a given configuration file.
protected java.lang.String	getCacheKey(java.lang.String basePath) Gets the cache key for a given base path.
CmsContainerConfiguration	getContainerConfiguration(java.lang.String rootPath, java.lang.String name, java.util.Locale locale) Gets the container configuration for a given root path, name and locale.
void	initialize() Initializes the cache.
protected boolean	isContainerConfiguration(java.lang.String rootPath, int type) Checks whethet a given combination of path and resource type belongs to an inherited container configuration file.
protected void	load(CmsResource configResource) Loads a single configuration file into the cache.
protected void	readRemainingConfigurations() Reads the configurations needed to make the cache up-to-date.
void	remove(CmsPublishedResource resource) Removes a published resource from the cache.
void	remove(CmsResource resource) Removes a resource from the cache.
protected void	remove(CmsUUID structureId, java.lang.String rootPath, int type) Removes a resource from the cache.
protected int	safeGetType() Either gets the configuration type id, or returns -1 if the type hasn't been loaded yet.
void	update(CmsPublishedResource resource) Updates the cache entry for the given published resource.
void	update(CmsResource resource) Updates the cache entry for the given resource.
protected void	update(CmsUUID structureId, java.lang.String rootPath, int type, CmsResourceState state) Updates a resource in the cache.

从类继承的方法 java.lang.Object

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

字段详细资料

INHERITANCE_CONFIG_FILE_NAME

public static final java.lang.String INHERITANCE_CONFIG_FILE_NAME

The standard file name for inherited container configurations.

另请参阅:

常量字段值

LOG

public static final org.apache.commons.logging.Log LOG

The logger instance for this class.

m_initialized

protected boolean m_initialized

A flag which indicates whether this cache is initialized.

构造器详细资料

CmsContainerConfigurationCache

public CmsContainerConfigurationCache(CmsObject cms,
                              java.lang.String name)
                               throws CmsException

Creates a new cache instance for inherited containers.

参数:

cms - the CMS context to use for VFS operations.

name - the name of the cache, for debugging/testing purposes

抛出:

CmsException - if something goes wrong

方法详细资料

clear

public void clear()

从接口复制的说明: I_CmsGlobalConfigurationCache

Clears the cache.

指定者:

clear 在接口中 I_CmsGlobalConfigurationCache

另请参阅:

I_CmsGlobalConfigurationCache.clear()

getContainerConfiguration

public CmsContainerConfiguration getContainerConfiguration(java.lang.String rootPath,
                                                  java.lang.String name,
                                                  java.util.Locale locale)

Gets the container configuration for a given root path, name and locale.

参数:

rootPath - the root path

name - the configuration name

locale - the locale to use

返回:

the container configuration for the given combination of parameters

initialize

public void initialize()

Initializes the cache.

remove

public void remove(CmsPublishedResource resource)

从接口复制的说明: I_CmsGlobalConfigurationCache

Removes a published resource from the cache.

指定者:

remove 在接口中 I_CmsGlobalConfigurationCache

参数:

resource - the published resource

另请参阅:

I_CmsGlobalConfigurationCache.remove(org.opencms.db.CmsPublishedResource)

remove

public void remove(CmsResource resource)

从接口复制的说明: I_CmsGlobalConfigurationCache

Removes a resource from the cache.

指定者:

remove 在接口中 I_CmsGlobalConfigurationCache

参数:

resource - the resource to remove

另请参阅:

I_CmsGlobalConfigurationCache.remove(org.opencms.file.CmsResource)

update

public void update(CmsPublishedResource resource)

从接口复制的说明: I_CmsGlobalConfigurationCache

Updates the cache entry for the given published resource.

NOTE: Cache implementations should not directly read the updated resource in this method because it might interfere with other caches. Instead, the resource should be marked as updated and read the next time the cache is queried.

指定者:

update 在接口中 I_CmsGlobalConfigurationCache

参数:

resource - a published resource

另请参阅:

I_CmsGlobalConfigurationCache.update(org.opencms.db.CmsPublishedResource)

update

public void update(CmsResource resource)

从接口复制的说明: I_CmsGlobalConfigurationCache

Updates the cache entry for the given resource.

NOTE: Cache implementations should not directly read the updated resource in this method because it might interfere with other caches. Instead, the resource should be marked as updated and read the next time the cache is queried.

指定者:

update 在接口中 I_CmsGlobalConfigurationCache

参数:

resource - the resource for which the cache entry should be updated

另请参阅:

I_CmsGlobalConfigurationCache.update(org.opencms.file.CmsResource)

getBasePath

protected java.lang.String getBasePath(java.lang.String rootPath)

Returns the base path for a given configuration file. E.g. the result for the input '/sites/default/.container-config' will be '/sites/default'.

参数:

rootPath - the root path of the configuration file

返回:

the base path for the configuration file

getCacheKey

protected java.lang.String getCacheKey(java.lang.String basePath)

Gets the cache key for a given base path.

参数:

basePath - the base path

返回:

the cache key for the base path

isContainerConfiguration

protected boolean isContainerConfiguration(java.lang.String rootPath,
                               int type)

Checks whethet a given combination of path and resource type belongs to an inherited container configuration file.

参数:

rootPath - the root path of the resource

type - the type id of the resource

返回:

true if the given root path / type combination matches an inherited container configuration file

load

protected void load(CmsResource configResource)

Loads a single configuration file into the cache.

参数:

configResource - the configuration resource

readRemainingConfigurations

protected void readRemainingConfigurations()

Reads the configurations needed to make the cache up-to-date.

remove

protected void remove(CmsUUID structureId,
          java.lang.String rootPath,
          int type)

Removes a resource from the cache.

参数:

structureId - the structure id of the resource

rootPath - the root path of the resource

type - the resource type

safeGetType

protected int safeGetType()

Either gets the configuration type id, or returns -1 if the type hasn't been loaded yet.

返回:

the configuration type id or -1

update

protected void update(CmsUUID structureId,
          java.lang.String rootPath,
          int type,
          CmsResourceState state)

Updates a resource in the cache.

参数:

structureId - the structure id of the resource

rootPath - the root path of the resource

type - the resource type

state - the resource state