/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements. See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You under the Apache license, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License. You may obtain a copy of the License at
    *
    *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the license for the specific language governing permissions and
   * limitations under the license.
   */
  package org.apache.logging.log4j.core.appender;
  
  import java.io.OutputStream;
  import java.io.Serializable;
  
  import org.apache.logging.log4j.core.Appender;
  import org.apache.logging.log4j.core.Filter;
  import org.apache.logging.log4j.core.Layout;
  import org.apache.logging.log4j.core.config.plugins.Plugin;
  import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
  import org.apache.logging.log4j.core.layout.PatternLayout;
  import org.apache.logging.log4j.core.util.CloseShieldOutputStream;
  
  /**
   * Appends log events to a given output stream using a layout.
   * <p>
   * Character encoding is handled within the Layout.
   * </p>
   */
  @Plugin(name = "OutputStream", category = "Core", elementType = Appender.ELEMENT_TYPE, printObject = true)
  public final class OutputStreamAppender extends AbstractOutputStreamAppender<OutputStreamManager> {
  
      /**
       * Builds OutputStreamAppender instances.
       */
      public static class Builder implements org.apache.logging.log4j.core.util.Builder<OutputStreamAppender> {
  
          private Filter filter;
  
          private boolean follow = false;
  
          private boolean ignoreExceptions = true;
  
          private Layout<? extends Serializable> layout = PatternLayout.createDefaultLayout();
  
          private String name;
  
          private OutputStream target;
  
          @Override
          public OutputStreamAppender build() {
              return new OutputStreamAppender(name, layout, filter, getManager(target, follow, layout), ignoreExceptions);
          }
  
          public Builder setFilter(final Filter aFilter) {
              this.filter = aFilter;
              return this;
          }
  
          public Builder setFollow(final boolean shouldFollow) {
              this.follow = shouldFollow;
              return this;
          }
  
          public Builder setIgnoreExceptions(final boolean shouldIgnoreExceptions) {
              this.ignoreExceptions = shouldIgnoreExceptions;
              return this;
          }
  
          public Builder setLayout(final Layout<? extends Serializable> aLayout) {
              this.layout = aLayout;
              return this;
          }
  
          public Builder setName(final String aName) {
              this.name = aName;
              return this;
          }
  
          public Builder setTarget(final OutputStream aTarget) {
              this.target = aTarget;
              return this;
          }
      }
      /**
       * Holds data to pass to factory method.
       */
      private static class FactoryData {
          private final Layout<? extends Serializable> layout;
          private final String name;
          private final OutputStream os;
  
         /**
          * Builds instances.
          * 
          * @param os
          *            The OutputStream.
          * @param type
          *            The name of the target.
          * @param layout
          *            A Serializable layout
          */
         public FactoryData(final OutputStream os, final String type, final Layout<? extends Serializable> layout) {
             this.os = os;
             this.name = type;
             this.layout = layout;
         }
     }
 
     /**
      * Creates the manager.
      */
     private static class OutputStreamManagerFactory implements ManagerFactory<OutputStreamManager, FactoryData> {
 
         /**
          * Creates an OutputStreamManager.
          * 
          * @param name
          *            The name of the entity to manage.
          * @param data
          *            The data required to create the entity.
          * @return The OutputStreamManager
          */
         @Override
         public OutputStreamManager createManager(final String name, final FactoryData data) {
             return new OutputStreamManager(data.os, data.name, data.layout, true);
         }
     }
 
     private static OutputStreamManagerFactory factory = new OutputStreamManagerFactory();
 
     /**
      * Creates an OutputStream Appender.
      * 
      * @param layout
      *            The layout to use or null to get the default layout.
      * @param filter
      *            The Filter or null.
      * @param target
      *            an output stream.
      * @param follow
      *            If true will follow changes to the underlying output stream.
      *            Use false as the default.
      * @param name
      *            The name of the Appender (required).
      * @param ignore
      *            If {@code "true"} (default) exceptions encountered when
      *            appending events are logged; otherwise they are propagated to
      *            the caller. Use true as the default.
      * @return The ConsoleAppender.
      */
     @PluginFactory
     public static OutputStreamAppender createAppender(Layout<? extends Serializable> layout, final Filter filter,
             final OutputStream target, final String name, final boolean follow, final boolean ignore) {
         if (name == null) {
             LOGGER.error("No name provided for OutputStreamAppender");
             return null;
         }
         if (layout == null) {
             layout = PatternLayout.createDefaultLayout();
         }
         return new OutputStreamAppender(name, layout, filter, getManager(target, follow, layout), ignore);
     }
 
     private static OutputStreamManager getManager(final OutputStream target, final boolean follow,
             final Layout<? extends Serializable> layout) {
         final OutputStream os = new CloseShieldOutputStream(target);
         final String managerName = target.getClass().getName() + "@" + Integer.toHexString(target.hashCode()) + '.'
                 + follow;
         return OutputStreamManager.getManager(managerName, new FactoryData(os, managerName, layout), factory);
     }
 
     @PluginBuilderFactory
     public static Builder newBuilder() {
         return new Builder();
     }
 
     private OutputStreamAppender(final String name, final Layout<? extends Serializable> layout, final Filter filter,
             final OutputStreamManager manager, final boolean ignoreExceptions) {
         super(name, layout, filter, ignoreExceptions, true, manager);
     }
 
 }