org.glassfish.jersey.servlet.internal.spi

Interface ServletContainerProvider

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.1

Author:

Libor Kramolis (libor.kramolis at oracle.com)

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(ResourceConfig resourceConfig) This method is called for each ServletContainer instance initialization, i.e.
void	init(javax.servlet.ServletContext servletContext) Do your initialization job before Jersey starts its servlet initialization.
void	onRegister(javax.servlet.ServletContext servletContext, String... servletNames) Notifies the provider about all registered Jersey servlets by its names.

Method Detail

init

void init(javax.servlet.ServletContext servletContext)
          throws javax.servlet.ServletException

Do your initialization job before Jersey starts its servlet initialization.

Parameters:

servletContext - the ServletContext of the web application that is being started

Throws:

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

configure

void configure(ResourceConfig resourceConfig)
               throws javax.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 or by org.glassfish.jersey.servlet.init.JerseyServletContainerInitializer.

Parameters:

resourceConfig - Jersey application configuration.

Throws:

javax.servlet.ServletException - if an error has occurred.

onRegister

void onRegister(javax.servlet.ServletContext servletContext,
              String... servletNames)
                throws javax.servlet.ServletException

Notifies the provider about all registered Jersey servlets by its names. Currently it provides names of registered ServletContainer or org.glassfish.jersey.servlet.portability.PortableServletContainer servlets. It does not matter servlet container is configured in web.xml or by org.glassfish.jersey.servlet.init.JerseyServletContainerInitializer.

Parameters:

servletContext - the ServletContext of the JAX-RS/Jersey web application that is being started.

servletNames - Jersey's ServletContainer names. May be empty.

Throws:

javax.servlet.ServletException - if an error has occurred.