Fix for issue #45001 - ServletRegistrationBean has those properties, but @ServletRegistration hasn't: initParameters, servletRegistrationBeans, multipartConfig Signed-off-by: Dmytro Danilenkov <[email protected]>

Signed-off-by: Dmytro Danilenkov <[email protected]>

Author: dmytrodanilenkov

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

@@ -35,6 +35,9 @@
 import jakarta.servlet.Filter;
 import jakarta.servlet.MultipartConfigElement;
 import jakarta.servlet.Servlet;
+import jakarta.servlet.annotation.MultipartConfig;
+import jakarta.servlet.annotation.WebInitParam;
+
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
@@ -324,57 +327,24 @@ private void configureFromAnnotation(ServletRegistrationBean<Servlet> bean, Serv
 			}
 
 			if (registration.initParameters().length > 0) {
-				bean.setInitParameters(parseInitParameters(registration.initParameters()));
+				Map<String, String> initParams = new LinkedHashMap<>();
+				for (WebInitParam param : registration.initParameters()) {
+					initParams.put(param.name(), param.value());
+				}
+				bean.setInitParameters(initParams);
 			}
 
-			ServletRegistration.MultipartConfigValues multipart = registration.multipartConfig();
-			boolean isMultipartConfigUsed = !(multipart.location().isEmpty()
-					&& multipart.maxFileSize() == -1L
-					&& multipart.maxRequestSize() == -1L
-					&& multipart.fileSizeThreshold() == 0);
+			MultipartConfig multipart = registration.multipartConfig();
+			boolean isMultipartConfigUsed = !(multipart.location().isEmpty() && multipart.maxFileSize() == -1L
+					&& multipart.maxRequestSize() == -1L && multipart.fileSizeThreshold() == 0);
 			if (isMultipartConfigUsed) {
-				bean.setMultipartConfig(new MultipartConfigElement(
-						multipart.location(),
-						multipart.maxFileSize(),
-						multipart.maxRequestSize(),
-						multipart.fileSizeThreshold()
-				));
-			}
-
-			for (Class<? extends ServletRegistrationBean<?>> beanClass : registration.servletRegistrationBeans()) {
-				ServletRegistrationBean<?> extraBean = this.beanFactory.getBean(beanClass);
-				bean.getInitParameters().putAll(extraBean.getInitParameters());
-			}
-
-		}
-
-		/**
-		 * Parses an array of "key=value" strings into a Map.
-		 * @param initParamsArray Array of strings, expected format "key=value".
-		 * @return Map of parsed key-value pairs.
-		 * @throws IllegalArgumentException if any string doesn't match the "key=value" format.
-		 */
-		private Map<String, String> parseInitParameters(String[] initParamsArray) {
-			Map<String, String> initParams = new LinkedHashMap<>();
-			for (String kv : initParamsArray) {
-				int index = kv.indexOf('=');
-				if (index != -1) {
-					String key = kv.substring(0, index).trim();
-					String value = kv.substring(index + 1).trim();
-					initParams.put(key, value);
-				}
-				else {
-					throw new IllegalArgumentException(
-							"initParameters must be in 'key=value' format, got: " + kv);
-				}
+				bean.setMultipartConfig(new MultipartConfigElement(multipart.location(), multipart.maxFileSize(),
+						multipart.maxRequestSize(), multipart.fileSizeThreshold()));
 			}
-			return initParams;
 		}
 
 	}
 
-
-
 	/**
 	 * {@link RegistrationBeanAdapter} for {@link Filter} beans.
 	 */

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

@@ -91,49 +91,14 @@
 	int loadOnStartup() default -1;
 
 	/**
-	 * Init parameters to set on the servlet, as {@code "key=value"} pairs.
+	 * Init parameters to set on the servlet (mirrors {@code @WebInitParam} usage).
+	 * @return array of {@link WebInitParam}
 	 */
-	String[] initParameters() default {};
+	WebInitParam[] initParameters() default {};
 
 	/**
-	 * (Optional) Additional servlet-registration beans to apply.
-	 * Usually left empty unless you need custom bean logic.
+	 * Multipart configuration.
 	 */
-	Class<? extends ServletRegistrationBean<?>>[] servletRegistrationBeans() default {};
+	MultipartConfig multipartConfig() default @MultipartConfig;
 
-	/**
-	 * Multipart configuration. Mirrors {@link jakarta.servlet.annotation.MultipartConfig}.
-	 * If you omit it (no fields changed), it will not set a multipart config.
-	 */
-	MultipartConfigValues multipartConfig() default @MultipartConfigValues;
-
-	/**
-	 * Nested annotation that parallels the fields of
-	 * {@link jakarta.servlet.annotation.MultipartConfig}. Used within
-	 * {@link ServletRegistration#multipartConfig()}.
-	 * @see jakarta.servlet.annotation.MultipartConfig
-	 */
-	@Target({})
-	@Retention(RetentionPolicy.RUNTIME)
-	@Documented
-	@interface MultipartConfigValues {
-
-		/**
-		 * @see jakarta.servlet.annotation.MultipartConfig#location()
-		 */
-		String location() default "";
-		/**
-		 * @see jakarta.servlet.annotation.MultipartConfig#maxFileSize()
-		 */
-		long maxFileSize() default -1L;
-		/**
-		 * @see jakarta.servlet.annotation.MultipartConfig#maxRequestSize()
-		 */
-		long maxRequestSize() default -1L;
-		/**
-		 * @see jakarta.servlet.annotation.MultipartConfig#fileSizeThreshold()
-		 */
-		int fileSizeThreshold() default 0;
-
-	}
 }

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

@@ -23,6 +23,8 @@
 import jakarta.servlet.ServletContext;
 import jakarta.servlet.ServletRequest;
 import jakarta.servlet.ServletResponse;
+import jakarta.servlet.annotation.MultipartConfig;
+import jakarta.servlet.annotation.WebInitParam;
 import jakarta.servlet.http.HttpServlet;
 import jakarta.servlet.http.HttpSessionIdListener;
 import org.assertj.core.api.ThrowingConsumer;
@@ -191,8 +193,7 @@ void shouldApplyExtendedServletRegistrationAnnotation() {
 		assertThat(bean.getServletName()).isEqualTo("extended");
 		assertThat(bean.getUrlMappings()).containsExactly("/extended/*");
 
-		assertThat(bean.getInitParameters()).containsEntry("hello", "world")
-				.containsEntry("flag", "true");
+		assertThat(bean.getInitParameters()).containsEntry("hello", "world").containsEntry("flag", "true");
 
 		assertThat(bean.getMultipartConfig()).isNotNull();
 		assertThat(bean.getMultipartConfig().getLocation()).isEqualTo("/tmp");
@@ -201,33 +202,7 @@ void shouldApplyExtendedServletRegistrationAnnotation() {
 		assertThat(bean.getMultipartConfig().getFileSizeThreshold()).isEqualTo(128);
 	}
 
-	@Test
-	void shouldApplyServletRegistrationAnnotationWithExtraRegistrationBeans() {
-		load(ServletConfigurationWithExtendedAttributes.class);
-		ServletContextInitializerBeans initializerBeans = new ServletContextInitializerBeans(
-				this.context.getBeanFactory(), TestServletContextInitializer.class);
-
-		ServletRegistrationBean<?> bean = findServletRegistrationBeanByName(initializerBeans, "extendedWithExtraBeans");
-		assertThat(bean).as("extendedWithExtraBeans registration bean").isNotNull();
-
-		assertThat(bean.getServletName()).isEqualTo("extendedWithExtraBeans");
-		assertThat(bean.getUrlMappings()).containsExactly("/extra/*");
-
-		assertThat(bean.getInitParameters()).containsEntry("extra", "fromExtraBean");
-	}
-
-	@SuppressWarnings("rawtypes")
-	private ServletRegistrationBean findServletRegistrationBeanByName(
-			ServletContextInitializerBeans initializerBeans, String servletName) {
-
-		return initializerBeans.stream()
-				.filter(ServletRegistrationBean.class::isInstance)
-				.map(ServletRegistrationBean.class::cast)
-				.filter((registrationBean) -> servletName.equals(registrationBean.getServletName()))
-				.findFirst()
-				.orElse(null);
-	}
-
+	// Removed the test that relied on servletRegistrationBeans = { ... }
 
 	private void load(Class<?>... configuration) {
 		this.context = new AnnotationConfigApplicationContext(configuration);
@@ -377,7 +352,6 @@ static class TestServlet extends HttpServlet implements ServletContextInitialize
 
 		@Override
 		public void onStartup(ServletContext servletContext) {
-
 		}
 
 	}
@@ -388,7 +362,6 @@ static class OrderedTestServlet extends HttpServlet implements ServletContextIni
 
 		@Override
 		public void onStartup(ServletContext servletContext) {
-
 		}
 
 		@Override
@@ -402,17 +375,14 @@ static class TestFilter implements Filter, ServletContextInitializer {
 
 		@Override
 		public void onStartup(ServletContext servletContext) {
-
 		}
 
 		@Override
 		public void init(FilterConfig filterConfig) {
-
 		}
 
 		@Override
 		public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {
-
 		}
 
 	}
@@ -421,7 +391,6 @@ static class TestServletContextInitializer implements ServletContextInitializer
 
 		@Override
 		public void onStartup(ServletContext servletContext) {
-
 		}
 
 	}
@@ -430,7 +399,6 @@ static class OtherTestServletContextInitializer implements ServletContextInitial
 
 		@Override
 		public void onStartup(ServletContext servletContext) {
-
 		}
 
 	}
@@ -439,46 +407,25 @@ public void onStartup(ServletContext servletContext) {
 	static class ServletConfigurationWithExtendedAttributes {
 
 		@Bean
-		@ServletRegistration(
-				name = "extended",
-				urlMappings = "/extended/*",
-				initParameters = { "hello=world", "flag=true" },
-				multipartConfig = @ServletRegistration.MultipartConfigValues(
-						location = "/tmp",
-						maxFileSize = 1024,
-						maxRequestSize = 4096,
-						fileSizeThreshold = 128
-				)
-		)
+		@ServletRegistration(name = "extended", urlMappings = "/extended/*",
+				initParameters = { @WebInitParam(name = "hello", value = "world"),
+						@WebInitParam(name = "flag", value = "true") },
+				multipartConfig = @MultipartConfig(location = "/tmp", maxFileSize = 1024, maxRequestSize = 4096,
+						fileSizeThreshold = 128))
 		TestServlet testServletWithInitParametersAndMultipart() {
 			return new TestServlet();
 		}
 
-		@Bean
-		MyExtraServletRegistrationBean myExtraServletRegistrationBean() {
-			MyExtraServletRegistrationBean bean = new MyExtraServletRegistrationBean();
-			bean.addInitParameter("extra", "fromExtraBean");
-			return bean;
-		}
-
-		@Bean
-		@ServletRegistration(
-				name = "extendedWithExtraBeans",
-				urlMappings = "/extra/*",
-				servletRegistrationBeans = { MyExtraServletRegistrationBean.class }
-		)
-		TestServlet testServletWithExtraBean() {
-			return new TestServlet();
-		}
-
-		static class MyExtraServletRegistrationBean extends ServletRegistrationBean<HttpServlet> {
-
-			MyExtraServletRegistrationBean() {
-				super();
-			}
-
-		}
 	}
 
+	private ServletRegistrationBean<?> findServletRegistrationBeanByName(
+			ServletContextInitializerBeans initializerBeans, String name) {
+		return initializerBeans.stream()
+			.filter(ServletRegistrationBean.class::isInstance)
+			.map(ServletRegistrationBean.class::cast)
+			.filter((r) -> name.equals(r.getServletName()))
+			.findFirst()
+			.orElse(null);
+	}
 
 }