From 57fe8b966e874edf9417d4715a4fb994145d0c37 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 14 Feb 2017 17:37:02 +0000 Subject: [PATCH] Use Spring Session's defaults for its filter's dispatcher types Closes gh-8288 --- .../session/SessionAutoConfiguration.java | 3 +- .../SessionRepositoryFilterConfiguration.java | 49 +++++++++++++++++++ .../SessionAutoConfigurationTests.java | 19 +++++++ 3 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionRepositoryFilterConfiguration.java diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionAutoConfiguration.java index 556ee8f1df..97a96f89ea 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionAutoConfiguration.java @@ -58,7 +58,8 @@ import org.springframework.util.Assert; @AutoConfigureAfter({ DataSourceAutoConfiguration.class, HazelcastAutoConfiguration.class, JdbcTemplateAutoConfiguration.class, MongoAutoConfiguration.class, RedisAutoConfiguration.class }) -@Import({ SessionConfigurationImportSelector.class, SessionRepositoryValidator.class }) +@Import({ SessionConfigurationImportSelector.class, SessionRepositoryValidator.class, + SessionRepositoryFilterConfiguration.class }) public class SessionAutoConfiguration { /** diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionRepositoryFilterConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionRepositoryFilterConfiguration.java new file mode 100644 index 0000000000..ad0b75dade --- /dev/null +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionRepositoryFilterConfiguration.java @@ -0,0 +1,49 @@ +/* + * Copyright 2012-2017 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.autoconfigure.session; + +import java.util.EnumSet; + +import javax.servlet.DispatcherType; + +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; +import org.springframework.boot.web.servlet.FilterRegistrationBean; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.session.web.http.SessionRepositoryFilter; + +/** + * Configuration for customizing the registration of the {@link SessionRepositoryFilter}. + * + * @author Andy Wilkinson + */ +@Configuration +@ConditionalOnBean(SessionRepositoryFilter.class) +class SessionRepositoryFilterConfiguration { + + @Bean + public FilterRegistrationBean> sessionRepositoryFilterRegistration( + SessionRepositoryFilter filter) { + FilterRegistrationBean> registration = new FilterRegistrationBean>( + filter); + registration.setDispatcherTypes(EnumSet.of(DispatcherType.ASYNC, + DispatcherType.ERROR, DispatcherType.REQUEST)); + registration.setOrder(SessionRepositoryFilter.DEFAULT_ORDER); + return registration; + } + +} diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationTests.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationTests.java index f8b3b46b9f..5ce1467020 100644 --- a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationTests.java +++ b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationTests.java @@ -18,6 +18,9 @@ package org.springframework.boot.autoconfigure.session; import java.util.Arrays; import java.util.Collections; +import java.util.EnumSet; + +import javax.servlet.DispatcherType; import org.junit.Rule; import org.junit.Test; @@ -28,12 +31,15 @@ import org.springframework.beans.factory.BeanCreationException; import org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration; import org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration; import org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration; +import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.session.ExpiringSession; import org.springframework.session.MapSessionRepository; import org.springframework.session.SessionRepository; import org.springframework.session.data.mongo.MongoOperationsSessionRepository; +import org.springframework.session.web.http.SessionRepositoryFilter; +import org.springframework.test.util.ReflectionTestUtils; import static org.assertj.core.api.Assertions.assertThat; @@ -124,6 +130,19 @@ public class SessionAutoConfigurationTests extends AbstractSessionAutoConfigurat load("spring.session.store-type=jdbc"); } + @SuppressWarnings("unchecked") + @Test + public void filterIsRegisteredWithAsyncErrorAndRequestDispatcherTypes() { + load("spring.session.store-type=hash-map"); + FilterRegistrationBean registration = this.context + .getBean(FilterRegistrationBean.class); + assertThat(registration.getFilter()) + .isSameAs(this.context.getBean(SessionRepositoryFilter.class)); + assertThat((EnumSet) ReflectionTestUtils.getField(registration, + "dispatcherTypes")).containsOnly(DispatcherType.ASYNC, + DispatcherType.ERROR, DispatcherType.REQUEST); + } + @Configuration static class SessionRepositoryConfiguration {