SpringBootApplicationMain->GenericSpringBootApplicationMain

Closes gh-87

Author: rwinch

README.adoc

@@ -118,10 +118,10 @@ repositories.add(new RemoteRepository.Builder("spring-milestone", "default", "ht
 MavenClasspathEntry classpathEntry = new MavenClasspathEntry("org.springframework:spring-core:6.1.0-RC1", repositories);
 ----
 
-=== Default Java Main
+=== GenericSpringBootApplicationMain
 
-In some cases you need to provide a Java main class without any additional configuration.
-If that is the case, you can do it with the following:
+For adhoc applications, you may not have a main class and you may not want to provide boilerplate main method yourself.
+If that is the case, you can leverage `useGenericSpringBootMain`:
 
 [source,java]
 ----
@@ -131,8 +131,8 @@ static CommonsExecWebServerFactoryBean authorizationServer() {
 	// @formatter:off
 	return CommonsExecWebServerFactoryBean.builder()
 		// ...
-		// Add a class annotated with SpringBootApplication and a main method to the classpath and use it as the main class
-		.defaultSpringBootApplicationMain();
+		// Add a generic class annotated with SpringBootApplication and a main method to the classpath and use it as the main class
+		.useGenericSpringBootMain();
 	// @formatter:on
 }
 ----
@@ -156,7 +156,7 @@ For example, if someone wants to start a Config Server instance, the `ConfigServ
 static CommonsExecWebServerFactoryBean configServer() {
 	// @formatter:off
 	return CommonsExecWebServerFactoryBean.builder()
-		.defaultSpringBootApplicationMain()
+		.useGenericSpringBootMain()
 		.setAdditionalBeanClassNames("org.springframework.cloud.config.server.config.ConfigServerConfiguration")
 		.classpath((classpath) -> classpath
 			.entries(springBootStarter("web"))

config/checkstyle/checkstyle-suppressions.xml

@@ -5,6 +5,6 @@
 <suppressions>
     <!-- Ignore third-party code -->
     <suppress files="LoggingMavenRepositoryListener\.java|LoggingMavenTransferListener\.java" checks=".*"/>
-    <suppress files="SpringBootApplicationMain\.java" checks=".*"/>
+    <suppress files="GenericSpringBootApplicationMain\.java" checks=".*"/>
     <suppress files="SpringBootFatJarMain\.java" checks=".*"/>
 </suppressions>

samples/oauth2-login/src/test/java/example/oauth2/login/TestOauth2LoginMain.java

@@ -32,7 +32,7 @@ class TestOauth2LoginMain {
 	static CommonsExecWebServerFactoryBean authorizationServer() {
 		// @formatter:off
 		return CommonsExecWebServerFactoryBean.builder()
-				.defaultSpringBootApplicationMain()
+				.useGenericSpringBootMain()
 				.classpath((classpath) -> classpath
 					.entries(springBootStarter("oauth2-authorization-server"))
 				);

spring-boot-testjars-maven/src/test/java/org/springframework/experimental/boot/test/context/MavenClasspathTests.java

@@ -52,7 +52,7 @@ static class Configuration {
 		static CommonsExecWebServerFactoryBean authorizationServer() {
 			// @formatter:off
 			return CommonsExecWebServerFactoryBean.builder()
-					.defaultSpringBootApplicationMain()
+					.useGenericSpringBootMain()
 					.classpath((classpath) -> classpath
 						.entries(springBootStarter("oauth2-authorization-server"))
 					);

spring-boot-testjars/src/main/java/org/springframework/experimental/boot/server/exec/CommonsExecWebServerFactoryBean.java

@@ -29,7 +29,7 @@
 import org.springframework.beans.factory.BeanNameAware;
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.SmartFactoryBean;
-import org.springframework.experimental.boot.server.exec.imports.SpringBootApplicationMain;
+import org.springframework.experimental.boot.server.exec.imports.GenericSpringBootApplicationMain;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
 import org.springframework.util.StringUtils;
@@ -48,7 +48,7 @@ public class CommonsExecWebServerFactoryBean
 
 	private static Log logger = LogFactory.getLog(CommonsExecWebServerFactoryBean.class);
 
-	private static final String DEFAULT_SPRING_BOOT_MAIN_CLASSNAME = SpringBootApplicationMain.class.getName();
+	private static final String GENERIC_SPRING_BOOT_MAIN_CLASSNAME = GenericSpringBootApplicationMain.class.getName();
 
 	private String executable = currentJavaExecutable();
 
@@ -87,9 +87,9 @@ private static File createApplicationPortFile() {
 		}
 	}
 
-	public CommonsExecWebServerFactoryBean defaultSpringBootApplicationMain() {
-		mainClass(DEFAULT_SPRING_BOOT_MAIN_CLASSNAME);
-		Class<?> mainClass = ClassUtils.resolveClassName(DEFAULT_SPRING_BOOT_MAIN_CLASSNAME, null);
+	public CommonsExecWebServerFactoryBean useGenericSpringBootMain() {
+		mainClass(GENERIC_SPRING_BOOT_MAIN_CLASSNAME);
+		Class<?> mainClass = ClassUtils.resolveClassName(GENERIC_SPRING_BOOT_MAIN_CLASSNAME, null);
 		return classpath((classpath) -> classpath.scan(mainClass));
 	}
 

spring-boot-testjars/src/main/java/org/springframework/experimental/boot/server/exec/imports/SpringBootApplicationMain.java renamed to spring-boot-testjars/src/main/java/org/springframework/experimental/boot/server/exec/imports/GenericSpringBootApplicationMain.java

@@ -19,11 +19,18 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
+/**
+ * Convenience main method that can be leveraged by adhoc applications that do not have a
+ * main method.
+ *
+ * @author Rob Winch
+ * @see org.springframework.experimental.boot.server.exec.CommonsExecWebServerFactoryBean#useGenericSpringBootMain()
+ */
 @SpringBootApplication
-public class SpringBootApplicationMain {
+public class GenericSpringBootApplicationMain {
 
 	public static void main(String[] args) {
-		SpringApplication spring = new SpringApplication(SpringBootApplicationMain.class);
+		SpringApplication spring = new SpringApplication(GenericSpringBootApplicationMain.class);
 		spring.addInitializers(new RegisterBeanDefinitionsInitializer());
 		spring.run(args);
 	}