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 java.io.Serializable;
    20  import java.util.HashMap;
    21  import java.util.Map;
    22
    23  import org.apache.logging.log4j.core.Filter;
    24  import org.apache.logging.log4j.core.Layout;
    25  import org.apache.logging.log4j.core.config.Configuration;
    26  import org.apache.logging.log4j.core.config.plugins.Plugin;
    27  import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
    28  import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
    29  import org.apache.logging.log4j.core.config.plugins.PluginElement;
    30  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
    31  import org.apache.logging.log4j.core.layout.PatternLayout;
    32  import org.apache.logging.log4j.core.net.Advertiser;
    33  import org.apache.logging.log4j.core.util.Booleans;
    34  import org.apache.logging.log4j.core.util.Integers;
    35
    36  /**
    37   * File Appender.
    38   */
    39  @Plugin(name = "File", category = "Core", elementType = "appender", printObject = true)
    40  public final class FileAppender extends AbstractOutputStreamAppender<FileManager> {
    41
    42      private static final long serialVersionUID = 1L;
    43      private static final int DEFAULT_BUFFER_SIZE = 8192;
    44      private final String fileName;
    45      private final Advertiser advertiser;
    46      private Object advertisement;
    47
    48      private FileAppender(final String name, final Layout<? extends Serializable> layout, final Filter filter, final FileManager manager,
    49                           final String filename, final boolean ignoreExceptions, final boolean immediateFlush,
    50                           final Advertiser advertiser) {
    51          super(name, layout, filter, ignoreExceptions, immediateFlush, manager);
    52          if (advertiser != null) {
    53              final Map<String, String> configuration = new HashMap<String, String>(layout.getContentFormat());
    54              configuration.putAll(manager.getContentFormat());
    55              configuration.put("contentType", layout.getContentType());
    56              configuration.put("name", name);
    57              advertisement = advertiser.advertise(configuration);
    58          }
    59          this.fileName = filename;
    60          this.advertiser = advertiser;
    61      }
    62
    63      @Override
    64      public void stop() {
    65          super.stop();
    66          if (advertiser != null) {
    67              advertiser.unadvertise(advertisement);
    68          }
    69      }
    70
    71      /**
    72       * Returns the file name this appender is associated with.
    73       * @return The File name.
    74       */
    75      public String getFileName() {
    76          return this.fileName;
    77      }
    78
    79      /**
    80       * Create a File Appender.
    81       * @param fileName The name and path of the file.
    82       * @param append "True" if the file should be appended to, "false" if it should be overwritten.
    83       * The default is "true".
    84       * @param locking "True" if the file should be locked. The default is "false".
    85       * @param name The name of the Appender.
    86       * @param immediateFlush "true" if the contents should be flushed on every write, "false" otherwise. The default
    87       * is "true".
    88       * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise
    89       *               they are propagated to the caller.
    90       * @param bufferedIo "true" if I/O should be buffered, "false" otherwise. The default is "true".
    91       * @param bufferSizeStr buffer size for buffered IO (default is 8192).
    92       * @param layout The layout to use to format the event. If no layout is provided the default PatternLayout
    93       * will be used.
    94       * @param filter The filter, if any, to use.
    95       * @param advertise "true" if the appender configuration should be advertised, "false" otherwise.
    96       * @param advertiseUri The advertised URI which can be used to retrieve the file contents.
    97       * @param config The Configuration
    98       * @return The FileAppender.
    99       */
    100     @PluginFactory
    101     public static FileAppender createAppender(
    102             // @formatter:off
    103             @PluginAttribute("fileName") final String fileName,
    104             @PluginAttribute("append") final String append,
    105             @PluginAttribute("locking") final String locking,
    106             @PluginAttribute("name") final String name,
    107             @PluginAttribute("immediateFlush") final String immediateFlush,
    108             @PluginAttribute("ignoreExceptions") final String ignore,
    109             @PluginAttribute("bufferedIo") final String bufferedIo,
    110             @PluginAttribute("bufferSize") final String bufferSizeStr,
    111             @PluginElement("Layout") Layout<? extends Serializable> layout,
    112             @PluginElement("Filter") final Filter filter,
    113             @PluginAttribute("advertise") final String advertise,
    114             @PluginAttribute("advertiseUri") final String advertiseUri,
    115             @PluginConfiguration final Configuration config) {
    116         // @formatter:on
    117         final boolean isAppend = Booleans.parseBoolean(append, true);
    118         final boolean isLocking = Boolean.parseBoolean(locking);
    119         boolean isBuffered = Booleans.parseBoolean(bufferedIo, true);
    120         final boolean isAdvertise = Boolean.parseBoolean(advertise);
    121         if (isLocking && isBuffered) {
    122             if (bufferedIo != null) {
    123                 LOGGER.warn("Locking and buffering are mutually exclusive. No buffering will occur for " + fileName);
    124             }
    125             isBuffered = false;
    126         }
    127         final int bufferSize = Integers.parseInt(bufferSizeStr, DEFAULT_BUFFER_SIZE);
    128         if (!isBuffered && bufferSize > 0) {
    129             LOGGER.warn("The bufferSize is set to {} but bufferedIO is not true: {}", bufferSize, bufferedIo);
    130         }
    131         final boolean isFlush = Booleans.parseBoolean(immediateFlush, true);
    132         final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);
    133
    134         if (name == null) {
    135             LOGGER.error("No name provided for FileAppender");
    136             return null;
    137         }
    138
    139         if (fileName == null) {
    140             LOGGER.error("No filename provided for FileAppender with name "  + name);
    141             return null;
    142         }
    143         if (layout == null) {
    144             layout = PatternLayout.createDefaultLayout();
    145         }
    146
    147         final FileManager manager = FileManager.getFileManager(fileName, isAppend, isLocking, isBuffered, advertiseUri,
    148             layout, bufferSize);
    149         if (manager == null) {
    150             return null;
    151         }
    152
    153         return new FileAppender(name, layout, filter, manager, fileName, ignoreExceptions, isFlush,
    154                 isAdvertise ? config.getAdvertiser() : null);
    155     }
    156 }