Spring Boot extension for Stripes framework

Usage

• Git clone + mvn clean install

• Include net.sourceforge.stripes:stripes-spring-boot-starter dependency on your Spring Boot project and you're ready to go! This dependency will take care of setting up the Stripes filters.

Configuration

This extension also enables support for stripes.* namespace on the application.properties file, through the net.sourceforge.stripes.springboot.autoconfigure.StripesProperties class. Namely, there is a stripes.* property for each of the Stripes configuration parameters, plus support for custom parameters and a flag to bypass this module's configuration.

Although it is possible to start your Stripes application without having to set any custom properties, most probably you would like to look at:

• stripes.action-resolver-packages: if not set, Spring Boot will look for actionbean packages by scanning the whole classpath. This operation "just works", but it slows down the application's startup time.
• stripes.extension-packages: defaults to net.sourceforge.stripes.integration.spring (as we are already using Spring / Spring Boot, it seems a reasonable default), change if needed.
• stripes.encryption-key: if you would like to use an encryption key which survives application reloads.
• stripes.custom-conf.WHATEVER: any other filter configuration value that you might need for your Stripes extension are supported through the stripes.custom-conf sub-namespace, i.e., stripes.custom-conf.WHATEVER=MY_CUSTOM_VALUE will be set as an configuration parameter of Stripes filter with key WHATEVER and value MY_CUSTOM_VALUE.
• stripes.enabled: set to false to bypass this module's configuration.

By default, Stripes Dynamic Filter maps to /*, whereas Stripes Filter maps to *.jsp. Beginning with 1.1.0, it is possible to overwrite this mappings by defining two beans, named urlPatternsForStripesDynamicFilter and / or urlPatternsForStripesFilter, both returning List < String > with the desired URL mappings.

File Uploads

By default, Spring Boot servlet-based applications will detect the multipart upload and consume it through Spring MVC, so when the request arrives at the ActionBean, the FileBean will be null, as the associated stream has been already read.

In order to fix, this you have to ensure that the request will be consumed either only one of Spring and Stripes. The easiest way to do this is to add the spring.servlet.multipart.enabled=false to your application.properties file. If you need that Stripes and Spring MVC to coexist in your application, then you'd have to redefine Spring's DispatcherServlet so it doesn't serve /*. Something along the lines of

[...]
import org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration;
import org.springframework.boot.autoconfigure.web.servlet.DispatcherServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.DispatcherServlet;
[...]

@Configuration
public class MyApplicationConfiguration {

    [...]
    @Bean( name = DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME )
    public DispatcherServletRegistrationBean dispatcherServletRegistrationBean( final DispatcherServlet dispatcherServlet ) {
        DispatcherServletRegistrationBean dispatcherServletRegistrationBean= new DispatcherServletRegistrationBean( dispatcherServlet, "/spring-mvc" );
        // dispatcherServletRegistrationBean.addUrlMappings( "/spring-mvc-alt-mapping-1", 
        //                                                   "/spring-mvc-alt-mapping-2", 
        //                                                   "/etc." );
        return dispatcherServletRegistrationBean;
    }
    [...]

}

Running the sample

• Git clone + mvn clean install
• cd stripes-spring-boot-sample
• mvn spring-boot:run or java -jar target/stripes-spring-boot-sample-1.0.0.jar
• Browse http://localhost:8080/index.jsp and/or http://localhost:8080/actuator/stripes

Other caveats

• If running several application instances, set the stripes.encryption-key property at build time to enforce the use of the same encryption key. Look at the sample (stripes-spring-boot-sample/pom.xml, stripes-spring-boot-sample/src/main/resources/application.properties) to see how to do this.
• On 1.x.y, this starter module manually deactivates Spring MVC, by defining String-type beans with ids DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME, DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_BEAN_NAME and conventionErrorViewResolver. As of 1.1.0, this behaviour can be reverted by adding stripes.without-springmvc=false to your application.properties file.

History

• 2.5.14

  • Support for Spring Boot 2.5.14

• 2.3.10

  • Support for Spring Boot 2.3.10

• 2.3.4

  • Support for Spring Boot 2.3.4

• 2.0.0

  • Support for Spring Boot 2
  • New Stripes Actuator Endpoint detailing Stripes' filters configuration
  • Exception Handler autodetection
  • Can run side by side with Spring MVC, no need to set any property on your application.properties file
  • Faster startup time if stripes.action-resolver-packages and/or stripes.exception-handler are set on your application.properties file

• 1.1.0

  • Update to latest 1.5 Spring Boot release
  • Allow to overwrite URL patterns for Stripes' filters
  • Allow to run Stripes side by side with Spring MVC, add stripes.without-springmvc=false on your application.properties file

• 1.0.0

  • First release