| org.jasig.portal.ICacheable
All known Subclasses: org.jasig.portal.MultithreadedCacheableChannelAdapter, org.jasig.portal.channels.CSecureInfo, org.jasig.portal.channels.CLogin, org.jasig.portal.channels.adminnav.AdminNavChannel, org.jasig.portal.channels.CInlineFrame, org.jasig.portal.layout.dlm.channels.guide.DlmIntroChannel, org.jasig.portal.channels.CHeader, org.jasig.portal.channels.permissionsmanager.CPermissionsManager, org.jasig.portal.channels.groupsmanager.CGroupsManager, org.jasig.portal.channels.webproxy.CWebProxy, org.jasig.portal.channels.CImage, org.jasig.portal.channels.jsp.Channel, org.jasig.portal.channels.CGenericXSLT, org.jasig.portal.channels.CSyndFeed, org.jasig.portal.channels.error.CError, org.jasig.portal.channels.portlet.CPortletAdapter, org.jasig.portal.channels.CApplet, org.jasig.portal.channels.CError, org.jasig.portal.MultithreadedCacheableCharacterChannelAdapter,
| ICacheable | | public interface ICacheable (Code) | | An interface that a cacheable channel must implement.
author:
Peter Kharchenko pkharchenko@unicon.net
version:
$Revision: 36838 $ |
| Field Summary | |
| final public static String | CHANNEL_CACHE_KEY_INSTANCE_SCOPE
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. | | final public static String | CHANNEL_CACHE_KEY_SCOPE_PARAM_NAME
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. | | final public static String | CHANNEL_CACHE_KEY_SYSTEM_SCOPE
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 | |
| public ChannelCacheKey | generateKey()
Requests the channel to generate a key uniquely describing its current state,
and a description of key usage. | | public boolean | isCacheValid(Object validity)
Requests the channel to verify validity of the retrieved cache based on the validator object. |
| CHANNEL_CACHE_KEY_INSTANCE_SCOPE | | final public static String CHANNEL_CACHE_KEY_INSTANCE_SCOPE(Code) | | 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.
|
| CHANNEL_CACHE_KEY_SCOPE_PARAM_NAME | | final public static String CHANNEL_CACHE_KEY_SCOPE_PARAM_NAME(Code) | | 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.
|
| CHANNEL_CACHE_KEY_SYSTEM_SCOPE | | final public static String CHANNEL_CACHE_KEY_SYSTEM_SCOPE(Code) | | 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.
|
| generateKey | | public ChannelCacheKey generateKey()(Code) | | Requests the channel to generate a key uniquely describing its current state,
and a description of key usage.
|
| isCacheValid | | public boolean isCacheValid(Object validity)(Code) | | Requests the channel to verify validity of the retrieved cache based on the validator object.
|
|
|