org.springframework.boot.web.servlet

Interface ServletContextInitializer

  • All Known Implementing Classes:
    DelegatingFilterProxyRegistrationBean, DynamicRegistrationBean, FilterRegistrationBean, RegistrationBean, ServletListenerRegistrationBean, ServletRegistrationBean
    Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

    @FunctionalInterface
public interface ServletContextInitializer
    Interface used to configure a Servlet 3.0+ context programmatically. Unlike WebApplicationInitializer, classes that implement this interface (and do not implement WebApplicationInitializer) will not be detected by SpringServletContainerInitializer and hence will not be automatically bootstrapped by the Servlet container.

    This interface is primarily designed to allow ServletContextInitializers to be managed by Spring and not the Servlet container.

    For configuration examples see WebApplicationInitializer.

    Since:
    1.4.0
    Author:
    Phillip Webb
    See Also:
    WebApplicationInitializer

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void onStartup(javax.servlet.ServletContext servletContext)
      Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initialization.

    • Method Detail

      • onStartup

        void onStartup(javax.servlet.ServletContext servletContext)
        throws javax.servlet.ServletException
        Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initialization.
        Parameters:
        servletContext - the ServletContext to initialize
        Throws:
        javax.servlet.ServletException - if any call against the given ServletContext throws a ServletException

Copyright © 2018 Pivotal Software, Inc.. All rights reserved.