Package com.tangosol.coherence.servlet.api23

Class ServletWrapper

  • All Implemented Interfaces:
    javax.servlet.Servlet
    Direct Known Subclasses:
    SingleThreadModelServletWrapper
    public class ServletWrapper
extends Base
implements javax.servlet.Servlet
    An implementation of the Servlet interface that provides a clustered ServletContext.
    Version:
    Coherence 3.4.1
    Author:
    jh 2008.10.15

    • Constructor Detail

      • ServletWrapper

        public ServletWrapper()
        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
        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

      • getServletConfig

        public javax.servlet.ServletConfig getServletConfig()
        Returns a ServletConfig object, which contains initialization and startup parameters for this servlet. The ServletConfig object returned is the one passed to the init method.

        Implementations of this interface are responsible for storing the ServletConfig object so that this method can return it.

        Specified by:
        getServletConfig in interface javax.servlet.Servlet
        Returns:
        the ServletConfig object that initializes this servlet
        See Also:
        init(javax.servlet.ServletConfig)

      • 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
        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
        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

      • 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.Servlet getServlet()
        Get the wrapped Servlet.
        Returns:
        the wrapped Servlet

      • getSessionHelper

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