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 org.apache.logging.log4j.core.LogEvent;
20  import org.apache.logging.log4j.core.config.plugins.Plugin;
21  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
22  
23  import java.lang.management.ManagementFactory;
24  
25  /**
26   * Trigger a rollover on every restart. The target file's timestamp is compared with the JVM start time
27   * and if it is older isTriggeringEvent will return true. After isTriggeringEvent has been called it will
28   * always return false.
29   */
30  
31  @Plugin(name = "OnStartupTriggeringPolicy", type = "Core", printObject = true)
32  public class OnStartupTriggeringPolicy implements TriggeringPolicy {
33      private static final long JVM_START_TIME = ManagementFactory.getRuntimeMXBean().getStartTime();
34  
35      private boolean evaluated = false;
36  
37      private RollingFileManager manager;
38  
39      /**
40       * Provide the RollingFileManager to the policy.
41       * @param manager The RollingFileManager.
42       */
43      public void initialize(RollingFileManager manager) {
44          this.manager = manager;
45      }
46  
47      /**
48       * Determine if a rollover should be triggered.
49       * @param event   A reference to the current event.
50       * @return true if the target file's timestamp is older than the JVM start time.
51       */
52      public boolean isTriggeringEvent(LogEvent event) {
53          if (evaluated) {
54              return false;
55          }
56          evaluated = true;
57          return manager.getFileTime() < JVM_START_TIME;
58      }
59  
60      @Override
61      public String toString() {
62          return "OnStartupTriggeringPolicy";
63      }
64  
65      @PluginFactory
66      public static OnStartupTriggeringPolicy createPolicy() {
67          return new OnStartupTriggeringPolicy();
68      }
69  }