You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ma...@apache.org on 2014/09/25 03:21:51 UTC
[5/8] git commit: Extract element type for filters.
Extract element type for filters.
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/a3eee3eb
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/a3eee3eb
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/a3eee3eb
Branch: refs/heads/master
Commit: a3eee3eb2fd9fbe1e996f460680aae320ac995ac
Parents: 8b8a1cf
Author: Matt Sicker <ma...@apache.org>
Authored: Wed Sep 24 09:15:44 2014 -0500
Committer: Matt Sicker <ma...@apache.org>
Committed: Wed Sep 24 20:21:25 2014 -0500
----------------------------------------------------------------------
.../main/java/org/apache/logging/log4j/core/Filter.java | 8 ++++++++
.../org/apache/logging/log4j/core/filter/BurstFilter.java | 4 +++-
.../apache/logging/log4j/core/filter/CompositeFilter.java | 5 +++--
.../logging/log4j/core/filter/DynamicThresholdFilter.java | 6 ++++--
.../org/apache/logging/log4j/core/filter/MapFilter.java | 6 ++++--
.../apache/logging/log4j/core/filter/MarkerFilter.java | 4 +++-
.../org/apache/logging/log4j/core/filter/RegexFilter.java | 10 ++++++----
.../logging/log4j/core/filter/StructuredDataFilter.java | 4 +++-
.../logging/log4j/core/filter/ThreadContextMapFilter.java | 4 +++-
.../apache/logging/log4j/core/filter/ThresholdFilter.java | 4 +++-
.../org/apache/logging/log4j/core/filter/TimeFilter.java | 4 +++-
.../apache/logging/log4j/core/filter/package-info.java | 6 +++++-
12 files changed, 48 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/Filter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/Filter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/Filter.java
index 42a0a99..af1dd68 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/Filter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/Filter.java
@@ -33,6 +33,14 @@ import org.apache.logging.log4j.util.EnglishEnums;
public interface Filter extends LifeCycle {
/**
+ * Main {@linkplain org.apache.logging.log4j.core.config.plugins.Plugin#elementType() plugin element type} for
+ * Filter plugins.
+ *
+ * @since 2.1
+ */
+ String ELEMENT_TYPE = "filter";
+
+ /**
* The result that can returned from a filter method call.
*/
enum Result {
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/BurstFilter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/BurstFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/BurstFilter.java
index 9f4d7a9..3bec9c3 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/BurstFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/BurstFilter.java
@@ -26,8 +26,10 @@ import java.util.concurrent.TimeUnit;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
+import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
@@ -53,7 +55,7 @@ import org.apache.logging.log4j.message.Message;
* </code><br>
*/
-@Plugin(name = "BurstFilter", category = "Core", elementType = "filter", printObject = true)
+@Plugin(name = "BurstFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)
public final class BurstFilter extends AbstractFilter {
private static final long serialVersionUID = 1L;
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/CompositeFilter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/CompositeFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/CompositeFilter.java
index b473021..6ce5631 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/CompositeFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/CompositeFilter.java
@@ -28,6 +28,7 @@ import org.apache.logging.log4j.core.AbstractLifeCycle;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
@@ -36,7 +37,7 @@ import org.apache.logging.log4j.message.Message;
/**
* Composes and invokes one or more filters.
*/
-@Plugin(name = "filters", category = "Core", printObject = true)
+@Plugin(name = "filters", category = Node.CATEGORY, printObject = true)
public final class CompositeFilter extends AbstractLifeCycle implements Iterable<Filter>, Filter {
private static final long serialVersionUID = 1L;
@@ -86,7 +87,7 @@ public final class CompositeFilter extends AbstractLifeCycle implements Iterable
/**
* Returns whether this composite contains any filters.
- *
+ *
* @return whether this composite contains any filters.
*/
public boolean isEmpty() {
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/DynamicThresholdFilter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/DynamicThresholdFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/DynamicThresholdFilter.java
index dd89796..2326466 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/DynamicThresholdFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/DynamicThresholdFilter.java
@@ -22,8 +22,10 @@ import java.util.Map;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.ThreadContext;
+import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
@@ -34,9 +36,9 @@ import org.apache.logging.log4j.message.Message;
/**
* Compare against a log level that is associated with an MDC value.
*/
-@Plugin(name = "DynamicThresholdFilter", category = "Core", elementType = "filter", printObject = true)
+@Plugin(name = "DynamicThresholdFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)
public final class DynamicThresholdFilter extends AbstractFilter {
-
+
private static final long serialVersionUID = 1L;
/**
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MapFilter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MapFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MapFilter.java
index 7abf6b1..4ab60b4 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MapFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MapFilter.java
@@ -23,8 +23,10 @@ import java.util.Map;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
+import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
@@ -36,9 +38,9 @@ import org.apache.logging.log4j.message.Message;
/**
* A Filter that operates on a Map.
*/
-@Plugin(name = "MapFilter", category = "Core", elementType = "filter", printObject = true)
+@Plugin(name = "MapFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)
public class MapFilter extends AbstractFilter {
-
+
private static final long serialVersionUID = 1L;
private final Map<String, List<String>> map;
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MarkerFilter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MarkerFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MarkerFilter.java
index cdac66e..55771e8 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MarkerFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/MarkerFilter.java
@@ -18,8 +18,10 @@ package org.apache.logging.log4j.core.filter;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
+import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
@@ -30,7 +32,7 @@ import org.apache.logging.log4j.message.Message;
* configured marker as a parent.
*
*/
-@Plugin(name = "MarkerFilter", category = "Core", elementType = "filter", printObject = true)
+@Plugin(name = "MarkerFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)
public final class MarkerFilter extends AbstractFilter {
private static final long serialVersionUID = 1L;
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/RegexFilter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/RegexFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/RegexFilter.java
index ad28fb4..18034e4 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/RegexFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/RegexFilter.java
@@ -24,8 +24,10 @@ import java.util.regex.Pattern;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
+import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
@@ -39,7 +41,7 @@ import org.apache.logging.log4j.message.Message;
* calling Message.getMessageFormat (true) or Message.getFormattedMessage() (false). The default is false.
*
*/
-@Plugin(name = "RegexFilter", category = "Core", elementType = "filter", printObject = true)
+@Plugin(name = "RegexFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)
public final class RegexFilter extends AbstractFilter {
private static final long serialVersionUID = 1L;
@@ -103,7 +105,7 @@ public final class RegexFilter extends AbstractFilter {
/**
* Create a Filter that matches a regular expression.
- *
+ *
* @param regex
* The regular expression to match.
* @param patternFlags
@@ -124,8 +126,8 @@ public final class RegexFilter extends AbstractFilter {
@PluginAttribute("regex") final String regex,
@PluginElement("PatternFlags") final String[] patternFlags,
@PluginAttribute("useRawMsg") final Boolean useRawMsg,
- @PluginAttribute("onMatch") final Result match,
- @PluginAttribute("onMismatch") final Result mismatch)
+ @PluginAttribute("onMatch") final Result match,
+ @PluginAttribute("onMismatch") final Result mismatch)
//@formatter:on
throws IllegalArgumentException, IllegalAccessException {
if (regex == null) {
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/StructuredDataFilter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/StructuredDataFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/StructuredDataFilter.java
index c7ab199..9c57a8a 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/StructuredDataFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/StructuredDataFilter.java
@@ -23,8 +23,10 @@ import java.util.Map;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
+import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
@@ -36,7 +38,7 @@ import org.apache.logging.log4j.message.StructuredDataMessage;
/**
* Filter based on data in a StructuredDataMessage.
*/
-@Plugin(name = "StructuredDataFilter", category = "Core", elementType = "filter", printObject = true)
+@Plugin(name = "StructuredDataFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)
public final class StructuredDataFilter extends MapFilter {
private static final long serialVersionUID = 1L;
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThreadContextMapFilter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThreadContextMapFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThreadContextMapFilter.java
index 454b3f5..9fba2b4 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThreadContextMapFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThreadContextMapFilter.java
@@ -25,8 +25,10 @@ import java.util.Map;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.ThreadContext;
+import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
@@ -37,7 +39,7 @@ import org.apache.logging.log4j.message.Message;
/**
* Filter based on a value in the Thread Context Map (MDC).
*/
-@Plugin(name = "ThreadContextMapFilter", category = "Core", elementType = "filter", printObject = true)
+@Plugin(name = "ThreadContextMapFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)
public class ThreadContextMapFilter extends MapFilter {
private static final long serialVersionUID = 1L;
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java
index 27da4ac..34b0307 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java
@@ -18,8 +18,10 @@ package org.apache.logging.log4j.core.filter;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
+import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
+import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
@@ -33,7 +35,7 @@ import org.apache.logging.log4j.message.Message;
*
* The default Level is ERROR.
*/
-@Plugin(name = "ThresholdFilter", category = "Core", elementType = "filter", printObject = true)
+@Plugin(name = "ThresholdFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)
public final class ThresholdFilter extends AbstractFilter {
private static final long serialVersionUID = 1L;
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/TimeFilter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/TimeFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/TimeFilter.java
index a72d75c..159bc41 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/TimeFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/TimeFilter.java
@@ -21,7 +21,9 @@ import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.TimeZone;
+import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
+import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
@@ -29,7 +31,7 @@ import org.apache.logging.log4j.core.config.plugins.PluginFactory;
/**
* Filters events that fall within a specified time period in each day.
*/
-@Plugin(name = "TimeFilter", category = "Core", elementType = "filter", printObject = true)
+@Plugin(name = "TimeFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)
public final class TimeFilter extends AbstractFilter {
private static final long serialVersionUID = 1L;
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/a3eee3eb/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/package-info.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/package-info.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/package-info.java
index b60d3d2..8c4d417 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/package-info.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/package-info.java
@@ -15,6 +15,10 @@
* limitations under the license.
*/
/**
- * Log4j 2 Filter support.
+ * Log4j 2 Filter support. {@link org.apache.logging.log4j.core.Filter} plugins should use the
+ * {@linkplain org.apache.logging.log4j.core.config.plugins.Plugin#category() plugin category}
+ * {@link org.apache.logging.log4j.core.config.Node#CATEGORY Core} and the
+ * {@linkplain org.apache.logging.log4j.core.config.plugins.Plugin#elementType() element type}
+ * {@link org.apache.logging.log4j.core.Filter#ELEMENT_TYPE filter}.
*/
package org.apache.logging.log4j.core.filter;