Class ESIInvalidatorServlet

java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
com.ibm.websphere.servlet.cache.ESIInvalidatorServlet
All Implemented Interfaces:
ExternalCacheAdapter, Serializable, jakarta.servlet.Servlet, jakarta.servlet.ServletConfig

public class ESIInvalidatorServlet extends jakarta.servlet.http.HttpServlet implements ExternalCacheAdapter
See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    This method invalidates all pages from the external cache.
    void
    doPost(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
     
    void
    init(jakarta.servlet.ServletConfig config)
     
    void
    This method invalidates dependency ids that are in the external cache.
    void
    This method invalidates pages that are in the external cache.
    void
    postInvoke(ServletCacheRequest sreq, jakarta.servlet.http.HttpServletResponse sresp)
    This method is invoked after processing a cache hit or miss of an externally cacheable element
    void
    preInvoke(ServletCacheRequest sreq, jakarta.servlet.http.HttpServletResponse sresp)
    This method is invoked before processing a cache hit or miss of an externally cacheable element
    void
    setAddress(String address)
    This method sets the TCP/IP address of the cache adapter
    void
    writePages(Iterator externalCacheEntries)
    This method writes pages to the external cache.

    Methods inherited from class jakarta.servlet.http.HttpServlet

    service

    Methods inherited from class jakarta.servlet.GenericServlet

    destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • ESIInvalidatorServlet

      public ESIInvalidatorServlet()
  • Method Details

    • init

      public void init(jakarta.servlet.ServletConfig config) throws jakarta.servlet.ServletException
      Specified by:
      init in interface jakarta.servlet.Servlet
      Overrides:
      init in class jakarta.servlet.GenericServlet
      Throws:
      jakarta.servlet.ServletException
    • doPost

      public void doPost(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) throws jakarta.servlet.ServletException, IOException
      Throws:
      jakarta.servlet.ServletException
      IOException
    • setAddress

      public void setAddress(String address)
      Description copied from interface: ExternalCacheAdapter
      This method sets the TCP/IP address of the cache adapter
      Specified by:
      setAddress in interface ExternalCacheAdapter
      Parameters:
      address - Address of the cache adapter
    • writePages

      public void writePages(Iterator externalCacheEntries)
      Description copied from interface: ExternalCacheAdapter
      This method writes pages to the external cache.
      Specified by:
      writePages in interface ExternalCacheAdapter
      Parameters:
      externalCacheEntries - The Enumeration of ExternalCacheEntry objects for the pages that are to be cached.
    • invalidatePages

      public void invalidatePages(Iterator urls)
      Description copied from interface: ExternalCacheAdapter
      This method invalidates pages that are in the external cache.
      Specified by:
      invalidatePages in interface ExternalCacheAdapter
      Parameters:
      urls - The List of URLs for the pages that have previously been written to the external cache and need invalidation.
    • invalidateIds

      public void invalidateIds(Iterator ids)
      Description copied from interface: ExternalCacheAdapter
      This method invalidates dependency ids that are in the external cache.
      Specified by:
      invalidateIds in interface ExternalCacheAdapter
      Parameters:
      ids - The Enumeration of dependency ids that must be invalidated
    • preInvoke

      public void preInvoke(ServletCacheRequest sreq, jakarta.servlet.http.HttpServletResponse sresp)
      Description copied from interface: ExternalCacheAdapter
      This method is invoked before processing a cache hit or miss of an externally cacheable element
      Specified by:
      preInvoke in interface ExternalCacheAdapter
      Parameters:
      sreq - The request object being used for this invocation
      sresp - The response object being used for this invocation
    • postInvoke

      public void postInvoke(ServletCacheRequest sreq, jakarta.servlet.http.HttpServletResponse sresp)
      Description copied from interface: ExternalCacheAdapter
      This method is invoked after processing a cache hit or miss of an externally cacheable element
      Specified by:
      postInvoke in interface ExternalCacheAdapter
      Parameters:
      sreq - The request object being used for this invocation
      sresp - The response object being used for this invocation
    • clear

      public void clear()
      Description copied from interface: ExternalCacheAdapter
      This method invalidates all pages from the external cache.
      Specified by:
      clear in interface ExternalCacheAdapter