com.ibm.websphere.servlet.cache
Class ESIInvalidatorServlet

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

public class ESIInvalidatorServlet
extends javax.servlet.http.HttpServlet
implements ExternalCacheAdapter

See Also:
Serialized Form

Constructor Summary
ESIInvalidatorServlet()
           
 
Method Summary
 void clear()
          This method invalidates all pages from the external cache.
 void doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void init(javax.servlet.ServletConfig config)
           
 void invalidateIds(java.util.Iterator ids)
          This method invalidates dependency ids that are in the external cache.
 void invalidatePages(java.util.Iterator urls)
          This method invalidates pages that are in the external cache.
 void postInvoke(ServletCacheRequest sreq, javax.servlet.http.HttpServletResponse sresp)
          This method is invoked after processing a cache hit or miss of an externally cacheable element
 void preInvoke(ServletCacheRequest sreq, javax.servlet.http.HttpServletResponse sresp)
          This method is invoked before processing a cache hit or miss of an externally cacheable element
 void setAddress(java.lang.String address)
          This method sets the TCP/IP address of the cache adapter
 void writePages(java.util.Iterator externalCacheEntries)
          This method writes pages to the external cache.
 
Methods inherited from class javax.servlet.http.HttpServlet
service
 
Methods inherited from class javax.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 Detail

ESIInvalidatorServlet

public ESIInvalidatorServlet()
Method Detail

init

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

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   java.io.IOException
Overrides:
doPost in class javax.servlet.http.HttpServlet
Throws:
javax.servlet.ServletException
java.io.IOException

setAddress

public void setAddress(java.lang.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(java.util.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(java.util.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(java.util.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,
                      javax.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,
                       javax.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