Feature #12832

Adding parameter JCR_STATS_ENABLED and DB_STATS_ENABLED in order to enable the statistics on Silverpeas's used data sources. When statistics enabled on a data source, its pool state can be analyzed in real time from management console.

Adding boolean SERVER_MANAGEMENT_ALL_IP parameter which allows to enable the management services access from server IP and not only localhost. This is useful with Silverpeas's servers not providing WEB browsers.

Author: SilverYoCha

src/main/groovy/org/silverpeas/setup/api/JBossServer.groovy

@@ -51,6 +51,8 @@ class JBossServer {
 
   final String jbossHome
 
+  private boolean serverManagementAllIP
+
   private File redirection = null
 
   private long timeout = DEFAULT_TIMEOUT
@@ -165,12 +167,27 @@ class JBossServer {
    * @return itself.
    */
   JBossServer withStartingTimeout(long timeout) {
-    if (this.timeout > 0) {
+    if (timeout > 0) {
       this.timeout = timeout
     }
     return this
   }
 
+  /**
+   * By default, the management console is only available on the machine of the running wildfly
+   * at IP 127.0.0.1 and port 9990.
+   * This method allows the management console to be accessible from any server IP. This is useful
+   * with a client server which does not provide WEB browser (which is generally the case).
+   * By default, false (that means default wildfly behavior).
+   * This parameter only affects start and debug methods.
+   * @param isAllIp true to make the management accessible from any client.
+   * @return itself.
+   */
+  JBossServer setServerManagementAllIP(boolean isAllIp) {
+    this.serverManagementAllIP = isAllIp
+    return this
+  }
+
   /**
    * Gets the name and the version of the JBoss/Wildfly application server referred by the
    * JBOSS_HOME environment variable.
@@ -200,6 +217,7 @@ class JBossServer {
    * </ul>
    */
   void start(Map params = null) {
+    int managementPort = 9990
     boolean adminOnly = (params != null && params.adminOnly ? params.adminOnly:false)
     if (reloadRequired()) {
       reload()
@@ -209,6 +227,8 @@ class JBossServer {
       ProcessBuilder process
       if (adminOnly) {
         process = new ProcessBuilder(starter, '-c', 'standalone-full.xml', '--admin-only')
+      } else if (serverManagementAllIP) {
+        process = new ProcessBuilder(starter, '-c', 'standalone-full.xml', '-bmanagement', '0.0.0.0', '-b', '0.0.0.0')
       } else {
         process = new ProcessBuilder(starter, '-c', 'standalone-full.xml', '-b', '0.0.0.0')
       }
@@ -222,6 +242,10 @@ class JBossServer {
       }
       process.start()
       waitUntilRunning()
+      if (serverManagementAllIP) {
+        println ''
+        println "Silverpeas management console is accessible at server IP on port ${managementPort}"
+      }
     } else {
       logger.info 'A JBoss instance is already started'
     }
@@ -239,11 +263,20 @@ class JBossServer {
       stop()
     }
     if (!isStartingOrRunning()) {
+      int managementPort = 9990
       String p = (port <= 1000 ? '5005':String.valueOf(port))
-      ProcessBuilder process =
-          new ProcessBuilder(starter, '-c', 'standalone-full.xml', '-b', '0.0.0.0', '--debug', p)
-              .directory(new File(jbossHome))
-              .redirectErrorStream(true)
+      ProcessBuilder process
+      if (serverManagementAllIP) {
+        process =
+            new ProcessBuilder(starter, '-c', 'standalone-full.xml', '-bmanagement', '0.0.0.0', '-b', '0.0.0.0', '--debug', p)
+                .directory(new File(jbossHome))
+                .redirectErrorStream(true)
+      } else {
+        process =
+            new ProcessBuilder(starter, '-c', 'standalone-full.xml', '-b', '0.0.0.0', '--debug', p)
+                .directory(new File(jbossHome))
+                .redirectErrorStream(true)
+      }
       if (redirection != null) {
         process.redirectOutput(redirection)
       } else {
@@ -252,6 +285,10 @@ class JBossServer {
       }
       process.start()
       waitUntilRunning()
+      println ''
+      if (serverManagementAllIP) {
+        println "Silverpeas management console is accessible at server IP on port ${managementPort}"
+      }
       println "Silverpeas Debugging Port is ${p}"
     } else {
       logger.info 'A JBoss instance is already started'

src/main/resources/default_config.properties

@@ -123,6 +123,13 @@ SERVER_SECURED=false
 # change the value here (for example, by setting it to 900 for 15mn)
 SERVER_STARTING_TIMEOUT = 300
 
+# By default, the management console is only available on the machine of the running wildfly
+# at IP 127.0.0.1 and port 9990.
+# This variable allows the management console to be accessible from any server IP. This is useful
+# with a client server which does not provide WEB browser (which is generally the case).
+# By default, false (that means default wildfly behavior).
+SERVER_MANAGEMENT_ALL_IP = false
+
 ####################################################################################################
 ## Properties of the database to use for Silverpeas.
 ####################################################################################################
@@ -159,6 +166,7 @@ DB_MIN_POOL_SIZE=5
 DB_MAX_POOL_SIZE=120
 DB_IDLE_TIMEOUT=15
 DB_BLOCKING_TIMEOUT=30000
+DB_STATS_ENABLED=false
 
 ####################################################################################################
 ## Properties for the JCR used by Silverpeas to store document metadata.
@@ -178,6 +186,7 @@ JCR_MIN_POOL_SIZE=5
 JCR_MAX_POOL_SIZE=55
 JCR_IDLE_TIMEOUT=15
 JCR_BLOCKING_TIMEOUT=30000
+JCR_STATS_ENABLED=false
 
 ####################################################################################################
 ## Document Conversion Service properties.

src/test/resources/configuration/config.properties

@@ -143,6 +143,7 @@ DB_NAME=test
 #DB_MAX_POOL_SIZE=55
 #DB_IDLE_TIMEOUT=15
 #DB_BLOCKING_TIMEOUT=30000
+#DB_STATS_ENABLED=false
 
 ####################################################################################################
 ## Properties for the JCR used by Silverpeas to store document metadata.
@@ -162,6 +163,7 @@ DB_NAME=test
 #JCR_MAX_POOL_SIZE=55
 #JCR_IDLE_TIMEOUT=15
 #JCR_BLOCKING_TIMEOUT=30000
+#JCR_STATS_ENABLED=false
 
 ####################################################################################################
 ## Document Conversion Service properties.