Package org.glassfish.jersey.servlet.internal.spi

Class NoOpServletContainerProvider

java.lang.Object
org.glassfish.jersey.servlet.internal.spi.NoOpServletContainerProvider
All Implemented Interfaces:
ExtendedServletContainerProvider, ServletContainerProvider
public class NoOpServletContainerProvider extends Object implements ExtendedServletContainerProvider
Basic ExtendedServletContainerProvider that provides dummy no-op method implementation. It should be convenient to extend if you only need to implement a subset of the original SPI methods.
Author:
Jakub Podlesak

  • Field Details

    • HTTP_SERVLET_REQUEST_TYPE

      public final Type HTTP_SERVLET_REQUEST_TYPE

    • HTTP_SERVLET_RESPONSE_TYPE

      public final Type HTTP_SERVLET_RESPONSE_TYPE

  • Constructor Details

    • NoOpServletContainerProvider

      public NoOpServletContainerProvider()

  • Method Details

    • preInit

      public void preInit(jakarta.servlet.ServletContext servletContext, Set<Class<?>> classes) throws jakarta.servlet.ServletException
      Description copied from interface: ServletContainerProvider
      Do your pre-initialization job before Jersey starts its servlet initialization. It is allowed to configure ServletContext or add/remove servlet registrations. Parameter servletNames contains list of names of currently registered Jersey servlets.
      Specified by:
      preInit in interface ServletContainerProvider
      Parameters:
      servletContext - the ServletContext of the JAX-RS/Jersey web application that is being started.
      classes - the mutable Set of application classes that extend Application, implement, or have been annotated with the class types Path, Provider or ApplicationPath. May be empty, never null.
      Throws:
      jakarta.servlet.ServletException - if an error has occurred. jakarta.servlet.ServletContainerInitializer.onStartup is interrupted.

    • postInit

      public void postInit(jakarta.servlet.ServletContext servletContext, Set<Class<?>> classes, Set<String> servletNames)
      Description copied from interface: ServletContainerProvider
      Do your post-initialization job after Jersey finished its servlet initialization. It is allowed to configure ServletContext or add/remove servlet registrations. Parameter servletNames contains list of names of currently registered Jersey servlets.
      Specified by:
      postInit in interface ServletContainerProvider
      Parameters:
      servletContext - the ServletContext of the JAX-RS/Jersey web application that is being started.
      classes - the mutable Set of application classes that extend Application, implement, or have been annotated with the class types Path, Provider or ApplicationPath. May be empty, never null.
      servletNames - the Immutable set of Jersey's ServletContainer names. May be empty, never null.

    • onRegister

      public void onRegister(jakarta.servlet.ServletContext servletContext, Set<String> servletNames) throws jakarta.servlet.ServletException
      Description copied from interface: ServletContainerProvider
      Notifies the provider about all registered Jersey servlets by its names. It is allowed to configure ServletContext. Do not add/remove any servlet registrations here. Parameter servletNames contains list of names of registered Jersey servlets. Currently it is ServletContainer or org.glassfish.jersey.servlet.portability.PortableServletContainer servlets. It does not matter servlet container is configured in web.xml, by org.glassfish.jersey.servlet.init.JerseyServletContainerInitializer or by customer direct Servlet API calls.
      Specified by:
      onRegister in interface ServletContainerProvider
      Parameters:
      servletContext - the ServletContext of the JAX-RS/Jersey web application that is being started.
      servletNames - the Immutable set of Jersey's ServletContainer names. May be empty, never null.
      Throws:
      jakarta.servlet.ServletException - if an error has occurred. jakarta.servlet.ServletContainerInitializer.onStartup is interrupted.

    • configure

      public void configure(ResourceConfig resourceConfig) throws jakarta.servlet.ServletException
      Description copied from interface: ServletContainerProvider
      This method is called for each ServletContainer instance initialization, i.e. during WebComponent initialization. The method is also called during ServletContainer.reload() or ServletContainer.reload(ResourceConfig) methods invocation. It does not matter servlet container is configured in web.xml, by org.glassfish.jersey.servlet.init.JerseyServletContainerInitializer or by customer direct Servlet API calls.
      Specified by:
      configure in interface ServletContainerProvider
      Parameters:
      resourceConfig - Jersey application configuration.
      Throws:
      jakarta.servlet.ServletException - if an error has occurred. org.glassfish.jersey.servlet.WebComponent construction is interrupted.

    • bindsServletRequestResponse

      public boolean bindsServletRequestResponse()
      Description copied from interface: ExtendedServletContainerProvider
      Used by Jersey runtime to tell if the extension covers HTTP Servlet request response handling with respect to underlying injection manager. Return true, if your implementation configures HK2 bindings for HttpServletRequest and HttpServletResponse in ServletContainerProvider.configure(ResourceConfig) method and also provides a RequestScopedInitializer implementation via ExtendedServletContainerProvider.getRequestScopedInitializerProvider().
      Specified by:
      bindsServletRequestResponse in interface ExtendedServletContainerProvider
      Returns:
      true if the extension fully covers HTTP request/response handling.

    • getRequestScopedInitializerProvider

      public RequestScopedInitializerProvider getRequestScopedInitializerProvider()
      Description copied from interface: ExtendedServletContainerProvider
      Give me a RequestScopedInitializerProvider instance, that will be utilized at runtime to set the actual HTTP Servlet request and response. The provider returned will be used at runtime for every and each incoming request so that the actual request/response instances could be made accessible from Jersey injection manager.
      Specified by:
      getRequestScopedInitializerProvider in interface ExtendedServletContainerProvider
      Returns:
      request scoped initializer provider.