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;
18  
19  import org.apache.logging.log4j.core.Filter;
20  import org.apache.logging.log4j.core.Layout;
21  import org.apache.logging.log4j.core.LogEvent;
22  import org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy;
23  import org.apache.logging.log4j.core.appender.rolling.RollingFileManager;
24  import org.apache.logging.log4j.core.appender.rolling.RolloverStrategy;
25  import org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy;
26  import org.apache.logging.log4j.core.config.Configuration;
27  import org.apache.logging.log4j.core.config.plugins.Plugin;
28  import org.apache.logging.log4j.core.config.plugins.PluginAttr;
29  import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
30  import org.apache.logging.log4j.core.config.plugins.PluginElement;
31  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
32  import org.apache.logging.log4j.core.layout.PatternLayout;
33  
34  /**
35   * An appender that writes to files andd can roll over at intervals.
36   */
37  @Plugin(name = "RollingFile", type = "Core", elementType = "appender", printObject = true)
38  public final class RollingFileAppender extends AbstractOutputStreamAppender {
39  
40      private final String fileName;
41      private final String filePattern;
42      private final TriggeringPolicy policy;
43      private final RolloverStrategy strategy;
44  
45      private RollingFileAppender(String name, Layout layout, TriggeringPolicy policy, RolloverStrategy strategy,
46                                 Filter filter, RollingFileManager manager, String fileName, String filePattern,
47                                 boolean handleException, boolean immediateFlush) {
48          super(name, layout, filter, handleException, immediateFlush, manager);
49          this.fileName = fileName;
50          this.filePattern = filePattern;
51          this.policy = policy;
52          this.strategy = strategy;
53          policy.initialize(manager);
54      }
55  
56      /**
57       * Write the log entry rolling over the file when required.
58  
59       * @param event The LogEvent.
60       */
61      @Override
62      public void append(LogEvent event) {
63          ((RollingFileManager) getManager()).checkRollover(event, policy, strategy);
64          super.append(event);
65      }
66  
67      /**
68       * Returns the File name for the Appender.
69       * @return The file name.
70       */
71      public String getFileName() {
72          return fileName;
73      }
74  
75      /**
76       * Returns the file pattern used when rolling over.
77       * @return The file pattern.
78       */
79      public String getFilePattern() {
80          return filePattern;
81      }
82  
83      /**
84       * Create a RollingFileAppender.
85       * @param fileName The name of the file that is actively written to. (required).
86       * @param filePattern The pattern of the file name to use on rollover. (required).
87       * @param append If true, events are appended to the file. If false, the file
88       * is overwritten when opened. Defaults to "true"
89       * @param name The name of the Appender (required).
90       * @param bufferedIO When true, I/O will be buffered. Defaults to "true".
91       * @param immediateFlush When true, events are immediately flushed. Defaults to "true".
92       * @param policy The triggering policy. (required).
93       * @param strategy The rollover strategy. Defaults to DefaultRolloverStrategy.
94       * @param layout The layout to use (defaults to the default PatternLayout).
95       * @param filter The Filter or null.
96       * @param suppress "true" if exceptions should be hidden from the application, "false" otherwise.
97       * The default is "true".
98       * @param config The Configuration.
99       * @return A RollingFileAppender.
100      */
101     @PluginFactory
102     public static RollingFileAppender createAppender(@PluginAttr("fileName") String fileName,
103                                               @PluginAttr("filePattern") String filePattern,
104                                               @PluginAttr("append") String append,
105                                               @PluginAttr("name") String name,
106                                               @PluginAttr("bufferedIO") String bufferedIO,
107                                               @PluginAttr("immediateFlush") String immediateFlush,
108                                               @PluginElement("policy") TriggeringPolicy policy,
109                                               @PluginElement("strategy") RolloverStrategy strategy,
110                                               @PluginElement("layout") Layout layout,
111                                               @PluginElement("filter") Filter filter,
112                                               @PluginAttr("suppressExceptions") String suppress,
113                                               @PluginConfiguration Configuration config) {
114 
115         boolean isAppend = append == null ? true : Boolean.valueOf(append);
116         boolean handleExceptions = suppress == null ? true : Boolean.valueOf(suppress);
117         boolean isBuffered = bufferedIO == null ? true : Boolean.valueOf(bufferedIO);
118         boolean isFlush = immediateFlush == null ? true : Boolean.valueOf(immediateFlush);
119 
120         if (name == null) {
121             LOGGER.error("No name provided for FileAppender");
122             return null;
123         }
124 
125         if (fileName == null) {
126             LOGGER.error("No filename was provided for FileAppender with name "  + name);
127             return null;
128         }
129 
130         if (filePattern == null) {
131             LOGGER.error("No filename pattern provided for FileAppender with name "  + name);
132             return null;
133         }
134 
135         if (policy == null) {
136             LOGGER.error("A TriggeringPolicy must be provided");
137             return null;
138         }
139 
140         if (strategy == null) {
141             strategy = DefaultRolloverStrategy.createStrategy(null, null, config);
142         }
143 
144         RollingFileManager manager = RollingFileManager.getFileManager(fileName, filePattern, isAppend, isBuffered);
145         if (manager == null) {
146             return null;
147         }
148 
149         if (layout == null) {
150             layout = PatternLayout.createLayout(null, null, null, null);
151         }
152 
153         return new RollingFileAppender(name, layout, policy, strategy, filter, manager, fileName, filePattern,
154             handleExceptions, isFlush);
155     }
156 }