View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.appender.rolling;
18  
19  import java.util.Arrays;
20  import java.util.concurrent.TimeUnit;
21  
22  import org.apache.logging.log4j.core.Core;
23  import org.apache.logging.log4j.core.LifeCycle;
24  import org.apache.logging.log4j.core.LifeCycle2;
25  import org.apache.logging.log4j.core.LogEvent;
26  import org.apache.logging.log4j.core.config.plugins.Plugin;
27  import org.apache.logging.log4j.core.config.plugins.PluginElement;
28  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
29  
30  /**
31   * Triggering policy that wraps other triggering policies.
32   */
33  @Plugin(name = "Policies", category = Core.CATEGORY_NAME, printObject = true)
34  public final class CompositeTriggeringPolicy extends AbstractTriggeringPolicy {
35  
36      private final TriggeringPolicy[] triggeringPolicies;
37  
38      private CompositeTriggeringPolicy(final TriggeringPolicy... triggeringPolicies) {
39          this.triggeringPolicies = triggeringPolicies;
40      }
41  
42      public TriggeringPolicy[] getTriggeringPolicies() {
43          return triggeringPolicies;
44      }
45  
46      /**
47       * Initializes the policy.
48       * @param manager The RollingFileManager.
49       */
50      @Override
51      public void initialize(final RollingFileManager manager) {
52          for (final TriggeringPolicy triggeringPolicy : triggeringPolicies) {
53              LOGGER.debug("Initializing triggering policy {}", triggeringPolicy.toString());
54              triggeringPolicy.initialize(manager);
55          }
56      }
57  
58      /**
59       * Determines if a rollover should occur.
60       * @param event A reference to the currently event.
61       * @return true if a rollover should occur, false otherwise.
62       */
63      @Override
64      public boolean isTriggeringEvent(final LogEvent event) {
65          for (final TriggeringPolicy triggeringPolicy : triggeringPolicies) {
66              if (triggeringPolicy.isTriggeringEvent(event)) {
67                  return true;
68              }
69          }
70          return false;
71      }
72  
73      /**
74       * Creates a CompositeTriggeringPolicy.
75       * @param triggeringPolicy The triggering policies.
76       * @return A CompositeTriggeringPolicy.
77       */
78      @PluginFactory
79      public static CompositeTriggeringPolicy createPolicy(
80                                                  @PluginElement("Policies") final TriggeringPolicy... triggeringPolicy) {
81          return new CompositeTriggeringPolicy(triggeringPolicy);
82      }
83  
84      @Override
85      public boolean stop(final long timeout, final TimeUnit timeUnit) {
86          setStopping();
87          boolean stopped = true;
88          for (final TriggeringPolicy triggeringPolicy : triggeringPolicies) {
89              if (triggeringPolicy instanceof LifeCycle2) {
90                  stopped &= ((LifeCycle2) triggeringPolicy).stop(timeout, timeUnit);
91              } else if (triggeringPolicy instanceof LifeCycle) {
92                  ((LifeCycle) triggeringPolicy).stop();
93                  stopped &= true;
94              }
95          }
96          setStopped();
97          return stopped;
98      }
99  
100     @Override
101     public String toString() {
102         return "CompositeTriggeringPolicy(policies=" + Arrays.toString(triggeringPolicies) + ")";
103     }
104 
105 }