You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rg...@apache.org on 2022/05/04 18:24:02 UTC

[logging-log4j2] 01/02: Change config name. Update doc

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

rgoers pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git

commit ff9eea636a868f6732bc7d1dd2d222290837c1b6
Author: Ralph Goers <rg...@apache.org>
AuthorDate: Wed May 4 20:23:19 2022 +0200

    Change config name. Update doc
---
 .../log4j/core/filter/MutableThreadContextMapFilter.java   | 14 ++++++++------
 .../log4j/core/filter/mutable/KeyValuePairConfig.java      | 12 ++++++------
 src/site/asciidoc/manual/filters.adoc                      |  2 +-
 3 files changed, 15 insertions(+), 13 deletions(-)

diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MutableThreadContextMapFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MutableThreadContextMapFilter.java
index 6fa8682304..1480508cad 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MutableThreadContextMapFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MutableThreadContextMapFilter.java
@@ -63,6 +63,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
 public class MutableThreadContextMapFilter extends AbstractFilter {
 
     private static final ObjectMapper MAPPER = new ObjectMapper();
+    private static final KeyValuePair[] EMPTY_ARRAY = new KeyValuePair[0];
 
     private volatile Filter filter;
     private final long pollInterval;
@@ -356,11 +357,12 @@ public class MutableThreadContextMapFilter extends AbstractFilter {
         if (result.getStatus() == Status.SUCCESS) {
             LOGGER.debug("Processing Debug key/value pairs from: {}", source.toString());
             try {
-                final KeyValuePairConfig config = MAPPER.readValue(inputStream, KeyValuePairConfig.class);
-                if (config != null && config.getdebugIds() != null) {
-                    if (config.getdebugIds().size() > 0) {
+                final KeyValuePairConfig keyValuePairConfig = MAPPER.readValue(inputStream, KeyValuePairConfig.class);
+                if (keyValuePairConfig != null) {
+                    final Map<String, String[]> config = keyValuePairConfig.getConfig();
+                    if (config != null && config.size() > 0) {
                         final List<KeyValuePair> pairs = new ArrayList<>();
-                        for (Map.Entry<String, String[]> entry : config.getdebugIds().entrySet()) {
+                        for (Map.Entry<String, String[]> entry : config.entrySet()) {
                             final String key = entry.getKey();
                             for (final String value : entry.getValue()) {
                                 if (value != null) {
@@ -371,7 +373,7 @@ public class MutableThreadContextMapFilter extends AbstractFilter {
                             }
                         }
                         if (pairs.size() > 0) {
-                            configResult.pairs = pairs.toArray(new KeyValuePair[0]);
+                            configResult.pairs = pairs.toArray(EMPTY_ARRAY);
                             configResult.status = Status.SUCCESS;
                         } else {
                             configResult.status = Status.EMPTY;
@@ -380,7 +382,7 @@ public class MutableThreadContextMapFilter extends AbstractFilter {
                         configResult.status = Status.EMPTY;
                     }
                 } else {
-                    LOGGER.warn("No debugIds element in ThreadContextMapFilter configuration");
+                    LOGGER.warn("No config element in MutableThreadContextMapFilter configuration");
                     configResult.status = Status.ERROR;
                 }
             } catch (Exception ex) {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/mutable/KeyValuePairConfig.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/mutable/KeyValuePairConfig.java
index e0372e6146..60c0788afb 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/mutable/KeyValuePairConfig.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/mutable/KeyValuePairConfig.java
@@ -27,20 +27,20 @@ public class KeyValuePairConfig {
      * Map of keys and values for the MutableThreadContextMapFilter. Example file:
      * <pre>
      *   {
-     *     "debugIds": {
+     *     "config": {
      *       "loginId": ["rgoers", "adam"],
      *       "accountNumber": ["30510263"]
      *   }
      * }
      * </pre>
      */
-    private Map<String, String[]> debugIds;
+    private Map<String, String[]> config;
 
-    public Map<String, String[]> getdebugIds() {
-        return debugIds;
+    public Map<String, String[]> getConfig() {
+        return config;
     }
 
-    public void setKeyValuePairs(Map<String, String[]> debugIds) {
-        this.debugIds = debugIds;
+    public void setConfig(Map<String, String[]> config) {
+        this.config = config;
     }
 }
diff --git a/src/site/asciidoc/manual/filters.adoc b/src/site/asciidoc/manual/filters.adoc
index 26046b44ef..071ce50137 100644
--- a/src/site/asciidoc/manual/filters.adoc
+++ b/src/site/asciidoc/manual/filters.adoc
@@ -461,7 +461,7 @@ The configuration file supplied to the filter should look similar to:
 [source,json]
 ----
 {
-  "debugIds": {
+  "config": {
     "loginId": ["rgoers@apache.org", "logging@apache.org"],
     "accountNumber": ["30510263"]
   }