Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.service.cache
Interface ICacheService

[contained in: com.sap.netweaver.bc.sf.service.par - bc.sf.service.cache_api.jar]
All Superinterfaces:
IService
public interface ICacheService
extends IService

Provides a service to create caches.

Method Summary
 ICache getCache(java.lang.String cacheID)
          Get a preconfigured cache (with properties taken from configuration).
 ICache getCache(java.lang.String cacheID, java.util.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.
 IClusterCacheArea getCacheArea(java.lang.String ID)
          Get an instance of an IClusterCacheArea for the given area ID.
 java.lang.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
 

Method Detail

getUniqueCacheID

public java.lang.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

public ICache getCache(java.lang.String cacheID,
                       java.util.Properties properties)
                throws java.lang.ClassNotFoundException,
                       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).

getCache

public ICache getCache(java.lang.String cacheID)
                throws java.lang.ClassNotFoundException,
                       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.

getCacheArea

public IClusterCacheArea getCacheArea(java.lang.String ID)
                               throws 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:
WcmException - if the cache area couldn't be created.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.