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.FilterWriter;
021import java.io.IOException;
022import java.io.Writer;
023
024import org.apache.logging.log4j.Level;
025import org.apache.logging.log4j.Marker;
026import org.apache.logging.log4j.spi.ExtendedLogger;
027
028/**
029 * Logs each line written to a pre-defined level. Can also be configured with a Marker. This class provides an interface
030 * that follows the {@link java.io.Writer} methods in spirit, but doesn't require output to any external out.
031 * 
032 * @since 2.1
033 */
034public class LoggerFilterWriter extends FilterWriter {
035    private static final String FQCN = LoggerFilterWriter.class.getName();
036
037    private final CharStreamLogger logger;
038    private final String fqcn;
039
040    protected LoggerFilterWriter(final Writer out, final ExtendedLogger logger, final String fqcn, final Level level,
041                                 final Marker marker) {
042        super(out);
043        this.logger = new CharStreamLogger(logger, level, marker);
044        this.fqcn = fqcn == null ? FQCN : fqcn;
045    }
046
047    @Override
048    public void close() throws IOException {
049        this.out.close();
050        this.logger.close(this.fqcn);
051    }
052
053    @Override
054    public void flush() throws IOException {
055        this.out.flush();
056    }
057
058    @Override
059    public String toString() {
060        return LoggerFilterWriter.class.getSimpleName() + "{writer=" + this.out + '}';
061    }
062
063    @Override
064    public void write(final char[] cbuf) throws IOException {
065        this.out.write(cbuf);
066        this.logger.put(this.fqcn, cbuf, 0, cbuf.length);
067    }
068
069    @Override
070    public void write(final char[] cbuf, final int off, final int len) throws IOException {
071        this.out.write(cbuf, off, len);
072        this.logger.put(this.fqcn, cbuf, off, len);
073    }
074
075    @Override
076    public void write(final int c) throws IOException {
077        this.out.write(c);
078        this.logger.put(this.fqcn, (char) c);
079    }
080
081    @Override
082    public void write(final String str) throws IOException {
083        this.out.write(str);
084        this.logger.put(this.fqcn, str, 0, str.length());
085    }
086
087    @Override
088    public void write(final String str, final int off, final int len) throws IOException {
089        this.out.write(str, off, len);
090        this.logger.put(this.fqcn, str, off, len);
091    }
092}