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