Module cloud.piranha.core.api
Package cloud.piranha.core.api

Interface ServletEnvironment

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

  • Nested Class Summary

    Nested classes/interfaces inherited from interface jakarta.servlet.Registration

    jakarta.servlet.Registration.Dynamic

    Nested classes/interfaces inherited from interface jakarta.servlet.ServletRegistration

    jakarta.servlet.ServletRegistration.Dynamic

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    UNAVAILABLE
    Defines the UNAVAILABLE constant.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getLoadOnStartup()
    Returns the load on startup.
    jakarta.servlet.MultipartConfigElement
    getMultipartConfig()
    Returns the multi-part config.
    jakarta.servlet.Servlet
    getServlet()
    Returns the servlet.
    Class<? extends jakarta.servlet.Servlet>
    getServletClass()
    Returns the servlet class.
    int
    getStatus()
    Returns the status.
    Throwable
    getUnavailableException()
    The exception that caused this servlet to become unavailable
    WebApplication
    getWebApplication()
    Returns the web application.
    boolean
    isAsyncSupported()
    Is async supported.
    void
    setClassName(String className)
    Set the class name.
    void
    setServlet(jakarta.servlet.Servlet servlet)
    Set the servlet.
    void
    setStatus(int status)
    Set the status.
    void
    setUnavailableException(Throwable unavailableException)
    Sets the exception that caused this servlet to become unavailable

    Methods inherited from interface jakarta.servlet.Registration

    getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters

    Methods inherited from interface jakarta.servlet.Registration.Dynamic

    setAsyncSupported

    Methods inherited from interface jakarta.servlet.ServletConfig

    getInitParameter, getInitParameterNames, getServletContext, getServletName

    Methods inherited from interface jakarta.servlet.ServletRegistration

    addMapping, getMappings, getRunAsRole

    Methods inherited from interface jakarta.servlet.ServletRegistration.Dynamic

    setLoadOnStartup, setMultipartConfig, setRunAsRole, setServletSecurity

  • Field Details

    • UNAVAILABLE

      static final int UNAVAILABLE
      Defines the UNAVAILABLE constant.
      See Also:

  • Method Details

    • getLoadOnStartup

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

    • getMultipartConfig

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

    • getServlet

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

    • getServletClass

      Class<? extends jakarta.servlet.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(jakarta.servlet.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.