Package com.tangosol.coherence.servlet.api23

Class HttpServletWrapper

  • All Implemented Interfaces:
    Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
    Direct Known Subclasses:
    SingleThreadModelHttpServletWrapper
    public class HttpServletWrapper
extends javax.servlet.http.HttpServlet
    An implementation of the Servlet interface for HttpServlets that provides for clustered ServletContext and HttpSession objects. This class may be necessary because some app servers cast servlets to HttpServlet, instead of to the Servlet interface.
    Version:
    Coherence 3.4.1
    Author:
    jh 2008.10.14
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      HttpServletWrapper()
      Public default constructor; required by spec.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void destroy()
      Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
      protected String getDescription()
      Returns a string representation of this object's attributes.
      protected javax.servlet.http.HttpServlet getServlet()
      Get the wrapped Servlet.
      String getServletInfo()
      Returns information about the servlet, such as author, version, and copyright.
      protected SessionHelper getSessionHelper()
      Get the SessionHelper.
      void init​(javax.servlet.ServletConfig cfg)
      Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
      void service​(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
      Called by the servlet container to allow the servlet to respond to a request.
      String toString()
      Returns a string representation of the object.

      • Methods inherited from class javax.servlet.http.HttpServlet

        doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

      • Methods inherited from class javax.servlet.GenericServlet

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

    • Constructor Detail

      • HttpServletWrapper

        public HttpServletWrapper()
        Public default constructor; required by spec.

    • Method Detail

      • init

        public void init​(javax.servlet.ServletConfig cfg)
          throws javax.servlet.ServletException
        Called by the servlet container to indicate to a servlet that the servlet is being placed into service.

        The servlet container calls the init method exactly once after instantiating the servlet. The init method must complete successfully before the servlet can receive any requests.

        The servlet container cannot place the servlet into service if the init method

        1. Throws a ServletException
        2. Does not return within a time period defined by the Web server

        Specified by:
        init in interface javax.servlet.Servlet
        Overrides:
        init in class javax.servlet.GenericServlet
        Parameters:
        cfg - a ServletConfig object containing the servlet's configuration and initialization parameters
        Throws:
        javax.servlet.ServletException - if an exception has occurred that interferes with the servlet's normal operation

      • service

        public void service​(javax.servlet.ServletRequest req,
                    javax.servlet.ServletResponse res)
             throws javax.servlet.ServletException,
                    IOException
        Called by the servlet container to allow the servlet to respond to a request.

        This method is only called after the servlet's init() method has completed successfully.

        Servlets typically run inside multithreaded servlet containers that can handle multiple requests concurrently. Developers must be aware to synchronize access to any shared resources such as files, network connections, and as well as the servlet's class and instance variables. More information on multithreaded programming in Java is available in the Java tutorial on multi-threaded programming.

        Specified by:
        service in interface javax.servlet.Servlet
        Overrides:
        service in class javax.servlet.http.HttpServlet
        Parameters:
        req - the ServletRequest object that contains the client's request
        res - the ServletResponse object that contains the servlet's response
        Throws:
        javax.servlet.ServletException - if an exception occurs that interferes with the servlet's normal operation
        IOException - if an input or output exception occurs

      • getServletInfo

        public String getServletInfo()
        Returns information about the servlet, such as author, version, and copyright.

        The string that this method returns should be plain text and not markup of any kind (such as HTML, XML, etc.).

        Specified by:
        getServletInfo in interface javax.servlet.Servlet
        Overrides:
        getServletInfo in class javax.servlet.GenericServlet
        Returns:
        a String containing servlet information

      • destroy

        public void destroy()
        Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. This method is only called once all threads within the servlet's service method have exited or after a timeout period has passed. After the servlet container calls this method, it will not call the service method again on this servlet.

        This method gives the servlet an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the servlet's current state in memory.

        Specified by:
        destroy in interface javax.servlet.Servlet
        Overrides:
        destroy in class javax.servlet.GenericServlet

      • toString

        public String toString()
        Returns a string representation of the object.
        Overrides:
        toString in class Object
        Returns:
        a string representation of the object

      • getDescription

        protected String getDescription()
        Returns a string representation of this object's attributes.
        Returns:
        a string representation of this object's attributes

      • getServlet

        protected javax.servlet.http.HttpServlet getServlet()
        Get the wrapped Servlet.
        Returns:
        the wrapped Servlet

      • getSessionHelper

        protected SessionHelper getSessionHelper()
        Get the SessionHelper.
        Returns:
        the SessionHelper for this app