HttpJspBase (Apache Tomcat 8.5.57 API Documentation)

org.apache.jasper.runtime

## Class HttpJspBase

- java.lang.Object
- - javax.servlet.GenericServlet
  - - javax.servlet.http.HttpServlet
    - - org.apache.jasper.runtime.HttpJspBase

- All Implemented Interfaces:
    Serializable, HttpJspPage, JspPage, Servlet, ServletConfig

      public abstract class HttpJspBase
      extends HttpServlet
      implements HttpJspPage

  This is the super class of all JSP-generated servlets.
  Author:
    Anil K. Vijendran
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `HttpJspBase()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `_jspDestroy()`
    `void` | `_jspInit()`
    `abstract void` | `_jspService(HttpServletRequest request, HttpServletResponse response)` The _jspService()method corresponds to the body of the JSP page.
    `void` | `destroy()` Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
    `String` | `getServletInfo()` Returns information about the servlet, such as author, version, and copyright.
    `void` | `init(ServletConfig config)` Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
    `void` | `jspDestroy()` The jspDestroy() method is invoked when the JSP page is about to be destroyed.
    `void` | `jspInit()` The jspInit() method is invoked when the JSP page is initialized.
    `void` | `service(HttpServletRequest request, HttpServletResponse response)` Entry point into service.

    - ### 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`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface javax.servlet.Servlet

      `getServletConfig, service`

- - ### Constructor Detail

    - #### HttpJspBase

          protected HttpJspBase()

  - ### Method Detail

    - #### init

          public final void init(ServletConfig config)
                          throws ServletException

      Description copied from class: `javax.servlet.GenericServlet`
      Called by the servlet container to indicate to a servlet that the servlet is being placed into service. See `Servlet.init(javax.servlet.ServletConfig)`.

      This implementation stores the `ServletConfig` object it receives from the servlet container for later use. When overriding this form of the method, call `super.init(config)`.

      Specified by:
        `init` in interface `Servlet`
      Overrides:
        `init` in class `GenericServlet`
      Parameters:
        `config` - the `ServletConfig` object that contains configuration information for this servlet
      Throws:
        `ServletException` - if an exception occurs that interrupts the servlet's normal operation
      See Also:
        `UnavailableException`

    - #### getServletInfo

          public String getServletInfo()

      Description copied from class: `javax.servlet.GenericServlet`
      Returns information about the servlet, such as author, version, and copyright. By default, this method returns an empty string. Override this method to have it return a meaningful value. See `Servlet.getServletInfo()`.
      Specified by:
        `getServletInfo` in interface `Servlet`
      Overrides:
        `getServletInfo` in class `GenericServlet`
      Returns:
        String information about this servlet, by default an empty string

    - #### destroy

          public final void destroy()

      Description copied from class: `javax.servlet.GenericServlet`
      Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. See `Servlet.destroy()`.
      Specified by:
        `destroy` in interface `Servlet`
      Overrides:
        `destroy` in class `GenericServlet`

    - #### service

          public final void service(HttpServletRequest request,
                     HttpServletResponse response)
                             throws ServletException,
                                    IOException

      Entry point into service.
      Overrides:
        `service` in class `HttpServlet`
      Parameters:
        `request` - the `HttpServletRequest` object that contains the request the client made of the servlet
        `response` - the `HttpServletResponse` object that contains the response the servlet returns to the client
      Throws:
        `ServletException` - if the HTTP request cannot be handled
        `IOException` - if an input or output error occurs while the servlet is handling the HTTP request
      See Also:
        `Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)`

    - #### jspInit

          public void jspInit()

      Description copied from interface: `javax.servlet.jsp.JspPage`
      The jspInit() method is invoked when the JSP page is initialized. It is the responsibility of the JSP implementation (and of the class mentioned by the extends attribute, if present) that at this point invocations to the getServletConfig() method will return the desired value. A JSP page can override this method by including a definition for it in a declaration element. A JSP page should redefine the init() method from Servlet.
      Specified by:
        `jspInit` in interface `JspPage`

    - #### _jspInit

          public void _jspInit()

    - #### jspDestroy

          public void jspDestroy()

      Description copied from interface: `javax.servlet.jsp.JspPage`
      The jspDestroy() method is invoked when the JSP page is about to be destroyed. A JSP page can override this method by including a definition for it in a declaration element. A JSP page should redefine the destroy() method from Servlet.
      Specified by:
        `jspDestroy` in interface `JspPage`

    - #### _jspDestroy

          protected void _jspDestroy()

    - #### _jspService

          public abstract void _jspService(HttpServletRequest request,
                         HttpServletResponse response)
                                    throws ServletException,
                                           IOException

      Description copied from interface: `javax.servlet.jsp.HttpJspPage`
      The _jspService()method corresponds to the body of the JSP page. This method is defined automatically by the JSP container and should never be defined by the JSP page author.

      If a superclass is specified using the extends attribute, that superclass may choose to perform some actions in its service() method before or after calling the _jspService() method. See using the extends attribute in the JSP_Engine chapter of the JSP specification.

      Specified by:
        `_jspService` in interface `HttpJspPage`
      Parameters:
        `request` - Provides client request information to the JSP.
        `response` - Assists the JSP in sending a response to the client.
      Throws:
        `ServletException` - Thrown if an error occurred during the processing of the JSP and that the container should take appropriate action to clean up the request.
        `IOException` - Thrown if an error occurred while writing the response for this page.

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.