Skip to content

Commit 65de530

Browse files
committed
Polish "Add missing attributes to FilterRegistration annotation"
See gh-45005
1 parent 17d579f commit 65de530

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/FilterRegistration.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,10 @@
104104
String[] servletNames() default {};
105105

106106
/**
107-
* Servlet types that the filter will be registered against.
108-
* @return the servlet types
107+
* Servlet classes that the filter will be registered against.
108+
* @return the servlet classes
109109
*/
110-
Class<?>[] servletRegistrationBeans() default {};
110+
Class<?>[] servletClasses() default {};
111111

112112
/**
113113
* URL patterns, as defined in the Servlet specification, that the filter will be

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/ServletContextInitializerBeans.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -367,9 +367,8 @@ private void configureFromAnnotation(FilterRegistrationBean<Filter> bean, Filter
367367
for (WebInitParam param : registration.initParameters()) {
368368
bean.addInitParameter(param.name(), param.value());
369369
}
370-
371370
this.beanFactory.getBeanProvider(ServletRegistrationBean.class).forEach((servletRegistrationBean) -> {
372-
for (Class<?> servletClass : registration.servletRegistrationBeans()) {
371+
for (Class<?> servletClass : registration.servletClasses()) {
373372
if (servletClass.isInstance(servletRegistrationBean.getServlet())) {
374373
bean.addServletRegistrationBeans(servletRegistrationBean);
375374
}

spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/ServletContextInitializerBeansTests.java

+8-8
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
import java.util.Collection;
2020
import java.util.EnumSet;
21+
import java.util.Map;
2122

2223
import jakarta.servlet.DispatcherType;
2324
import jakarta.servlet.Filter;
@@ -144,8 +145,8 @@ void shouldApplyFilterRegistrationAnnotation() {
144145
assertThat(filterRegistrationBean.getServletNames()).containsExactly("test");
145146
assertThat(filterRegistrationBean.determineDispatcherTypes()).containsExactly(DispatcherType.ERROR);
146147
assertThat(filterRegistrationBean.getUrlPatterns()).containsExactly("/test/*");
147-
assertThat(filterRegistrationBean.getInitParameters()).containsEntry("env", "test")
148-
.containsEntry("debug", "true");
148+
assertThat(filterRegistrationBean.getInitParameters())
149+
.containsExactlyInAnyOrderEntriesOf(Map.of("env", "test", "debug", "true"));
149150
Collection<ServletRegistrationBean<?>> servletRegistrationBeans = filterRegistrationBean
150151
.getServletRegistrationBeans();
151152
assertThat(servletRegistrationBeans).hasSize(1);
@@ -305,12 +306,11 @@ TestFilter testFilter() {
305306
static class FilterConfigurationWithAnnotation {
306307

307308
@Bean
308-
@FilterRegistration(enabled = false, name = "test", asyncSupported = false,
309-
dispatcherTypes = DispatcherType.ERROR, matchAfter = true, servletNames = "test",
310-
urlPatterns = "/test/*",
311-
initParameters = { @WebInitParam(name = "env", value = "test"),
312-
@WebInitParam(name = "debug", value = "true") },
313-
servletRegistrationBeans = { TestServlet.class })
309+
@FilterRegistration(
310+
enabled = false, name = "test", asyncSupported = false, dispatcherTypes = DispatcherType.ERROR,
311+
matchAfter = true, servletNames = "test", urlPatterns = "/test/*", initParameters = {
312+
@WebInitParam(name = "env", value = "test"), @WebInitParam(name = "debug", value = "true") },
313+
servletClasses = { TestServlet.class })
314314
TestFilter testFilter() {
315315
return new TestFilter();
316316
}

0 commit comments

Comments
 (0)