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  
21  import org.apache.logging.log4j.core.LogEvent;
22  import org.apache.logging.log4j.core.config.plugins.Plugin;
23  import org.apache.logging.log4j.core.config.plugins.PluginElement;
24  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
25  
26  /**
27   * Triggering policy that wraps other policies.
28   */
29  @Plugin(name = "Policies", category = "Core", printObject = true)
30  public final class CompositeTriggeringPolicy implements TriggeringPolicy {
31  
32      private final TriggeringPolicy[] triggeringPolicy;
33  
34      private CompositeTriggeringPolicy(final TriggeringPolicy... policies) {
35          this.triggeringPolicy = policies;
36      }
37  
38      public TriggeringPolicy[] getTriggeringPolicies() {
39          return triggeringPolicy;
40      }
41  
42      /**
43       * Initializes the policy.
44       * @param manager The RollingFileManager.
45       */
46      @Override
47      public void initialize(final RollingFileManager manager) {
48          for (final TriggeringPolicy policy : triggeringPolicy) {
49              policy.initialize(manager);
50          }
51      }
52  
53      /**
54       * Determines if a rollover should occur.
55       * @param event A reference to the currently event.
56       * @return true if a rollover should occur, false otherwise.
57       */
58      @Override
59      public boolean isTriggeringEvent(final LogEvent event) {
60          for (final TriggeringPolicy policy : triggeringPolicy) {
61              if (policy.isTriggeringEvent(event)) {
62                  return true;
63              }
64          }
65          return false;
66      }
67  
68      /**
69       * Create a CompositeTriggeringPolicy.
70       * @param policies The triggering policies.
71       * @return A CompositeTriggeringPolicy.
72       */
73      @PluginFactory
74      public static CompositeTriggeringPolicy createPolicy(
75                                                  @PluginElement("Policies") final TriggeringPolicy... policies) {
76          return new CompositeTriggeringPolicy(policies);
77      }
78  
79      @Override
80      public String toString() {
81          return "CompositeTriggeringPolicy(policies=" + Arrays.toString(triggeringPolicy) + ")";
82      }
83  
84  }