You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4j-dev@logging.apache.org by sd...@apache.org on 2008/06/06 08:15:54 UTC
svn commit: r663831 - in /logging/log4j/companions/extras/trunk/src:
main/java/org/apache/log4j/rolling/CompositeTriggeringPolicy.java
test/java/org/apache/log4j/rolling/CompositeTriggeringPolicyTest.java
Author: sdeboy
Date: Thu Jun 5 23:15:54 2008
New Revision: 663831
URL: http://svn.apache.org/viewvc?rev=663831&view=rev
Log:
Initial commit of a CompositeTriggeringPolicy and associated test.
Allows multiple triggering policies to be 'or'd together to determine if an event should trigger rolling.
CompositeTriggeringPolicy can be configured via xml configuration by adding child 'triggeringPolicy' nodes to the CompositeTriggeringPolicy.
Did not change the DTD.
Added:
logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/rolling/CompositeTriggeringPolicy.java
logging/log4j/companions/extras/trunk/src/test/java/org/apache/log4j/rolling/CompositeTriggeringPolicyTest.java
Added: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/rolling/CompositeTriggeringPolicy.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/rolling/CompositeTriggeringPolicy.java?rev=663831&view=auto
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/rolling/CompositeTriggeringPolicy.java (added)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/rolling/CompositeTriggeringPolicy.java Thu Jun 5 23:15:54 2008
@@ -0,0 +1,76 @@
+/*
+ * Copyright 1999,2005 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.log4j.rolling;
+
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.Properties;
+import java.util.Set;
+
+import org.apache.log4j.Appender;
+import org.apache.log4j.spi.LoggingEvent;
+import org.apache.log4j.spi.OptionHandler;
+import org.apache.log4j.xml.UnrecognizedElementHandler;
+import org.w3c.dom.Element;
+
+
+/**
+ * CompositeTriggeringPolicy determines if rolling should be triggered
+ * by evaluating the current event against a set of triggering policies.
+ *
+ * TriggeringPolicy results are OR'd together - if any of the triggering policies report rolling should occur,
+ * a rolling event will be triggered.
+ *
+ */
+public final class CompositeTriggeringPolicy implements TriggeringPolicy, UnrecognizedElementHandler {
+ Set triggeringPolicies = new HashSet();
+
+ public CompositeTriggeringPolicy() {
+ }
+
+ public boolean isTriggeringEvent(final Appender appender, final LoggingEvent event, final String file, final long fileLength) {
+ boolean isTriggered = false;
+ for (Iterator iter = triggeringPolicies.iterator();iter.hasNext();) {
+ boolean result = ((TriggeringPolicy)iter.next()).isTriggeringEvent(appender, event, file, fileLength);
+ isTriggered = isTriggered || result;
+ }
+ return isTriggered;
+ }
+
+ void addTriggeringPolicy(final TriggeringPolicy policy) {
+ triggeringPolicies.add(policy);
+ }
+
+ public void activateOptions() {
+ for (Iterator iter = triggeringPolicies.iterator();iter.hasNext();) {
+ ((TriggeringPolicy)iter.next()).activateOptions();
+ }
+ }
+
+ public boolean parseUnrecognizedElement(final Element element, final Properties props) throws Exception {
+ final String nodeName = element.getNodeName();
+ if ("triggeringPolicy".equals(nodeName)) {
+ OptionHandler policy = org.apache.log4j.extras.DOMConfigurator.parseElement(element, props, TriggeringPolicy.class);
+ if (policy instanceof TriggeringPolicy) {
+ policy.activateOptions();
+ addTriggeringPolicy((TriggeringPolicy)policy);
+ }
+ return true;
+ }
+ return false;
+ }
+}
Added: logging/log4j/companions/extras/trunk/src/test/java/org/apache/log4j/rolling/CompositeTriggeringPolicyTest.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/test/java/org/apache/log4j/rolling/CompositeTriggeringPolicyTest.java?rev=663831&view=auto
==============================================================================
--- logging/log4j/companions/extras/trunk/src/test/java/org/apache/log4j/rolling/CompositeTriggeringPolicyTest.java (added)
+++ logging/log4j/companions/extras/trunk/src/test/java/org/apache/log4j/rolling/CompositeTriggeringPolicyTest.java Thu Jun 5 23:15:54 2008
@@ -0,0 +1,89 @@
+package org.apache.log4j.rolling;
+
+import junit.framework.TestCase;
+
+import org.apache.log4j.Appender;
+import org.apache.log4j.ConsoleAppender;
+import org.apache.log4j.Level;
+import org.apache.log4j.Logger;
+import org.apache.log4j.PatternLayout;
+import org.apache.log4j.spi.LoggingEvent;
+import org.junit.Assert;
+
+
+/**
+ * Test CompositeTriggeringPolicy
+ *
+ */
+public class CompositeTriggeringPolicyTest extends TestCase {
+ private CompositeTriggeringPolicy composite;
+ private ConsoleAppender appender;
+ private LoggingEvent event;
+
+ protected void setUp() throws Exception {
+ event = new LoggingEvent("Classname", Logger.getLogger("Logger"), System.currentTimeMillis(), Level.INFO, "msg", null);
+ appender = new ConsoleAppender(new PatternLayout("%d %level %c -%m%n"));
+ composite = new CompositeTriggeringPolicy();
+ }
+
+ protected void tearDown() throws Exception {
+ }
+
+ public void testNoPolicies() {
+ composite.activateOptions();
+ Assert.assertFalse(composite.isTriggeringEvent(appender, event, "file", 100));
+ }
+
+ public void testOneTruePolicy() {
+ composite.addTriggeringPolicy(new TestTriggeringPolicy(true));
+ composite.activateOptions();
+ Assert.assertTrue(composite.isTriggeringEvent(appender, event, "file", 100));
+ }
+
+ public void testOneFalsePolicy() {
+ composite.addTriggeringPolicy(new TestTriggeringPolicy(false));
+ composite.activateOptions();
+ Assert.assertFalse(composite.isTriggeringEvent(appender, event, "file", 100));
+ }
+
+ public void testAllFalsePolicies() {
+ composite.addTriggeringPolicy(new TestTriggeringPolicy(false));
+ composite.addTriggeringPolicy(new TestTriggeringPolicy(false));
+ composite.addTriggeringPolicy(new TestTriggeringPolicy(false));
+ composite.activateOptions();
+ Assert.assertFalse(composite.isTriggeringEvent(appender, event, "file", 100));
+ }
+
+ public void testAllTruePolicies() {
+ composite.addTriggeringPolicy(new TestTriggeringPolicy(true));
+ composite.addTriggeringPolicy(new TestTriggeringPolicy(true));
+ composite.addTriggeringPolicy(new TestTriggeringPolicy(true));
+ composite.activateOptions();
+ Assert.assertTrue(composite.isTriggeringEvent(appender, event, "file", 100));
+ }
+
+ public void testTrueAndFalsePolicies() {
+ composite.addTriggeringPolicy(new TestTriggeringPolicy(false));
+ composite.addTriggeringPolicy(new TestTriggeringPolicy(false));
+ composite.addTriggeringPolicy(new TestTriggeringPolicy(true));
+ composite.activateOptions();
+ Assert.assertTrue(composite.isTriggeringEvent(appender, event, "file", 100));
+ }
+
+ class TestTriggeringPolicy implements TriggeringPolicy {
+ private final boolean result;
+
+ public TestTriggeringPolicy(boolean result) {
+ this.result = result;
+ }
+
+ public boolean isTriggeringEvent(Appender appender, LoggingEvent event,
+ String filename, long fileLength) {
+ return result;
+ }
+
+ public void activateOptions() {
+ //no-op
+ }
+ }
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-dev-help@logging.apache.org