24

In the classic web.xml type configuration you could configure context parameters like so

web.xml

...
<context-param>
  <param-name>p-name</param-name>
  <param-value>-value</param-value>
</context-param>
...

How is this achieved in spring-boot. I have a filter that requires parameters.

I'm using @EnableAutoConfiguration and have included <artifactId>spring-boot-starter-jetty</artifactId> in my pom.

dom farr
  • 3,783
  • 4
  • 30
  • 37
  • Check out docs for application.properties options. Many of them you can resolve in just one line :) http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#appendix. – bogdan.rusu Sep 01 '15 at 09:02

4 Answers4

48

You can set parameters on the whole ServletContext by declaring a ServletContextInitializer bean:

@Bean
public ServletContextInitializer initializer() {
    return new ServletContextInitializer() {

        @Override
        public void onStartup(ServletContext servletContext) throws ServletException {
            servletContext.setInitParameter("p-name", "-value");
        }
    };
}

Update: in Spring Boot 1.2 using a ServletContextInitializer is no longer necessary. You can now configure a parameter on the ServletContext in a single line in application.properties:

server.context_parameters.p-name=-value
Andy Wilkinson
  • 97,688
  • 22
  • 237
  • 223
  • Your answer came up in some rather extensive research that I am doing about how to define a filter list using Spring Boot. I have been documenting my research. Are you willing to comment on it? Here is the link: http://stackoverflow.com/questions/36489253/api-url-has-an-empty-filter-list-in-spring-boot-security – CodeMed Apr 08 '16 at 21:21
  • @Andy how to set context-param programmatically for servlet 2.5? – Gaurav Aug 21 '19 at 16:52
  • Spring Boot does not support Servlet 2.5. – Andy Wilkinson Aug 22 '19 at 11:06
7

You can actually achieve this using Java config. If you have filter that requires some parameters, just put them in your application.yml (or .properties), inject them using @Value in your config class and register them in FilterRegistrationBean.

For example:

@Value("${myFilterParam}")
private String myFilterParam;

@Bean(name="myFilter")
public FilterRegistrationBean myFilter() {
    FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(new MyFilter());
    filterRegistrationBean.setInitParameters(Collections.singletonMap("p-name", "p-value"));
    return filterRegistrationBean;
}

Also JavaDoc for FilterRegistrationBean:

http://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/context/embedded/FilterRegistrationBean.html

Update

You can register parameters for servlet context in SpringBootServletInitializer#onStartup() method. Your Application class can extend the SpringBootServletInitializer and you can override the onStartup method and set the parameters there. Example:

@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Application.class);
    }

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        servletContext.setInitParameter("p-name", "p-value");
        super.onStartup(servletContext);
    }

    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }

}

Other alternative is to define ServletContextInitializer bean as suggested by Andy Wilkinson.

Bohuslav Burghardt
  • 31,931
  • 7
  • 104
  • 108
  • Apologies, I was meant to ask about context params, not init params. I've updated the question to reflect this. – dom farr Oct 30 '14 at 07:46
3

Since Spring Boot 2.0.0 they updated the way to add context param:

server.servlet.context-parameters.yourProperty.

You can see more updates on this link

Mauricio Pereyra
  • 31
  • 1
1

Also you can define InitParameterConfiguringServletContextInitializer in your configuration. Example:

@Bean
public InitParameterConfiguringServletContextInitializer initParamsInitializer() {
    Map<String, String> contextParams = new HashMap<>();
    contextParams.put("p-name", "-value");
    return new InitParameterConfiguringServletContextInitializer(contextParams);
}
Anton Bukatyj
  • 11
  • 1