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

Interface ServletContainerProvider

All Known Subinterfaces:

ExtendedServletContainerProvider

All Known Implementing Classes:

NoOpServletContainerProvider

public interface ServletContainerProvider

This is internal Jersey SPI to hook to Jersey servlet initialization process driven by org.glassfish.jersey.servlet.init.JerseyServletContainerInitializer. The provider implementation class is registered via META-INF/services.

Since:

2.4.1

Author:

Libor Kramolis

Method Summary

Modifier and Type	Method	Description
void	configure(ResourceConfig resourceConfig)	This method is called for each ServletContainer instance initialization, i.e.
void	onRegister(jakarta.servlet.ServletContext servletContext, Set<String> servletNames)	Notifies the provider about all registered Jersey servlets by its names.
void	postInit(jakarta.servlet.ServletContext servletContext, Set<Class<?>> classes, Set<String> servletNames)	Do your post-initialization job after Jersey finished its servlet initialization.
void	preInit(jakarta.servlet.ServletContext servletContext, Set<Class<?>> classes)	Do your pre-initialization job before Jersey starts its servlet initialization.

Method Details

preInit

void preInit(jakarta.servlet.ServletContext servletContext,
 Set<Class<?>> classes)
      throws jakarta.servlet.ServletException

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.

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

void postInit(jakarta.servlet.ServletContext servletContext,
 Set<Class<?>> classes,
 Set<String> servletNames)
       throws jakarta.servlet.ServletException

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.

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.

Throws:

jakarta.servlet.ServletException - if an error has occurred. jakarta.servlet.ServletContainerInitializer.onStartup is interrupted.

onRegister

void onRegister(jakarta.servlet.ServletContext servletContext,
 Set<String> servletNames)
         throws jakarta.servlet.ServletException

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.

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

void configure(ResourceConfig resourceConfig)
        throws jakarta.servlet.ServletException

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.

Parameters:

resourceConfig - Jersey application configuration.

Throws:

jakarta.servlet.ServletException - if an error has occurred. org.glassfish.jersey.servlet.WebComponent construction is interrupted.