---

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:

• 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
java.lang.String	getExternalCacheGroupId()           This gets the externalCacheGroupId variable.
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.
void	setExternalCacheGroupId(java.lang.String externalCacheGroupId)           This sets the externalCacheGroupId 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.

 

Methods inherited from interface com.ibm.websphere.cache.EntryInfo

addDataId, addTemplate, getDataIds, getExpirationTime, getId, getIdObject, getPersistToDisk, getPriority, getSharingPolicy, getTemplate, getTemplates, getTimeLimit, isBatchEnabled, isNotShared, isSharedPull, isSharedPush, setBatchEnabled, setExpirationTime, setId, setPersistToDisk, setPriority, setSharingPolicy, setTimeLimit

 

Method Detail

getExternalCacheGroupId

public java.lang.String getExternalCacheGroupId()

This gets the externalCacheGroupId variable.

Returns:

The externalCacheGroupId.

---

setExternalCacheGroupId

public void setExternalCacheGroupId(java.lang.String externalCacheGroupId)

This sets the externalCacheGroupId variable.

Parameters:

externalCacheGroupId - The externalCacheGroupId.

---

wasExternalCacheGroupIdSet

public boolean wasExternalCacheGroupIdSet()

This indicates whether the client set the external cache group id in this FragmentInfo.

Returns:

True implies it was set.

---

setStoreAttributes

public 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

public 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

public 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

public boolean getStoreCookies()

This indicates whether or not cookies are being saved with the servlet response.

Returns:

boolean true means that cookies will be saved

---

---

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.