com.webmethods.portal.service.cache

Interface ICacheManager

All Superinterfaces:

IComponent, IComponentProvider, IInitializable, IURIResolver

public interface ICacheManager
extends IComponentProvider

Title: Description: Copyright: Copyright (c) 2000 Company:

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CACHE_ID

Fields inherited from interface com.webmethods.portal.system.IComponentProvider

ATTR_APP_NAME, ATTR_BEG_QUERY, ATTR_END_QUERY, ATTR_MID_QUERY, BIZPOLICY_MANAGER, CACHE_PROVIDER, COMMAND_PROVIDER, COMPONENTS_QUERY, INSTALL_PROVIDER, MECH_PROVIDER, METACONTEXT_PROVIDER, PHASE_PROVIDER, POLICY_PROVIDER, SEARCH_PROVIDER

Method Summary

Modifier and Type	Method and Description
default void	configureCache(String name, Map<String,Object> properties)
ICache	createCache(String factory, String name, int maxSize, boolean isClustered, String phase, Map<String,Object> properties) Creates a cache using the specified factory class name.
void	flushAllCaches(ICacheKey key) calls ICache.flush with given key on all known caches Note that one key implementation won't flush caches that contain a different key implementation
ICache	getCache(int cacheID) get cache by ID Only valid for DB-based caches, otherwise returns null
ICache	getCache(String name) Gets a cached cache.
IMetaContext	getMetaContext() get the standard meta context
void	removeCache(String name) removes an item from the cache.
void	stopThread()

Methods inherited from interface com.webmethods.portal.system.IComponentProvider

exists, getComponent, getComponent, getComponent, getComponentQueryString, getComponents, getDefaultComponent, getLogger, initDeferredWebAppComponents, lookup, registerComponent, reloadComponent, reloadComponent, unregisterComponent, upgradeComponentDataFromBootstrapComponentData

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.system.IURIResolver

acquireURI, acquireURI

Field Detail

MAX_CACHE_ID

static final int MAX_CACHE_ID

See Also:

Constant Field Values

Method Detail

getCache

ICache getCache(String name)

Gets a cached cache. Only caches created thru createCache will show up here.

Parameters:

name -

Returns:

ICache or null if name not found.

getCache

ICache getCache(int cacheID)

get cache by ID Only valid for DB-based caches, otherwise returns null

Parameters:

cacheID -

Returns:

createCache

ICache createCache(String factory,
                   String name,
                   int maxSize,
                   boolean isClustered,
                   String phase,
                   Map<String,Object> properties)
            throws PortalException,
                   InitializationException

Creates a cache using the specified factory class name. Factory class must implement ICacheFactory. Name must be unique.

Parameters:

factory - factory class name

name - name of cache

maxSize - maximum size of in-memory component of cache

isClustered - do you want to gen/rec cluster-wide cache events?

Returns:

new cache.

Throws:

CacheException - if failure to instantiate

PortalException

InitializationException

removeCache

void removeCache(String name)
          throws PortalException

removes an item from the cache. Note that any persisted data is unaffected.

Parameters:

name - cache name

Throws:

PortalException

flushAllCaches

void flushAllCaches(ICacheKey key)

calls ICache.flush with given key on all known caches Note that one key implementation won't flush caches that contain a different key implementation

stopThread

void stopThread()

getMetaContext

IMetaContext getMetaContext()

get the standard meta context

Returns:

configureCache

default void configureCache(String name,
                            Map<String,Object> properties)
                     throws PortalException

Throws:

PortalException