| java.lang.Object org.jasig.portal.ChannelCacheKey
ChannelCacheKey | public class ChannelCacheKey (Code) | | A general channel cache key class. The class includes the key iteslf, as well as key properties.
author: Peter Kharchenko pkharchenko@interactivebusiness.com version: $Revision: 36690 $ |
Method Summary | |
public String | getKey() Returns a key uniqly describing the channel state. | public int | getKeyScope() Returns a specification of the scope in which the cache to be used. | public Object | getKeyValidity() Returns an object that can be used by the channel to verify cache validity.
In general, cache validators allow to strengthen the key, by allowing for non-exact
checks. | public void | setKey(String key) | public void | setKeyScope(int scope) | public void | setKeyValidity(Object validity) |
INSTANCE_KEY_SCOPE | final public static int INSTANCE_KEY_SCOPE(Code) | | Specifies that the cache is specific to the instance of the channel that generated it.
This is the default scope. This scope should be used if the screen rendering at the
current state involves any user-specific information.
|
SYSTEM_KEY_SCOPE | final public static int SYSTEM_KEY_SCOPE(Code) | | Specifies that the cache is accessable by all instances of that channel class.
In construction a session-wide key, make sure to include static data information in there.
|
ChannelCacheKey | public ChannelCacheKey()(Code) | | |
getKey | public String getKey()(Code) | | Returns a key uniqly describing the channel state.
|
getKeyScope | public int getKeyScope()(Code) | | Returns a specification of the scope in which the cache to be used.
Possible values are : INSTANCE_KEY_SCOPE and SYSTEM_KEY_SCOPE.
|
getKeyValidity | public Object getKeyValidity()(Code) | | Returns an object that can be used by the channel to verify cache validity.
In general, cache validators allow to strengthen the key, by allowing for non-exact
checks. A good example is a cache validity condition involving expiration time-stamp.
|
setKeyScope | public void setKeyScope(int scope)(Code) | | |
setKeyValidity | public void setKeyValidity(Object validity)(Code) | | |
|
|