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