org.jasig.portal
Interface ICacheable

All Known Subinterfaces:

IController, INavigationModel, IPortletAdaptor

All Known Implementing Classes:

AdminNavChannel, CApplet, CError, CGenericXSLT, CGroupsManager, CGroupsManagerServant, Channel, CHeader, CImage, CInlineFrame, CLogin, Controller, CPermissionsManager, CPermissionsManagerServant, CSecureInfo, CSpringPortletAdaptor, CSyndFeed, CWebProxy, DlmIntroChannel, ListModel, MultithreadedCacheableChannelAdapter, MultithreadedCacheableCharacterChannelAdapter, MultithreadedCacheableMimeResponseChannelAdapter, MultithreadedCacheableMimeResponseCharacterChannelAdapter, MultithreadedPrivilegedCacheableChannelAdapter, MultithreadedPrivilegedCacheableCharacterChannelAdapter, MultithreadedPrivilegedCacheableDirectResponseCharacterChannelAdapter, MultithreadedPrivilegedCacheableMimeResponseChannelAdapter, MultithreadedPrivilegedCacheableMimeResponseCharacterChannelAdapter, ServantChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public interface ICacheable

An interface that a cacheable channel must implement.

Version:

$Revision: 19776 $

Author:

Peter Kharchenko pkharchenko@unicon.net

Field Summary

static String	CHANNEL_CACHE_KEY_INSTANCE_SCOPE Deprecated. Suggested value for the channel static data or runtime data parameter specifying intended scope for caching, indicating that the intended scope is per-instance caching.
static String	CHANNEL_CACHE_KEY_SCOPE_PARAM_NAME Deprecated. Suggested name for channel static data or runtime data prameter specifying the intended scope for caching for the so parameterized instance of a channel implementing this interface.
static String	CHANNEL_CACHE_KEY_SYSTEM_SCOPE Deprecated. Suggested value for the channel static data or runtime data parameter specifying intended scope for caching, indicating that the intended scope is system-wide caching.

Method Summary

ChannelCacheKey	generateKey() Deprecated. Requests the channel to generate a key uniquely describing its current state, and a description of key usage.
boolean	isCacheValid(Object validity) Deprecated. Requests the channel to verify validity of the retrieved cache based on the validator object.

Field Detail

CHANNEL_CACHE_KEY_SCOPE_PARAM_NAME

static final String CHANNEL_CACHE_KEY_SCOPE_PARAM_NAME

Deprecated.

Suggested name for channel static data or runtime data prameter specifying the intended scope for caching for the so parameterized instance of a channel implementing this interface. Channels implementing ICacheable are suggested to read ChannelStaticData parameter 'cacheScope' and configure themselves to use the indicated scope.

See Also:

Constant Field Values

CHANNEL_CACHE_KEY_SYSTEM_SCOPE

static final String CHANNEL_CACHE_KEY_SYSTEM_SCOPE

Deprecated.

Suggested value for the channel static data or runtime data parameter specifying intended scope for caching, indicating that the intended scope is system-wide caching.

See Also:

Constant Field Values

CHANNEL_CACHE_KEY_INSTANCE_SCOPE

static final String CHANNEL_CACHE_KEY_INSTANCE_SCOPE

Deprecated.

Suggested value for the channel static data or runtime data parameter specifying intended scope for caching, indicating that the intended scope is per-instance caching.

See Also:

Constant Field Values

Method Detail

generateKey

ChannelCacheKey generateKey()

Deprecated.

Requests the channel to generate a key uniquely describing its current state, and a description of key usage.

isCacheValid

boolean isCacheValid(Object validity)

Deprecated.

Requests the channel to verify validity of the retrieved cache based on the validator object.