Relocate EnvironmentPostProcessor and implementations out of env

Move the `EnvironmentPostProcessor` from `org.springframework.boot.env`
to `org.springframework.boot` so that we can make the `env` package
foundational.

Most `EnvironmentPostProcessor` implementation has also been relocated
to a new `org.springframework.boot.support` package.

See gh-47232

Author: philwebb

config/checkstyle/import-control.xml

@@ -17,6 +17,9 @@
 	<subpackage name="bootstrap">
 		<disallow pkg="org.springframework.boot" exact-match="true"/>
 	</subpackage>
+	<subpackage name="env">
+		<disallow pkg="org.springframework.boot" exact-match="true"/>
+	</subpackage>
 	<subpackage name="ssl">
 		<disallow pkg="org.springframework.boot" exact-match="true"/>
 	</subpackage>

core/spring-boot/src/main/java/org/springframework/boot/env/EnvironmentPostProcessor.java renamed to core/spring-boot/src/main/java/org/springframework/boot/EnvironmentPostProcessor.java

@@ -14,9 +14,8 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.env;
+package org.springframework.boot;
 
-import org.springframework.boot.SpringApplication;
 import org.springframework.boot.bootstrap.BootstrapContext;
 import org.springframework.boot.bootstrap.BootstrapRegistry;
 import org.springframework.boot.bootstrap.ConfigurableBootstrapContext;
@@ -34,8 +33,8 @@
  * interface or use an {@link org.springframework.core.annotation.Order @Order} annotation
  * if they wish to be invoked in specific order.
  * <p>
- * Since Spring Boot 2.4, {@code EnvironmentPostProcessor} implementations may optionally
- * take the following constructor parameters:
+ * {@code EnvironmentPostProcessor} implementations may optionally take the following
+ * constructor parameters:
  * <ul>
  * <li>{@link DeferredLogFactory} - A factory that can be used to create loggers with
  * output deferred until the application has been fully prepared (allowing the environment
@@ -47,7 +46,7 @@
  *
  * @author Andy Wilkinson
  * @author Stephane Nicoll
- * @since 1.3.0
+ * @since 4.0.0
  */
 @FunctionalInterface
 public interface EnvironmentPostProcessor {

core/spring-boot/src/main/java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.java

@@ -25,9 +25,9 @@
 import org.apache.commons.logging.Log;
 import org.jspecify.annotations.Nullable;
 
+import org.springframework.boot.EnvironmentPostProcessor;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.context.config.ConfigDataEnvironmentPostProcessor;
-import org.springframework.boot.env.EnvironmentPostProcessor;
 import org.springframework.boot.json.JsonParser;
 import org.springframework.boot.json.JsonParserFactory;
 import org.springframework.boot.logging.DeferredLogFactory;

core/spring-boot/src/main/java/org/springframework/boot/context/config/AnsiOutputApplicationListener.java

@@ -20,7 +20,7 @@
 import org.springframework.boot.ansi.AnsiOutput.Enabled;
 import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent;
 import org.springframework.boot.context.properties.bind.Binder;
-import org.springframework.boot.env.EnvironmentPostProcessorApplicationListener;
+import org.springframework.boot.support.EnvironmentPostProcessorApplicationListener;
 import org.springframework.context.ApplicationListener;
 import org.springframework.core.Ordered;
 import org.springframework.core.env.ConfigurableEnvironment;

core/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataEnvironmentPostProcessor.java

@@ -24,10 +24,10 @@
 import org.apache.commons.logging.Log;
 import org.jspecify.annotations.Nullable;
 
+import org.springframework.boot.EnvironmentPostProcessor;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.bootstrap.ConfigurableBootstrapContext;
 import org.springframework.boot.bootstrap.DefaultBootstrapContext;
-import org.springframework.boot.env.EnvironmentPostProcessor;
 import org.springframework.boot.logging.DeferredLogFactory;
 import org.springframework.core.Ordered;
 import org.springframework.core.env.ConfigurableEnvironment;

core/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLoaderContext.java

@@ -16,8 +16,8 @@
 
 package org.springframework.boot.context.config;
 
+import org.springframework.boot.EnvironmentPostProcessor;
 import org.springframework.boot.bootstrap.ConfigurableBootstrapContext;
-import org.springframework.boot.env.EnvironmentPostProcessor;
 
 /**
  * Context provided to {@link ConfigDataLoader} methods.

core/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLocationResolverContext.java

@@ -18,9 +18,9 @@
 
 import org.jspecify.annotations.Nullable;
 
+import org.springframework.boot.EnvironmentPostProcessor;
 import org.springframework.boot.bootstrap.ConfigurableBootstrapContext;
 import org.springframework.boot.context.properties.bind.Binder;
-import org.springframework.boot.env.EnvironmentPostProcessor;
 
 /**
  * Context provided to {@link ConfigDataLocationResolver} methods.

core/spring-boot/src/main/java/org/springframework/boot/env/RandomValuePropertySource.java

@@ -28,6 +28,7 @@
 import org.jspecify.annotations.Nullable;
 
 import org.springframework.core.env.ConfigurableEnvironment;
+import org.springframework.core.env.Environment;
 import org.springframework.core.env.MutablePropertySources;
 import org.springframework.core.env.PropertySource;
 import org.springframework.core.env.StandardEnvironment;
@@ -143,11 +144,21 @@ private Object getRandomBytes() {
 		return HexFormat.of().withLowerCase().formatHex(bytes);
 	}
 
+	/**
+	 * Add a {@link RandomValuePropertySource} to the given {@link Environment}.
+	 * @param environment the environment to add the random property source to
+	 */
 	public static void addToEnvironment(ConfigurableEnvironment environment) {
 		addToEnvironment(environment, logger);
 	}
 
-	static void addToEnvironment(ConfigurableEnvironment environment, Log logger) {
+	/**
+	 * Add a {@link RandomValuePropertySource} to the given {@link Environment}.
+	 * @param environment the environment to add the random property source to
+	 * @param logger logger used for debug and trace information
+	 * @since 4.0.0
+	 */
+	public static void addToEnvironment(ConfigurableEnvironment environment, Log logger) {
 		MutablePropertySources sources = environment.getPropertySources();
 		PropertySource<?> existing = sources.get(RANDOM_PROPERTY_SOURCE_NAME);
 		if (existing != null) {

core/spring-boot/src/main/java/org/springframework/boot/env/EnvironmentPostProcessorApplicationListener.java renamed to core/spring-boot/src/main/java/org/springframework/boot/support/EnvironmentPostProcessorApplicationListener.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.env;
+package org.springframework.boot.support;
 
 import java.util.Arrays;
 import java.util.List;
@@ -33,6 +33,7 @@
 import org.springframework.beans.factory.aot.BeanFactoryInitializationAotProcessor;
 import org.springframework.beans.factory.aot.BeanFactoryInitializationCode;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
+import org.springframework.boot.EnvironmentPostProcessor;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.bootstrap.ConfigurableBootstrapContext;
 import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent;
@@ -57,7 +58,7 @@
  *
  * @author Phillip Webb
  * @author Stephane Nicoll
- * @since 2.4.0
+ * @since 4.0.0
  */
 public class EnvironmentPostProcessorApplicationListener implements SmartApplicationListener, Ordered {
 

core/spring-boot/src/main/java/org/springframework/boot/env/EnvironmentPostProcessorsFactory.java renamed to core/spring-boot/src/main/java/org/springframework/boot/support/EnvironmentPostProcessorsFactory.java

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.env;
+package org.springframework.boot.support;
 
 import java.util.List;
 
 import org.jspecify.annotations.Nullable;
 
+import org.springframework.boot.EnvironmentPostProcessor;
 import org.springframework.boot.bootstrap.ConfigurableBootstrapContext;
 import org.springframework.boot.logging.DeferredLogFactory;
 import org.springframework.core.io.support.SpringFactoriesLoader;
@@ -29,7 +30,7 @@
  * create the {@link EnvironmentPostProcessor} instances.
  *
  * @author Phillip Webb
- * @since 2.4.0
+ * @since 4.0.0
  */
 @FunctionalInterface
 public interface EnvironmentPostProcessorsFactory {