001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache license, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the license for the specific language governing permissions and 015 * limitations under the license. 016 */ 017package org.apache.logging.log4j.core.appender.rolling; 018 019import java.util.Arrays; 020import java.util.concurrent.TimeUnit; 021 022import org.apache.logging.log4j.core.Core; 023import org.apache.logging.log4j.core.LifeCycle; 024import org.apache.logging.log4j.core.LifeCycle2; 025import org.apache.logging.log4j.core.LogEvent; 026import org.apache.logging.log4j.core.config.plugins.Plugin; 027import org.apache.logging.log4j.core.config.plugins.PluginElement; 028import org.apache.logging.log4j.core.config.plugins.PluginFactory; 029 030/** 031 * Triggering policy that wraps other triggering policies. 032 */ 033@Plugin(name = "Policies", category = Core.CATEGORY_NAME, printObject = true) 034public final class CompositeTriggeringPolicy extends AbstractTriggeringPolicy { 035 036 private final TriggeringPolicy[] triggeringPolicies; 037 038 private CompositeTriggeringPolicy(final TriggeringPolicy... triggeringPolicies) { 039 this.triggeringPolicies = triggeringPolicies; 040 } 041 042 public TriggeringPolicy[] getTriggeringPolicies() { 043 return triggeringPolicies; 044 } 045 046 /** 047 * Initializes the policy. 048 * @param manager The RollingFileManager. 049 */ 050 @Override 051 public void initialize(final RollingFileManager manager) { 052 for (final TriggeringPolicy triggeringPolicy : triggeringPolicies) { 053 LOGGER.debug("Initializing triggering policy {}", triggeringPolicy.toString()); 054 triggeringPolicy.initialize(manager); 055 } 056 } 057 058 /** 059 * Determines if a rollover should occur. 060 * @param event A reference to the currently event. 061 * @return true if a rollover should occur, false otherwise. 062 */ 063 @Override 064 public boolean isTriggeringEvent(final LogEvent event) { 065 for (final TriggeringPolicy triggeringPolicy : triggeringPolicies) { 066 if (triggeringPolicy.isTriggeringEvent(event)) { 067 return true; 068 } 069 } 070 return false; 071 } 072 073 /** 074 * Creates a CompositeTriggeringPolicy. 075 * @param triggeringPolicy The triggering policies. 076 * @return A CompositeTriggeringPolicy. 077 */ 078 @PluginFactory 079 public static CompositeTriggeringPolicy createPolicy( 080 @PluginElement("Policies") final TriggeringPolicy... triggeringPolicy) { 081 return new CompositeTriggeringPolicy(triggeringPolicy); 082 } 083 084 @Override 085 public boolean stop(final long timeout, final TimeUnit timeUnit) { 086 setStopping(); 087 boolean stopped = true; 088 for (final TriggeringPolicy triggeringPolicy : triggeringPolicies) { 089 if (triggeringPolicy instanceof LifeCycle2) { 090 stopped &= ((LifeCycle2) triggeringPolicy).stop(timeout, timeUnit); 091 } else if (triggeringPolicy instanceof LifeCycle) { 092 ((LifeCycle) triggeringPolicy).stop(); 093 stopped &= true; 094 } 095 } 096 setStopped(); 097 return stopped; 098 } 099 100 @Override 101 public String toString() { 102 return "CompositeTriggeringPolicy(policies=" + Arrays.toString(triggeringPolicies) + ")"; 103 } 104 105}