001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.logging.log4j.io;
019
020import java.io.FilterOutputStream;
021import java.io.IOException;
022import java.io.OutputStream;
023import java.nio.charset.Charset;
024
025import org.apache.logging.log4j.Level;
026import org.apache.logging.log4j.Marker;
027import org.apache.logging.log4j.io.internal.InternalFilterOutputStream;
028import org.apache.logging.log4j.spi.ExtendedLogger;
029
030/**
031 * Logs each line written to a pre-defined level. Can also be configured with a Marker. This class provides an interface
032 * that follows the {@link java.io.OutputStream} methods in spirit, but doesn't require output to any external stream.
033 * This class should <em>not</em> be used as a stream for an underlying logger unless it's being used as a bridge.
034 * Otherwise, infinite loops may occur!
035 *
036 * @since 2.1
037 */
038public class LoggerFilterOutputStream extends FilterOutputStream {
039    private static final String FQCN = LoggerFilterOutputStream.class.getName();
040
041    private final InternalFilterOutputStream logger;
042
043    protected LoggerFilterOutputStream(final OutputStream out, final Charset charset, final ExtendedLogger logger,
044                                       final String fqcn, final Level level, final Marker marker) {
045        super(out);
046        this.logger = new InternalFilterOutputStream(out, charset, logger, fqcn == null ? FQCN : fqcn,
047            level, marker);
048    }
049
050    @Override
051    public void close() throws IOException {
052        this.logger.close();
053    }
054
055    @Override
056    public void flush() throws IOException {
057        this.logger.flush();
058    }
059
060    @Override
061    public String toString() {
062        return LoggerFilterOutputStream.class.getSimpleName() + logger.toString();
063    }
064
065    @Override
066    public void write(final byte[] b) throws IOException {
067        this.logger.write(b);
068    }
069
070    @Override
071    public void write(final byte[] b, final int off, final int len) throws IOException {
072        this.logger.write(b, off, len);
073    }
074
075    @Override
076    public void write(final int b) throws IOException {
077        this.logger.write(b);
078    }
079}