com.sapportals.wcm.service.cache

Interface ICacheService

All Superinterfaces:

IService

public interface ICacheService
extends IService

Provides a service to create caches.

Field Summary

static String

CACHE_SERVICE

Method Summary

com.sapportals.wcm.util.cache.ICache	getCache(String cacheID) Get a preconfigured cache (with properties taken from configuration).
com.sapportals.wcm.util.cache.ICache	getCache(String cacheID, Properties properties) Get a cache for the given ID (and given properties, if cache does not already exist): If no cache exists for the given ID, it will be created with the given properties.
com.sapportals.wcm.util.cache.IClusterCacheArea	getCacheArea(String ID) Get an instance of an IClusterCacheArea for the given area ID.
String	getUniqueCacheID() Get a new, unique cache ID that can be used in a call to getCache(cacheID,properties).

Methods inherited from interface com.sapportals.wcm.service.IService

getDescription, getDescription, getID

Field Detail

CACHE_SERVICE

static final String CACHE_SERVICE

See Also:

Constant Field Values

Method Detail

getUniqueCacheID

String getUniqueCacheID()

Get a new, unique cache ID that can be used in a call to getCache(cacheID,properties).

Returns:

a String with a new, internal, unique cache ID.

getCache

com.sapportals.wcm.util.cache.ICache getCache(String cacheID,
                                              Properties properties)
                                              throws ClassNotFoundException,
                                                     com.sapportals.wcm.util.cache.CacheException

Get a cache for the given ID (and given properties, if cache does not already exist): If no cache exists for the given ID, it will be created with the given properties. If a cache already exists for the given ID, the existing cache is returned and the properties are ignored.

Parameters:

cacheID - a String with the id of the cache to get.

properties - the Properties to use when a new cache for a non-exisiting ID is to be created.

Returns:

an ICache for the given ID (and the given properties, if the cache didn't already exist).

Throws:

ClassNotFoundException

com.sapportals.wcm.util.cache.CacheException

getCache

com.sapportals.wcm.util.cache.ICache getCache(String cacheID)
                                              throws ClassNotFoundException,
                                                     com.sapportals.wcm.util.cache.CacheException

Get a preconfigured cache (with properties taken from configuration).

Parameters:

cacheID - a String with the id of a preconfigured cache.

Returns:

a preconfigured ICache for the given ID.

Throws:

ClassNotFoundException

com.sapportals.wcm.util.cache.CacheException

getCacheArea

com.sapportals.wcm.util.cache.IClusterCacheArea getCacheArea(String ID)
                                                             throws com.sapportals.wcm.WcmException

Get an instance of an IClusterCacheArea for the given area ID.

Parameters:

ID - a String with the area ID of the clustered cache area.

Throws:

com.sapportals.wcm.WcmException - if the cache area couldn't be created.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM