Merge pull request #1635 from /issues/1634-wildfly-conf-and-doc

Fix #1634: Improve WildFly documentation and configuration
wultra · May 2, 2024 · 12f7fa0 · 12f7fa0
2 parents 6b35a97 + 70bc450
commit 12f7fa0
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 59 deletions.
diff --git a/docs/Deploying-Wildfly.md b/docs/Deploying-Wildfly.md
@@ -12,7 +12,7 @@ Web Flow contains the following configuration in `jboss-deployment-structure.xml
 
 ```
 <?xml version="1.0"?>
-<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
+<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.3">
 	<deployment>
 		<exclude-subsystems>
 			<!-- disable the logging subsystem because the application manages its own logging independently -->
@@ -23,11 +23,6 @@ Web Flow contains the following configuration in `jboss-deployment-structure.xml
 			<module name="com.wultra.powerauth.webflow.conf" />
 		</dependencies>
 		
-		<resources>
-			<!-- use WAR provided Bouncy Castle -->
-			<resource-root path="WEB-INF/lib/bcprov-jdk18on-${BC_VERSION}.jar" use-physical-code-source="true"/>
-		</resources>
-
 		<local-last value="true" />
 	</deployment>
 </jboss-deployment-structure>
@@ -36,7 +31,7 @@ Web Flow contains the following configuration in `jboss-deployment-structure.xml
 Similarly, Next Step contains the following configuration in `jboss-deployment-structure.xml` file for JBoss / Wildfly:
 ```
 <?xml version="1.0"?>
-<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
+<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.3">
 	<deployment>
 		<exclude-subsystems>
 			<!-- disable the logging subsystem because the application manages its own logging independently -->
@@ -47,11 +42,6 @@ Similarly, Next Step contains the following configuration in `jboss-deployment-s
 			<module name="com.wultra.powerauth.nextstep.conf" />
 		</dependencies>
 		
-		<resources>
-			<!-- use WAR provided Bouncy Castle -->
-			<resource-root path="WEB-INF/lib/bcprov-jdk18on-${BC_VERSION}.jar" use-physical-code-source="true"/>
-		</resources>
-
 		<local-last value="true" />
 	</deployment>
 </jboss-deployment-structure>
@@ -60,7 +50,7 @@ Similarly, Next Step contains the following configuration in `jboss-deployment-s
 Optionally, TPP engine contains the following configuration in `jboss-deployment-structure.xml` file for JBoss / Wildfly:
 ```
 <?xml version="1.0"?>
-<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
+<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.3">
 	<deployment>
 		<exclude-subsystems>
 			<!-- disable the logging subsystem because the application manages its own logging independently -->
@@ -79,7 +69,7 @@ Optionally, Web Flow Client contains the following configuration in `jboss-deplo
 
 ```
 <?xml version="1.0"?>
-<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
+<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.3">
 	<deployment>
 		<exclude-subsystems>
 			<!-- disable the resource-adapters subsystem to prevent the application's HSQLDB driver
@@ -180,15 +170,17 @@ For Next Step you can use the same configuration, just change the variable `LOG_
 
 The `application-ext.properties` file is used to override default configuration properties, for example:
 ```
+# Database Configuration
+spring.datasource.jndi-name=java:/jdbc/powerauth
+
 # PowerAuth Client configuration
 powerauth.service.url=http://[host]:[port]/powerauth-java-server/rest
 ```
 
+Mind that you should specify `spring.datasource.jndi-name` to use the application server datasource (its declaration is out of the scope of this guideline).
+When configure `spring.datasource.url`, the hikari connection pool is used.
+Spring Boot running on WildFly or JBoos initializes [JtaTransactionManager](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/transaction/jta/JtaTransactionManager.html).
+
 Web Flow Spring application uses the `ext` Spring profile which activates overriding of default properties by `application-ext.properties`.
 
 You need to configure separate `application-ext.properties` files for Web Flow and Next Step in each module. 
-
-### Bouncy Castle Installation
-
-The Bouncy Castle library for JBoss / Wildfly is included in the Web Flow and Next Step war files. The library is configured 
-using the `jboss-deployment-structure.xml` descriptor. Global module configuration of Bouncy Castle is no longer required.
diff --git a/powerauth-nextstep/pom.xml b/powerauth-nextstep/pom.xml
@@ -194,19 +194,6 @@
                     </excludes>
                 </configuration>
             </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-war-plugin</artifactId>
-                <configuration>
-                    <webResources>
-                        <webResource>
-                            <directory>src/main/webapp/WEB-INF</directory>
-                            <targetPath>WEB-INF</targetPath>
-                            <filtering>true</filtering>
-                        </webResource>
-                    </webResources>
-                </configuration>
-            </plugin>
         </plugins>
     </build>
 

diff --git a/powerauth-nextstep/src/main/resources/application.properties b/powerauth-nextstep/src/main/resources/application.properties
@@ -77,3 +77,6 @@ spring.security.oauth2.resource-server.jwt.audiences=
 
 # Monitoring
 management.tracing.sampling.probability=1.0
+
+spring.autoconfigure.exclude=\
+  org.springframework.boot.actuate.autoconfigure.metrics.jersey.JerseyServerMetricsAutoConfiguration
diff --git a/powerauth-nextstep/src/main/webapp/WEB-INF/jboss-deployment-structure.xml b/powerauth-nextstep/src/main/webapp/WEB-INF/jboss-deployment-structure.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
+<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.3">
 	<deployment>
 		<exclude-subsystems>
 			<!-- disable the logging subsystem because the application manages its own logging independently -->
@@ -10,11 +10,6 @@
 			<module name="com.wultra.powerauth.nextstep.conf" />
 		</dependencies>
 
-		<resources>
-			<!-- use WAR provided Bouncy Castle -->
-			<resource-root path="WEB-INF/lib/bcprov-jdk18on-${bcprov-jdk18on.version}.jar" use-physical-code-source="true"/>
-		</resources>
-
 		<local-last value="true" />
 	</deployment>
 </jboss-deployment-structure>
diff --git a/powerauth-tpp-engine/src/main/resources/application.properties b/powerauth-tpp-engine/src/main/resources/application.properties
@@ -45,3 +45,6 @@ logging.config=${POWERAUTH_TPP_ENGINE_LOGGING:}
 
 # Monitoring
 management.tracing.sampling.probability=1.0
+
+spring.autoconfigure.exclude=\
+  org.springframework.boot.actuate.autoconfigure.metrics.jersey.JerseyServerMetricsAutoConfiguration
diff --git a/powerauth-tpp-engine/src/main/webapp/WEB-INF/jboss-deployment-structure.xml b/powerauth-tpp-engine/src/main/webapp/WEB-INF/jboss-deployment-structure.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
+<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.3">
 	<deployment>
 		<exclude-subsystems>
 			<!-- disable the logging subsystem because the application manages its own logging independently -->

diff --git a/powerauth-webflow-client/src/main/resources/application.properties b/powerauth-webflow-client/src/main/resources/application.properties
@@ -41,3 +41,6 @@ logging.config=${POWERAUTH_WEBFLOW_CLIENT_LOGGING:}
 
 # Monitoring
 management.tracing.sampling.probability=1.0
+
+spring.autoconfigure.exclude=\
+  org.springframework.boot.actuate.autoconfigure.metrics.jersey.JerseyServerMetricsAutoConfiguration
diff --git a/powerauth-webflow-client/src/main/webapp/WEB-INF/jboss-deployment-structure.xml b/powerauth-webflow-client/src/main/webapp/WEB-INF/jboss-deployment-structure.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
+<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.3">
 	<deployment>
 		<exclude-subsystems>
 			<!-- disable the resource-adapters subsystem to prevent the application's HSQLDB driver

diff --git a/powerauth-webflow/pom.xml b/powerauth-webflow/pom.xml
@@ -238,19 +238,6 @@
                     </execution>
                 </executions>
             </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-war-plugin</artifactId>
-                <configuration>
-                    <webResources>
-                        <webResource>
-                            <directory>src/main/webapp/WEB-INF</directory>
-                            <targetPath>WEB-INF</targetPath>
-                            <filtering>true</filtering>
-                        </webResource>
-                    </webResources>
-                </configuration>
-            </plugin>
         </plugins>
     </build>
 

diff --git a/powerauth-webflow/src/main/resources/application.properties b/powerauth-webflow/src/main/resources/application.properties
@@ -127,3 +127,6 @@ logging.config=${POWERAUTH_WEBFLOW_LOGGING:}
 
 # Monitoring
 management.tracing.sampling.probability=1.0
+
+spring.autoconfigure.exclude=\
+  org.springframework.boot.actuate.autoconfigure.metrics.jersey.JerseyServerMetricsAutoConfiguration
diff --git a/powerauth-webflow/src/main/webapp/WEB-INF/jboss-deployment-structure.xml b/powerauth-webflow/src/main/webapp/WEB-INF/jboss-deployment-structure.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
+<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.3">
 	<deployment>
 		<exclude-subsystems>
 			<!-- disable the logging subsystem because the application manages its own logging independently -->
@@ -10,11 +10,6 @@
 			<module name="com.wultra.powerauth.webflow.conf" />
 		</dependencies>
 
-		<resources>
-			<!-- use WAR provided Bouncy Castle -->
-			<resource-root path="WEB-INF/lib/bcprov-jdk18on-${bcprov-jdk18on.version}.jar" use-physical-code-source="true"/>
-		</resources>
-
 		<local-last value="true" />
 	</deployment>
 </jboss-deployment-structure>