com.ibm.websphere.servlet.cache
Interface FragmentInfo

All Superinterfaces:
EntryInfo

public interface FragmentInfo
extends EntryInfo

FragmentInfo extends the EntryInfo interface to add variables unique to externally cacheable pages.

EntryInfo and FragmentInfo Objects are attached to each cache entry. IdGenerators and MetaDataGenerators use these interfaces to define the caching metadata for an entry.

Typically a Id/MetaDataGenerator will get an entry's FragmentInfo object from the ServletCacheRequest, and use the object's set methods to configure that entry.

The following is a summary of the caching metadata for a CacheEntry:


Fields inherited from interface com.ibm.websphere.servlet.cache.EntryInfo
NOT_SHARED, SHARED_PULL, SHARED_PUSH
 
Method Summary
 java.lang.String getExternalCacheGroupId()
          This gets the externalCacheGroupId variable.
 void setExternalCacheGroupId(java.lang.String externalCacheGroupId)
          This sets the externalCacheGroupId variable.
 boolean wasExternalCacheGroupIdSet()
          This indicates whether the client set the external cache group id in this FragmentInfo.
 
Methods inherited from interface com.ibm.websphere.servlet.cache.EntryInfo
addDataId, getDataIds, getExpirationTime, getId, getPriority, getSharingPolicy, getTemplates, getTimeLimit, isNotShared, isSharedPull, isSharedPush, setExpirationTime, setPriority, setTimeLimit
 

Method Detail

getExternalCacheGroupId

public java.lang.String getExternalCacheGroupId()
This gets the externalCacheGroupId variable.
Returns:
The externalCacheGroupId variable.

setExternalCacheGroupId

public void setExternalCacheGroupId(java.lang.String externalCacheGroupId)
This sets the externalCacheGroupId variable.
Parameters:
externalCacheGroupId - The externalCacheGroupId variable.

wasExternalCacheGroupIdSet

public boolean wasExternalCacheGroupIdSet()
This indicates whether the client set the external cache group id in this FragmentInfo.
Returns:
True implies it was set.