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  
18  package org.apache.logging.log4j.io;
19  
20  import java.io.FilterOutputStream;
21  import java.io.IOException;
22  import java.io.OutputStream;
23  import java.nio.charset.Charset;
24  
25  import org.apache.logging.log4j.Level;
26  import org.apache.logging.log4j.Marker;
27  import org.apache.logging.log4j.io.internal.InternalFilterOutputStream;
28  import org.apache.logging.log4j.spi.ExtendedLogger;
29  
30  /**
31   * Logs each line written to a pre-defined level. Can also be configured with a Marker. This class provides an interface
32   * that follows the {@link java.io.OutputStream} methods in spirit, but doesn't require output to any external stream.
33   * This class should <em>not</em> be used as a stream for an underlying logger unless it's being used as a bridge.
34   * Otherwise, infinite loops may occur!
35   *
36   * @since 2.1
37   */
38  public class LoggerFilterOutputStream extends FilterOutputStream {
39      private static final String FQCN = LoggerFilterOutputStream.class.getName();
40  
41      private final InternalFilterOutputStream logger;
42  
43      protected LoggerFilterOutputStream(final OutputStream out, final Charset charset, final ExtendedLogger logger,
44                                         final String fqcn, final Level level, final Marker marker) {
45          super(out);
46          this.logger = new InternalFilterOutputStream(out, charset, logger, fqcn == null ? FQCN : fqcn,
47              level, marker);
48      }
49  
50      @Override
51      public void close() throws IOException {
52          this.logger.close();
53      }
54  
55      @Override
56      public void flush() throws IOException {
57          this.logger.flush();
58      }
59  
60      @Override
61      public String toString() {
62          return LoggerFilterOutputStream.class.getSimpleName() + logger.toString();
63      }
64  
65      @Override
66      public void write(final byte[] b) throws IOException {
67          this.logger.write(b);
68      }
69  
70      @Override
71      public void write(final byte[] b, final int off, final int len) throws IOException {
72          this.logger.write(b, off, len);
73      }
74  
75      @Override
76      public void write(final int b) throws IOException {
77          this.logger.write(b);
78      }
79  }