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.File;
058: import java.io.FileOutputStream;
059: import java.io.IOException;
060: import org.apache.log.format.Formatter;
061:
062: /**
063: * A basic target that writes to a File.
064: *
065: * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
066: * @author <a href="mailto:peter@apache.org">Peter Donald</a>
067: */
068: public class FileTarget extends StreamTarget {
069: ///File we are writing to
070: private File m_file;
071:
072: ///Flag indicating whether or not file should be appended to
073: private boolean m_append;
074:
075: /**
076: * Construct file target to write to a file with a formatter.
077: *
078: * @param file the file to write to
079: * @param append true if file is to be appended to, false otherwise
080: * @param formatter the Formatter
081: * @exception IOException if an error occurs
082: */
083: public FileTarget(final File file, final boolean append,
084: final Formatter formatter) throws IOException {
085: super (null, formatter);
086:
087: if (null != file) {
088: setFile(file, append);
089: openFile();
090: }
091: }
092:
093: /**
094: * Set the file for this target.
095: *
096: * @param file the file to write to
097: * @param append true if file is to be appended to, false otherwise
098: * @exception IOException if directories can not be created or file can not be opened
099: */
100: protected synchronized void setFile(final File file,
101: final boolean append) throws IOException {
102: if (null == file) {
103: throw new NullPointerException(
104: "file property must not be null");
105: }
106:
107: if (isOpen()) {
108: throw new IOException("target must be closed before "
109: + "file property can be set");
110: }
111:
112: m_append = append;
113: m_file = file;
114: }
115:
116: /**
117: * Open underlying file and allocate resources.
118: * This method will attempt to create directories below file and
119: * append to it if specified.
120: * @exception IOException if directories can not be created or file can not be opened
121: */
122: protected synchronized void openFile() throws IOException {
123: if (isOpen()) {
124: close();
125: }
126:
127: final File file = getFile().getCanonicalFile();
128:
129: final File parent = file.getParentFile();
130: if (null != parent && !parent.exists()) {
131: parent.mkdirs();
132: }
133:
134: final FileOutputStream outputStream = new FileOutputStream(file
135: .getPath(), m_append);
136:
137: setOutputStream(outputStream);
138: open();
139: }
140:
141: /**
142: * Retrieve file associated with target.
143: * This allows subclasses to access file object.
144: *
145: * @return the output File
146: */
147: protected synchronized File getFile() {
148: return m_file;
149: }
150: }
|