com.ibm.websphere.servlet.cache
Interface FragmentInfo
All Superinterfaces:
- 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:
- The template. (set internally by WebSphere)
- The id. (set internally by WebSphere with the output of the IdGenerator.getId() method)
- The priority.
- The timeLimit and expirationTime options.
- The dataIds option.
- The external cache group to which this entry will be pushed (FragmentInfo)
Field Summary
Fields inherited from interface com.ibm.websphere.cache.EntryInfo |
---|
NOT_SHARED, SHARED_PULL, SHARED_PUSH, SHARED_PUSH_PULL |
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getConsumeSubfragments()
This indicates whether or not the parent is consuming child fragments in its cache entry.
|
|
getExternalCacheGroupId()
This gets the externalCacheGroupId variable.
|
|
getInstanceName()
This method returns the name of the cache-instance that will be used to store this fragment.
|
|
getStoreAttributes()
This indicates whether or not request attributes are being saved with the
servlet response.
|
|
getStoreCookies()
This indicates whether or not cookies are being saved with the
servlet response.
|
|
isIgnoreGetPost()
This indicates whether or not the requestType will automatically be appended to the cache-id
|
|
setConsumeSubfragments(boolean b)
This sets the consume-subfragments variable.
|
|
setExternalCacheGroupId(java.lang.String externalCacheGroupId)
This sets the externalCacheGroupId variable.
|
|
setIgnoreGetPost(boolean b)
This sets the ignore-get-post variable.
|
|
setStoreAttributes(boolean b)
This sets the store-attributes variable.
|
|
setStoreCookies(boolean b)
This sets the store-cookies variable.
|
|
wasExternalCacheGroupIdSet()
This indicates whether the client set the external cache group id
in this FragmentInfo.
|
Methods inherited from interface com.ibm.websphere.cache.EntryInfo |
---|
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 |
Method Detail
getExternalCacheGroupId
- java.lang.String getExternalCacheGroupId( )
This gets the externalCacheGroupId variable.
Returns:
The externalCacheGroupId.
setExternalCacheGroupId
- void setExternalCacheGroupId(java.lang.String externalCacheGroupId)
This sets the externalCacheGroupId variable.
Parameters:
externalCacheGroupId
- The externalCacheGroupId. wasExternalCacheGroupIdSet
- boolean wasExternalCacheGroupIdSet( )
This indicates whether the client set the external cache group id
in this FragmentInfo.
Returns:
True implies it was set.
setStoreAttributes
- void setStoreAttributes(boolean b)
This sets the store-attributes variable. If storeAttributes is set
to false then the request attributes will not be saved with the
servlet response. The default value is true.
Parameters:
b
- a boolean that indicates whether or not attributes should be
saved. getStoreAttributes
- boolean getStoreAttributes()
This indicates whether or not request attributes are being saved with the
servlet response.
Returns:
boolean true means that attributes will be saved
setStoreCookies
- void setStoreCookies(boolean b)
This sets the store-cookies variable. If storeCookies is set
to false then the cookies will not be saved with the
servlet response. The default value is true.
Parameters:
b
- a boolean that indicates whether or not cookies should be
saved. getStoreCookies
- boolean getStoreCookies()
This indicates whether or not cookies are being saved with the
servlet response.
Returns:
boolean true means that cookies will be saved
setConsumeSubfragments
- void setConsumeSubfragments(boolean b)
This sets the consume-subfragments variable. If consumeSubfragments is set
to true then the parent will consume child fragments in its cache entry.
The default value is false.
Parameters:
b
- a boolean that indicates whether or not the parent will
consume-subfragments getConsumeSubfragments
- boolean getConsumeSubfragments( )
This indicates whether or not the parent is consuming child fragments in its cache entry.
Returns:
boolean true means that the parent will consume child fragments
setIgnoreGetPost
- void setIgnoreGetPost(boolean b)
This sets the ignore-get-post variable. If ignore-get-post is set
to true then the requestType will automatically be appended to the cache-id
Parameters:
b
- a boolean that indicates whether or not to append the requestType to the cache-id
saved. isIgnoreGetPost
- boolean isIgnoreGetPost()
This indicates whether or not the requestType will automatically be appended to the cache-id
Returns:
boolean true means that the requestType will not be appended to the cache-id
getInstanceName
- java.lang.String getInstanceName( )
This method returns the name of the cache-instance that will be used to store this fragment.
Returns:
a String specifying the cache-instance name