re-organize properties

Author: hank-cp

demo-app/src/main/resources/application.yml

@@ -4,13 +4,21 @@ spring:
     username: postgres
     driver-class-name: "org.postgresql.Driver"
   sbp:
-    runtimeMode: development
+    runtime-mode: development
     enabled: true
     classes-directories:
       - "out/production/classes"
       - "out/production/resources"
     lib-directories:
       - "libs"
+    plugin-properties:
+      spring:
+        jpa:
+          properties:
+            hibernate:
+              temp:
+                use_jdbc_metadata_defaults: false
+          database-platform: org.hibernate.dialect.PostgreSQL9Dialect
   flyway:
     schemas:
       - demo_app
@@ -37,14 +45,4 @@ logging:
   level:
     org.hibernate.tool.schema.internal.ExceptionHandlerLoggedImpl: ERROR
     org.jooq: DEBUG
-    org.jooq.Constants: ERROR
-
-sbp-plugin:
-  properties:
-    spring:
-      jpa:
-        properties:
-          hibernate:
-            temp:
-              use_jdbc_metadata_defaults: false
-        database-platform: org.hibernate.dialect.PostgreSQL9Dialect
+    org.jooq.Constants: ERROR

demo-app/src/test/resources/application.yml

@@ -13,6 +13,17 @@ spring:
       - "build/resources/main"
     lib-directories:
       - "libs"
+    plugin-properties:
+      spring:
+        flyway:
+          import-data: true
+          clean-before-migrate: true
+        jpa:
+          properties:
+            hibernate:
+              temp:
+                use_jdbc_metadata_defaults: false
+          database-platform: org.hibernate.dialect.PostgreSQL9Dialect
   flyway:
     schemas:
       - demo_app
@@ -36,16 +47,3 @@ logging:
     org.hibernate.tool.schema.internal.ExceptionHandlerLoggedImpl: ERROR
 #    org.jooq: DEBUG
     org.jooq.Constants: ERROR
-
-sbp-plugin:
-  properties:
-    spring:
-      flyway:
-        import-data: true
-        clean-before-migrate: true
-      jpa:
-        properties:
-          hibernate:
-            temp:
-              use_jdbc_metadata_defaults: false
-        database-platform: org.hibernate.dialect.PostgreSQL9Dialect

docs/configuration.md

@@ -1,23 +1,20 @@
 ### SbpProperties
 
-Configurations for main app (not plugin) to control PluginManager behavior.
+Configurations for main application's PluginManager.
 
 ##### `spring.sbp.enabled`
 set to true to enable sbp. Default false.
 
-##### `spring.sbp.autoStartPlugin`
+##### `spring.sbp.auto-start-plugin`
 auto start plugin when main app is ready. Default true
 
-##### `spring.sbp.disabledPlugins`
+##### `spring.sbp.disabled-plugins`
 Plugins disabled by default 
 
-##### `spring.sbp.enabledPlugins`
-Plugins enabled by default, prior to `disabledPlugins`
+##### `spring.sbp.enabled-plugins`
+Plugins enabled by default, prior to `disabled-plugins`
 
-##### `spring.sbp.profiles`: 
-Specify Spring profiles to be used to create plugins' `ApplicationContext`. 
-
-##### `spring.sbp.classesDirectories`
+##### `spring.sbp.classes-directories`
 where to load plugin classes, relative to plugin folder.
     * for IDEA
     ```
@@ -27,19 +24,29 @@ where to load plugin classes, relative to plugin folder.
         - "out/production/classes"
         - "out/production/resources"
     ```
-##### `spring.sbp.libDirectories`
+##### `spring.sbp.lib-directories`
 where to load jar libs, relative to plugin folder.
 
-##### `spring.sbp.runtimeMode`
+##### `spring.sbp.runtime-mode`
 with two options
     * DEPLOYMENT: load plugin in jar/zip format.
     * DEVELOPMENT: load plugin from build folder with Java class file.
 
-##### `spring.sbp.pluginsRoot`
+##### `spring.sbp.plugins-root`
 plugins home folder, relative to project working DIR. 
 Default `plusins`
 
-##### `spring.sbp.systemVersion`
+##### `spring.sbp.plugin-profiles`: 
+Specify Spring profiles to be used when creating plugins' `ApplicationContext` environment. With profile `plugin` by default. 
+You could use it to config plugin globally.
+Check [Demo](../demo-app/src/main/resources/application.yml) for example.
+
+##### `spring.sbp.plugin-properties`
+Specify properties to be used when creating plugins' `ApplicationContext` environment. 
+You could use it to config plugin globally.
+Check [Demo](../demo-app/src/main/resources/application.yml) for example.
+
+##### `spring.sbp.system-version`
 The system version used for comparisons to the plugin requires attribute.
 
 ##### `spring.sbp.controller.base-path`
@@ -50,14 +57,9 @@ Check [Demo](../demo-app/src/main/resources/application.yml) for example.
 
 ### SbpPluginProperties
 
-Configurations to control how plugins are loaded by PluginManager.
-
-##### `sbp-plugin.properties`
-properties define under this property will be passed to
-plugin `ApplicationContext` environment. You could use it to passed global plugin
-properties. Check [Demo](../demo-app/src/main/resources/application.yml) for example.
+Configurations for individual plugins.
 
-##### `sbp-plugin.pluginFirstClasses`
+##### `sbp-plugin.plugin-first-classes`
 If a class file existed in app classpath and 
 plugin classpath at the same time, `PluginClassLoader` will try to load it
 from plugin classpath first. This will cause `ClassCastException` when classes from
@@ -66,8 +68,8 @@ plugin classpath first to make sure classes come from same classloader.
 e.g. Spring Boot AutoConfiguration used in plugin only. See
 [JPA example](../plugins/demo-plugin-library/src/main/resources/application.yml).
 
-##### `sbp-plugin.pluginOnlyResources`
-If a resources file (including resource) existed 
+##### `sbp-plugin.plugin-only-resources`
+If a resource file (including resource) existed 
 in app classpath and plugin classpath at the same time, `PluginClassLoader` scan all of
 them out when performing `ClassLoader.loadResources()`. This will potentially cause
 unexpected errors, e.g. loading wrong configuration file from the wrong place. Use this 

plugins/demo-plugin-author/src/main/resources/application.yml

@@ -11,8 +11,8 @@ spring:
   jooq:
     sql-dialect: postgres
 
-plugin:
-  pluginOnlyResources:
+sbp-plugin:
+  plugin-only-resources:
     - plugin_only
 
 logging:

plugins/demo-plugin-library/src/main/resources/application.yml

@@ -23,8 +23,8 @@ spring:
       datasource:
         beanName: dataSource-library
 
-plugin:
-  pluginFirstClasses:
+sbp-plugin:
+  plugin-first-classes:
     - org.springframework.boot.autoconfigure.data.*
     - org.springframework.boot.autoconfigure.orm.*
     - org.springframework.boot.orm.jpa.*

sbp-core/src/main/java/org/laxture/sbp/spring/boot/SpringBootstrap.java

@@ -276,7 +276,7 @@ protected void bindToSpringApplication(ConfigurableEnvironment environment) {
         String pluginFirstClassesProp = null;
         int i = 0;
         do {
-            pluginFirstClassesProp = getProperties(environment, "plugin.pluginFirstClasses", i++);
+            pluginFirstClassesProp = getProperties(environment, "pluginFirstClasses", i++);
             if (pluginFirstClassesProp != null) {
                 pluginFirstClasses.add(pluginFirstClassesProp);
             }
@@ -286,7 +286,7 @@ protected void bindToSpringApplication(ConfigurableEnvironment environment) {
         String pluginOnlyResourcesProp = null;
         i = 0;
         do {
-            pluginOnlyResourcesProp = getProperties(environment, "plugin.pluginOnlyResources", i++);
+            pluginOnlyResourcesProp = getProperties(environment, "pluginOnlyResources", i++);
             if (pluginOnlyResourcesProp != null) {
                 pluginOnlyResources.add(pluginOnlyResourcesProp);
             }
@@ -388,11 +388,11 @@ protected void registerBeanFromMainContext(AbstractApplicationContext applicatio
     }
 
     private String getProperties(Environment env, String propName, int index) {
-        String prop = env.getProperty(String.format("%s[%s]", propName, index));
-        if (prop == null) prop = env.getProperty(String.format("%s.%s", propName, index));
-        if (prop == null) prop = env.getProperty(String.format("%s[%s]",
+        String prop = env.getProperty(String.format("sbp-plugin.%s[%s]", propName, index));
+        if (prop == null) prop = env.getProperty(String.format("sbp-plugin.%s.%s", propName, index));
+        if (prop == null) prop = env.getProperty(String.format("sbp-plugin.%s[%s]",
                 String.join("-", StringUtils.splitByCharacterTypeCamelCase(propName)).toLowerCase(), index));
-        if (prop == null) prop = env.getProperty(String.format("%s.%s",
+        if (prop == null) prop = env.getProperty(String.format("sbp-plugin.%s.%s",
                 String.join("-", StringUtils.splitByCharacterTypeCamelCase(propName)).toLowerCase(), index));
         return prop;
     }

sbp-spring-boot-starter/src/main/java/org/laxture/sbp/spring/boot/SbpAutoConfiguration.java

@@ -77,8 +77,7 @@ public PluginManagerController pluginManagerController() {
 
 	@Bean
 	@ConditionalOnMissingBean
-	public SpringBootPluginManager pluginManager(SbpProperties properties,
-									   SbpPluginProperties pluginProperties) {
+	public SpringBootPluginManager pluginManager(SbpProperties properties) {
 		// Setup RuntimeMode
 		System.setProperty("pf4j.mode", properties.getRuntimeMode().toString());
 
@@ -133,11 +132,11 @@ protected PluginStatusProvider createPluginStatusProvider() {
 			}
 		};
 
-		pluginManager.presetProperties(flatProperties(pluginProperties.properties));
+		pluginManager.setProfiles(properties.getPluginProfiles());
+		pluginManager.presetProperties(flatProperties(properties.getPluginProperties()));
 		pluginManager.setExactVersionAllowed(properties.isExactVersionAllowed());
 		pluginManager.setSystemVersion(properties.getSystemVersion());
 		pluginManager.setAutoStartPlugin(properties.isAutoStartPlugin());
-		pluginManager.setProfiles(properties.getProfiles());
 
 		return pluginManager;
 	}

sbp-spring-boot-starter/src/main/java/org/laxture/sbp/spring/boot/SbpPluginProperties.java

@@ -17,6 +17,7 @@
 
 import lombok.Data;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.ApplicationContext;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -32,14 +33,11 @@ public class SbpPluginProperties {
 
 	public static final String PREFIX = "sbp-plugin";
 
-	Map<String, Object> properties = new HashMap<>();
-
 	/**
 	 * Load these classes from plugin classpath first,
 	 * e.g Spring Boot AutoConfiguration used in plugin only.
 	 */
 	public String[] pluginFirstClasses = {};
-
 	/**
 	 * Load these resource from plugin classpath only
 	 */

sbp-spring-boot-starter/src/main/java/org/laxture/sbp/spring/boot/SbpProperties.java

@@ -21,7 +21,9 @@
 import org.springframework.context.ApplicationContext;
 
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 /**
  * Properties for Sbp main app
@@ -50,10 +52,6 @@ public class SbpProperties {
 	 * Plugins enabled by default, prior to `disabledPlugins`
 	 */
 	private String[] enabledPlugins;
-	/**
-	 * Profile for plugin Spring {@link ApplicationContext}
-	 */
-	private String[] profiles = new String[] {"plugin"};
 	/**
 	 * Set to true to allow requires expression to be exactly x.y.z. The default is
 	 * false, meaning that using an exact version x.y.z will implicitly mean the
@@ -77,6 +75,15 @@ public class SbpProperties {
 	 * should be an absolute directory address
 	 */
 	private String pluginsRoot = "plugins";
+	/**
+	 * Profile for plugin Spring {@link ApplicationContext}
+	 */
+	private String[] pluginProfiles = new String[] {"plugin"};
+	/**
+	 * properties define under this property will be passed to
+	 * plugin `ApplicationContext` environment.
+	 */
+	Map<String, Object> pluginProperties = new HashMap<>();
 	/**
 	 * The system version used for comparisons to the plugin requires attribute.
 	 */