(jackrabbit-oak) branch trunk updated: OAK-10755: commons: deprecate use of slf4j.event.Level in SystemPropertySupplier API (and make it 'internal') (#1408)

[reschke]

This is an automated email from the ASF dual-hosted git repository.

reschke pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git


The following commit(s) were added to refs/heads/trunk by this push:
     new 2c0b3f70ee OAK-10755: commons: deprecate use of slf4j.event.Level in 
SystemPropertySupplier API (and make it 'internal') (#1408)
2c0b3f70ee is described below

commit 2c0b3f70eea94ee92150bd3a2e988ded2ca98724
Author: Julian Reschke <resc...@apache.org>
AuthorDate: Tue Apr 9 16:00:39 2024 +0200

    OAK-10755: commons: deprecate use of slf4j.event.Level in 
SystemPropertySupplier API (and make it 'internal') (#1408)
---
 .../commons/properties/SystemPropertySupplier.java | 31 ++++++++++++++++++++++
 .../oak/commons/properties/package-info.java       |  7 ++++-
 .../oak/plugins/document/ClusterNodeInfo.java      |  2 +-
 3 files changed, 38 insertions(+), 2 deletions(-)

diff --git 
a/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/properties/SystemPropertySupplier.java
 
b/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/properties/SystemPropertySupplier.java
index eb18a72905..464533a51a 100644
--- 
a/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/properties/SystemPropertySupplier.java
+++ 
b/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/properties/SystemPropertySupplier.java
@@ -98,9 +98,40 @@ public class SystemPropertySupplier<T> implements 
Supplier<T> {
 
     /**
      * Specify {@link Level} to use for "success" message.
+     * @deprecated use {@link #logSuccessAs(String) instead
      */
+    @Deprecated(forRemoval = true)
     public SystemPropertySupplier<T> logSuccessAs(Level successLogLevel) {
         this.successLogLevel = Objects.requireNonNull(successLogLevel);
+        LOG.error("Use of deprecated method logSuccessAs(Level)", new 
Exception("call stack"));
+        return this;
+    }
+
+    /**
+     * Specify {@link Level} to use for "success" message (defaults to "INFO")
+     */
+    public SystemPropertySupplier<T> logSuccessAs(String successLogLevel) {
+        Level newLevel;
+        switch (Objects.requireNonNull(successLogLevel)) {
+            case "DEBUG":
+                newLevel = Level.DEBUG;
+                break;
+            case "ERROR":
+                newLevel = Level.ERROR;
+                break;
+            case "INFO":
+                newLevel = Level.INFO;
+                break;
+            case "TRACE":
+                newLevel = Level.TRACE;
+                break;
+            case "WARN":
+                newLevel = Level.WARN;
+                break;
+            default:
+                throw new IllegalArgumentException("unsupported log level: " + 
successLogLevel);
+        }
+        this.successLogLevel = newLevel;
         return this;
     }
 
diff --git 
a/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/properties/package-info.java
 
b/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/properties/package-info.java
index 514910f81d..3e02c2b7b5 100644
--- 
a/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/properties/package-info.java
+++ 
b/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/properties/package-info.java
@@ -14,7 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-@Version("1.0.0")
+/**
+ * <em>For Oak internal use only. Do not use outside Oak components.</em>
+ */
+@Internal(since = "1.1.0")
+@Version("1.1.0")
 package org.apache.jackrabbit.oak.commons.properties;
 
+import org.apache.jackrabbit.oak.commons.annotations.Internal;
 import org.osgi.annotation.versioning.Version;
diff --git 
a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ClusterNodeInfo.java
 
b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ClusterNodeInfo.java
index fe83374122..f0fb52f8df 100644
--- 
a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ClusterNodeInfo.java
+++ 
b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ClusterNodeInfo.java
@@ -1265,7 +1265,7 @@ public class ClusterNodeInfo {
      */
     private static String getHWAFromSystemProperty() {
         return SystemPropertySupplier.create(ClusterNodeInfo.class.getName() + 
".HWADDRESS", "").loggingTo(LOG)
-                .logSuccessAs(Level.DEBUG)
+                .logSuccessAs("DEBUG")
                 .formatSetMessage(
                         (name, value) -> String.format("obtaining hardware 
address from system variable %s: %s", name, value))
                 .get();