public interface FragmentInfo extends EntryInfo
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:
NOT_SHARED, SHARED_PULL, SHARED_PUSH, SHARED_PUSH_PULL
Modifier and Type | Method and Description |
---|---|
boolean |
getConsumeSubfragments()
This indicates whether or not the parent is consuming child fragments in its cache entry.
|
java.lang.String |
getExternalCacheGroupId()
This gets the externalCacheGroupId variable.
|
java.lang.String |
getInstanceName()
This method returns the name of the cache-instance that will be used to store this fragment.
|
boolean |
getStoreAttributes()
This indicates whether or not request attributes are being saved with the
servlet response.
|
boolean |
getStoreCookies()
This indicates whether or not cookies are being saved with the
servlet response.
|
boolean |
isIgnoreGetPost()
This indicates whether or not the requestType will automatically be appended to the cache-id
|
void |
setConsumeSubfragments(boolean b)
This sets the consume-subfragments variable.
|
void |
setExternalCacheGroupId(java.lang.String externalCacheGroupId)
This sets the externalCacheGroupId variable.
|
void |
setIgnoreGetPost(boolean b)
This sets the ignore-get-post variable.
|
void |
setStoreAttributes(boolean b)
This sets the store-attributes variable.
|
void |
setStoreCookies(boolean b)
This sets the store-cookies variable.
|
boolean |
wasExternalCacheGroupIdSet()
This indicates whether the client set the external cache group id
in this FragmentInfo.
|
addAlias, addDataId, addTemplate, getAliasList, getCacheType, getDataIds, getExpirationTime, getId, getIdObject, getInactivity, getPersistToDisk, getPriority, getSharingPolicy, getTemplate, getTemplates, getTimeLimit, getUserMetaData, getValidatorExpirationTime, isBatchEnabled, isNotShared, isSharedPull, isSharedPush, setBatchEnabled, setExpirationTime, setId, setInactivity, setPersistToDisk, setPriority, setSharingPolicy, setTimeLimit, setUserMetaData
java.lang.String getExternalCacheGroupId()
void setExternalCacheGroupId(java.lang.String externalCacheGroupId)
externalCacheGroupId
- The externalCacheGroupId.boolean wasExternalCacheGroupIdSet()
void setStoreAttributes(boolean b)
b
- a boolean that indicates whether or not attributes should be
saved.boolean getStoreAttributes()
void setStoreCookies(boolean b)
b
- a boolean that indicates whether or not cookies should be
saved.boolean getStoreCookies()
void setConsumeSubfragments(boolean b)
b
- a boolean that indicates whether or not the parent will
consume-subfragmentsboolean getConsumeSubfragments()
void setIgnoreGetPost(boolean b)
b
- a boolean that indicates whether or not to append the requestType to the cache-id
saved.boolean isIgnoreGetPost()
java.lang.String getInstanceName()