Module cloud.piranha.webapp.api
Package cloud.piranha.webapp.api

Interface ServletEnvironment

All Superinterfaces:
Registration, Registration.Dynamic, ServletConfig, ServletRegistration, ServletRegistration.Dynamic
All Known Implementing Classes:
DefaultServletEnvironment
public interface ServletEnvironment extends ServletRegistration.Dynamic, ServletConfig
The environment for a Servlet.
Author:
Manfred Riem ([email protected])

  • Field Details

    • UNAVAILABLE

      static final int UNAVAILABLE
      Defines the UNAVAILABLE constant.
      See Also:
      Constant Field Values

  • Method Details

    • getLoadOnStartup

      int getLoadOnStartup()
      Returns the load on startup.
      Returns:
      the load on startup

    • getMultipartConfig

      MultipartConfigElement getMultipartConfig()
      Returns the multi-part config.
      Returns:
      the multi-part config

    • getServlet

      Servlet getServlet()
      Returns the servlet.
      Returns:
      the servlet

    • getServletClass

      Class<? extends Servlet> getServletClass()
      Returns the servlet class.
      Returns:
      the servlet class

    • getStatus

      int getStatus()
      Returns the status.
      Returns:
      the status

    • getWebApplication

      WebApplication getWebApplication()
      Returns the web application.
      Returns:
      the web application

    • isAsyncSupported

      boolean isAsyncSupported()
      Is async supported.
      Returns:
      true if it is, false otherwise.

    • setClassName

      void setClassName​(String className)
      Set the class name.
      Parameters:
      className - the class name.

    • setServlet

      void setServlet​(Servlet servlet)
      Set the servlet.
      Parameters:
      servlet - the servlet.

    • setStatus

      void setStatus​(int status)
      Set the status.
      Parameters:
      status - the status.

    • getUnavailableException

      Throwable getUnavailableException()
      The exception that caused this servlet to become unavailable
      Returns:
      the exception.

    • setUnavailableException

      void setUnavailableException​(Throwable unavailableException)
      Sets the exception that caused this servlet to become unavailable
      Parameters:
      unavailableException - the unavailable exception.