Package com.ibm.websphere.servlet.cache

Interface CacheableServlet

All Superinterfaces:
Serializable
All Known Implementing Classes:
CacheableJspPage
public interface CacheableServlet extends 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

    Modifier and Type
    Method
    Description
    String
    getId(jakarta.servlet.http.HttpServletRequest request)
    This executes the algorithm to compute the cache id.
    int
    getSharingPolicy(jakarta.servlet.http.HttpServletRequest request)
    This returns the sharing policy for this cache entry.

  • Method Details

    • getId

      String getId(jakarta.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(jakarta.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