001: /* ====================================================================
002: * The Apache Software License, Version 1.1
003: *
004: * Copyright (c) 1997-2003 The Apache Software Foundation. All rights
005: * reserved.
006: *
007: * Redistribution and use in source and binary forms, with or without
008: * modification, are permitted provided that the following conditions
009: * are met:
010: *
011: * 1. Redistributions of source code must retain the above copyright
012: * notice, this list of conditions and the following disclaimer.
013: *
014: * 2. Redistributions in binary form must reproduce the above copyright
015: * notice, this list of conditions and the following disclaimer in
016: * the documentation and/or other materials provided with the
017: * distribution.
018: *
019: * 3. The end-user documentation included with the redistribution,
020: * if any, must include the following acknowledgment:
021: * "This product includes software developed by the
022: * Apache Software Foundation (http://www.apache.org/)."
023: * Alternately, this acknowledgment may appear in the software
024: * itself, if and wherever such third-party acknowledgments
025: * normally appear.
026: *
027: * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
028: * must not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation. For more
052: * information on the Apache Software Foundation, please see
053: * <http://www.apache.org/>.
054: */
055: package org.apache.log.output.io;
056:
057: import java.io.IOException;
058: import java.io.Writer;
059: import org.apache.log.format.Formatter;
060: import org.apache.log.output.AbstractOutputTarget;
061:
062: /**
063: * This target outputs to a writer.
064: *
065: * @author <a href="mailto:peter@apache.org">Peter Donald</a>
066: */
067: public class WriterTarget extends AbstractOutputTarget {
068: /**
069: * @deprecated Accessing this variable in subclasses is no longer supported
070: * and will become private in the future.
071: */
072: protected Writer m_output;
073:
074: /**
075: * Construct target with a specific writer and formatter.
076: *
077: * @param writer the writer
078: * @param formatter the formatter
079: */
080: public WriterTarget(final Writer writer, final Formatter formatter) {
081: super (formatter);
082:
083: if (null != writer) {
084: setWriter(writer);
085: open();
086: }
087: }
088:
089: /**
090: * Set the writer.
091: * Close down writer and write tail if appropriate.
092: *
093: * @param writer the new writer
094: */
095: protected synchronized void setWriter(final Writer writer) {
096: if (null == writer) {
097: throw new NullPointerException(
098: "writer property must not be null");
099: }
100:
101: m_output = writer;
102: }
103:
104: /**
105: * Concrete implementation of output that writes out to underlying writer.
106: *
107: * @param data the data to output
108: */
109: protected void write(final String data) {
110: try {
111: m_output.write(data);
112: m_output.flush();
113: } catch (final IOException ioe) {
114: getErrorHandler().error("Caught an IOException", ioe, null);
115: }
116: }
117:
118: /**
119: * Shutdown target.
120: * Attempting to write to target after close() will cause errors to be logged.
121: */
122: public synchronized void close() {
123: super .close();
124: shutdownWriter();
125: }
126:
127: /**
128: * Shutdown Writer.
129: */
130: protected synchronized void shutdownWriter() {
131: final Writer writer = m_output;
132: m_output = null;
133:
134: try {
135: if (null != writer) {
136: writer.close();
137: }
138: } catch (final IOException ioe) {
139: getErrorHandler().error("Error closing Writer", ioe, null);
140: }
141: }
142: }
|