com.sap.portal.cache.api

Interface ICacheManager

All Superinterfaces:

IService

public interface ICacheManager
extends IService

Represents the service that enables you to perform various cache actions on any cache handler, which extends AbstractCacheHandler

See Also:

CacheAction, ApplyActionException

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY The service key

Method Summary

Modifier and Type	Method and Description
void	applyAction(String cacheID, CacheAction cacheAction, boolean cluster) Performs the specified cache action on the specified cache
String[]	getAllCacheIDs() Retrieves an array of all registered cache IDs
boolean	isEnabled(String cacheID) Indicates whether the specified cache is enabled
String[]	setEnabled(boolean enable) Enables or disables all registered caches

Methods inherited from interface com.sapportals.portal.prt.service.IService

afterInit, configure, destroy, getContext, getKey, init, release

Field Detail

KEY

static final String KEY

The service key

See Also:

Constant Field Values

Method Detail

getAllCacheIDs

String[] getAllCacheIDs()

Retrieves an array of all registered cache IDs

Returns:

a String array of all registered caches IDs

setEnabled

String[] setEnabled(boolean enable)

Enables or disables all registered caches

Parameters:

enable - A boolean value that indicates whether the caches should be enabled or disabled

Returns:

a String array of cache IDs on which the enable/disable action has failed

isEnabled

boolean isEnabled(String cacheID)

Indicates whether the specified cache is enabled

Parameters:

cacheID - The ID of the cache to be indicated as enabled or disabled

Returns:

true if given cache is enabled

applyAction

void applyAction(String cacheID,
                 CacheAction cacheAction,
                 boolean cluster)
          throws ApplyActionException

Performs the specified cache action on the specified cache

Parameters:

cacheID - The ID of the cache on which to apply the action

cacheAction - - Specific cache action object to be applied

cluster - A boolean value that indicates whether to perform the action on entire cluster

Throws:

ApplyActionException - - Apply Action Exception