Move OnWarDeploymentCondition to org.s.autoconfigure.web.servlet

See spring-projectsgh-14939

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnNotWarDeployment.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -31,11 +31,15 @@
  *
  * @author Guirong Hu
  * @since 2.7.10
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.boot.autoconfigure.web.servlet.ConditionalOnNotWarDeployment}
  */
 @Target({ ElementType.TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 @Conditional(OnWarDeploymentCondition.class)
+@Deprecated(since = "3.4.0", forRemoval = true)
+@SuppressWarnings("removal")
 public @interface ConditionalOnNotWarDeployment {
 
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnWarDeployment.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -30,11 +30,15 @@
  *
  * @author Madhura Bhave
  * @since 2.3.0
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.boot.autoconfigure.web.servlet.ConditionalOnWarDeployment}
  */
 @Target({ ElementType.TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 @Conditional(OnWarDeploymentCondition.class)
+@Deprecated(since = "3.4.0", forRemoval = true)
+@SuppressWarnings("removal")
 public @interface ConditionalOnWarDeployment {
 
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/OnWarDeploymentCondition.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -32,6 +32,8 @@
  * @see ConditionalOnWarDeployment
  * @see ConditionalOnNotWarDeployment
  */
+@Deprecated(since = "3.4.0", forRemoval = true)
+@SuppressWarnings("removal")
 class OnWarDeploymentCondition extends SpringBootCondition {
 
 	@Override

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/embedded/EmbeddedWebServerFactoryCustomizerAutoConfiguration.java

@@ -28,11 +28,11 @@
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnNotWarDeployment;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnThreading;
 import org.springframework.boot.autoconfigure.thread.Threading;
 import org.springframework.boot.autoconfigure.web.ConditionalOnWebApplication;
 import org.springframework.boot.autoconfigure.web.ServerProperties;
+import org.springframework.boot.autoconfigure.web.servlet.ConditionalOnNotWarDeployment;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

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

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2012-2024 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
+ *
+ *      https://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.web.servlet;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.context.annotation.Conditional;
+
+/**
+ * {@link Conditional @Conditional} that only matches when the application is not a
+ * traditional WAR deployment. For applications with embedded servers, this condition will
+ * return true.
+ *
+ * @author Guirong Hu
+ * @since 3.4.0
+ */
+@Target({ ElementType.TYPE, ElementType.METHOD })
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Conditional(OnWarDeploymentCondition.class)
+public @interface ConditionalOnNotWarDeployment {
+
+}

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

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2012-2024 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
+ *
+ *      https://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.web.servlet;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.context.annotation.Conditional;
+
+/**
+ * {@link Conditional @Conditional} that matches when the application is a traditional WAR
+ * deployment. For applications with embedded servers, this condition will return false.
+ *
+ * @author Madhura Bhave
+ * @since 3.4.0
+ */
+@Target({ ElementType.TYPE, ElementType.METHOD })
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Conditional(OnWarDeploymentCondition.class)
+public @interface ConditionalOnWarDeployment {
+
+}

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

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2012-2024 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
+ *
+ *      https://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.web.servlet;
+
+import jakarta.servlet.ServletContext;
+
+import org.springframework.boot.autoconfigure.condition.ConditionMessage;
+import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
+import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
+import org.springframework.context.annotation.Condition;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.io.ResourceLoader;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+import org.springframework.web.context.WebApplicationContext;
+
+/**
+ * {@link Condition} that checks if the application is running as a traditional war
+ * deployment.
+ *
+ * @author Madhura Bhave
+ * @see ConditionalOnWarDeployment
+ * @see ConditionalOnNotWarDeployment
+ */
+class OnWarDeploymentCondition extends SpringBootCondition {
+
+	@Override
+	public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
+		boolean required = metadata.isAnnotated(ConditionalOnWarDeployment.class.getName());
+		ResourceLoader resourceLoader = context.getResourceLoader();
+		if (resourceLoader instanceof WebApplicationContext applicationContext) {
+			ServletContext servletContext = applicationContext.getServletContext();
+			if (servletContext != null) {
+				return new ConditionOutcome(required, "Application is deployed as a WAR file.");
+			}
+		}
+		return new ConditionOutcome(!required, ConditionMessage.forCondition(ConditionalOnWarDeployment.class)
+			.because("the application is not deployed as a WAR file."));
+	}
+
+}

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/websocket/servlet/WebSocketServletAutoConfiguration.java

@@ -30,9 +30,9 @@
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnNotWarDeployment;
 import org.springframework.boot.autoconfigure.web.ConditionalOnWebApplication;
 import org.springframework.boot.autoconfigure.web.ConditionalOnWebApplication.Type;
+import org.springframework.boot.autoconfigure.web.servlet.ConditionalOnNotWarDeployment;
 import org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration;
 import org.springframework.boot.web.embedded.jetty.JettyServletWebServerFactory;
 import org.springframework.boot.web.server.WebServerFactoryCustomizer;

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/ConditionalOnNotWarDeploymentTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -32,6 +32,8 @@
  *
  * @author Guirong Hu
  */
+@Deprecated(since = "3.4.0")
+@SuppressWarnings("removal")
 class ConditionalOnNotWarDeploymentTests {
 
 	@Test

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/ConditionalOnWarDeploymentTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -32,6 +32,8 @@
  *
  * @author Madhura Bhave
  */
+@Deprecated(since = "3.4.0")
+@SuppressWarnings("removal")
 class ConditionalOnWarDeploymentTests {
 
 	@Test

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

@@ -0,0 +1,77 @@
+/*
+ * Copyright 2012-2024 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
+ *
+ *      https://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.web.servlet;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.boot.test.context.runner.ReactiveWebApplicationContextRunner;
+import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
+import org.springframework.boot.web.servlet.context.AnnotationConfigServletWebApplicationContext;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link ConditionalOnNotWarDeployment @ConditionalOnNotWarDeployment}.
+ *
+ * @author Guirong Hu
+ */
+class ConditionalOnNotWarDeploymentTests {
+
+	@Test
+	void nonWebApplicationShouldMatch() {
+		ApplicationContextRunner contextRunner = new ApplicationContextRunner();
+		contextRunner.withUserConfiguration(NotWarDeploymentConfiguration.class)
+			.run((context) -> assertThat(context).hasBean("notForWar"));
+	}
+
+	@Test
+	void reactiveWebApplicationShouldMatch() {
+		ReactiveWebApplicationContextRunner contextRunner = new ReactiveWebApplicationContextRunner();
+		contextRunner.withUserConfiguration(NotWarDeploymentConfiguration.class)
+			.run((context) -> assertThat(context).hasBean("notForWar"));
+	}
+
+	@Test
+	void embeddedServletWebApplicationShouldMatch() {
+		WebApplicationContextRunner contextRunner = new WebApplicationContextRunner(
+				AnnotationConfigServletWebApplicationContext::new);
+		contextRunner.withUserConfiguration(NotWarDeploymentConfiguration.class)
+			.run((context) -> assertThat(context).hasBean("notForWar"));
+	}
+
+	@Test
+	void warDeployedServletWebApplicationShouldNotMatch() {
+		WebApplicationContextRunner contextRunner = new WebApplicationContextRunner();
+		contextRunner.withUserConfiguration(NotWarDeploymentConfiguration.class)
+			.run((context) -> assertThat(context).doesNotHaveBean("notForWar"));
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnNotWarDeployment
+	static class NotWarDeploymentConfiguration {
+
+		@Bean
+		String notForWar() {
+			return "notForWar";
+		}
+
+	}
+
+}