IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.servlet.cache
Interface CacheableServlet

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
CacheableJspPage

public interface CacheableServlet
extends java.io.Serializable

This interface identifies cacheable servlets to the fragment cache. The cache will call the getId() and getSharingPolicy() methods to obtain the caching metadata for a given execution of the servlet.


Method Summary
 java.lang.String getId(javax.servlet.http.HttpServletRequest request)
          This executes the algorithm to compute the cache id.
 int getSharingPolicy(javax.servlet.http.HttpServletRequest request)
          This returns the sharing policy for this cache entry.
 

Method Detail

getId

java.lang.String getId(javax.servlet.http.HttpServletRequest request)
This executes the algorithm to compute the cache id.

Parameters:
request - The HTTP request object.
Returns:
The cache id. A null indicates that the servlet should not be cached.

getSharingPolicy

int getSharingPolicy(javax.servlet.http.HttpServletRequest request)
This returns the sharing policy for this cache entry. See com.ibm.websphere.servlet.cache.EntryInfo for possible values.

Parameters:
request - The HTTP request object.
Returns:
The sharing policy

IBM WebSphere Application ServerTM
Release 8