From be4764837a880d193de52d42f428dfb46f0c7bf9 Mon Sep 17 00:00:00 2001
From: Matthias Andreas Benkard <code@mail.matthias.benkard.de>
Date: Wed, 27 Sep 2023 18:06:56 +0200
Subject: fix(docs): Deal with TomcatURLStreamHandlerFactory conflict.

Change-Id: Iab1bf00ad122464b8c770301d2c33406ece072e0
---
 README.adoc                                        | 29 +++++++++++++++++++---
 examples/spring-boot/pom.xml                       |  5 ++++
 .../jsonlogging/example/Application.java           |  5 ++++
 3 files changed, 36 insertions(+), 3 deletions(-)

diff --git a/README.adoc b/README.adoc
index 76f9eae..6b479ca 100644
--- a/README.adoc
+++ b/README.adoc
@@ -201,6 +201,12 @@ If you are using Maven:
       <version>3.0.2.Final</version>
     </dependency>
 
+    <dependency>
+      <groupId>org.jboss.logmanager</groupId>
+      <artifactId>jboss-logmanager-embedded</artifactId>
+      <version>1.2.0.Final</version>
+    </dependency>
+
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter</artifactId>
@@ -245,6 +251,7 @@ configurations {
 dependencies {
   implementation("eu.mulk.quarkus-googlecloud-jsonlogging:quarkus-googlecloud-jsonlogging-core:6.1.0")
   implementation("org.jboss.logmanager:jboss-logmanager:3.0.2.Final")
+  implementation("org.jboss.logmanager:jboss-logmanager-embedded:1.2.0.Final")
   implementation("org.jboss.slf4j:slf4j-jboss-logmanager:2.0.1.Final")
 }
 
@@ -272,15 +279,31 @@ entry to `application.properties` that points to the file:
 logging.config = classpath:logging.properties
 ----
 
-Finally, create the `logging.properties` file in your `resources`
-directory and set the root logger level to something other than
-`SEVERE`:
+Create the `logging.properties` file in your `resources` directory and
+set the root logger level to something other than `SEVERE`:
 
 [source,properties]
 ----
 logger.level = INFO
 ----
 
+Finally, add a `static` block to your Spring Boot application class
+that disables the Tomcat URL stream handler factory, which conflicts
+with the URL stream handler factory registered by the JBoss Modules
+library:
+
+[source,java]
+----
+@SpringBootApplication
+public class Application {
+
+  static {
+    TomcatURLStreamHandlerFactory.disable();
+  }
+
+  // ...
+}
+----
 
 == Usage
 
diff --git a/examples/spring-boot/pom.xml b/examples/spring-boot/pom.xml
index f786b12..9b26ee3 100644
--- a/examples/spring-boot/pom.xml
+++ b/examples/spring-boot/pom.xml
@@ -69,6 +69,11 @@ SPDX-License-Identifier: GPL-3.0-or-later
       <artifactId>jboss-logmanager</artifactId>
       <version>3.0.2.Final</version>
     </dependency>
+    <dependency>
+      <groupId>org.jboss.logmanager</groupId>
+      <artifactId>jboss-logmanager-embedded</artifactId>
+      <version>1.2.0.Final</version>
+    </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
diff --git a/examples/spring-boot/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/example/Application.java b/examples/spring-boot/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/example/Application.java
index d7be322..9a4bdee 100644
--- a/examples/spring-boot/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/example/Application.java
+++ b/examples/spring-boot/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/example/Application.java
@@ -4,12 +4,17 @@
 
 package eu.mulk.quarkus.googlecloud.jsonlogging.example;
 
+import org.apache.catalina.webresources.TomcatURLStreamHandlerFactory;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
 @SpringBootApplication
 public class Application {
 
+  static {
+    TomcatURLStreamHandlerFactory.disable();
+  }
+
   public static void main(String[] args) {
     SpringApplication.run(Application.class, args);
   }
-- 
cgit v1.2.3