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.rotate;
056:
057: import java.io.File;
058: import java.io.IOException;
059: import org.apache.log.format.Formatter;
060: import org.apache.log.output.io.FileTarget;
061:
062: /**
063: * This is a basic Output log target that writes to rotating files.
064: *
065: * @author <a href="mailto:peter@apache.org">Peter Donald</a>
066: * @author <a href="mailto:mcconnell@osm.net">Stephen McConnell</a>
067: * @author <a href="mailto:bh22351@i-one.at">Bernhard Huber</a>
068: */
069: public class RotatingFileTarget extends FileTarget {
070: ///Flag indicating whether or not file should be appended to
071: private boolean m_append;
072:
073: ///The rotation strategy to be used.
074: private RotateStrategy m_rotateStrategy;
075:
076: ///The file strategy to be used.
077: private FileStrategy m_fileStrategy;
078:
079: /**
080: * Construct RotatingFileTarget object.
081: *
082: * @param formatter Formatter to be used
083: * @param rotateStrategy RotateStrategy to be used
084: * @param fileStrategy FileStrategy to be used
085: * @exception IOException if a file access or write related error occurs
086: */
087: public RotatingFileTarget(final Formatter formatter,
088: final RotateStrategy rotateStrategy,
089: final FileStrategy fileStrategy) throws IOException {
090: this (false, formatter, rotateStrategy, fileStrategy);
091: }
092:
093: /**
094: * Construct RotatingFileTarget object.
095: *
096: * @param append true if file is to be appended to, false otherwise
097: * @param formatter Formatter to be used
098: * @param rotateStrategy RotateStrategy to be used
099: * @param fileStrategy FileStrategy to be used
100: * @exception IOException if a file access or write related error occurs
101: */
102: public RotatingFileTarget(final boolean append,
103: final Formatter formatter,
104: final RotateStrategy rotateStrategy,
105: final FileStrategy fileStrategy) throws IOException {
106: super (null, append, formatter);
107:
108: m_append = append;
109: m_rotateStrategy = rotateStrategy;
110: m_fileStrategy = fileStrategy;
111:
112: rotate();
113: }
114:
115: /**
116: * Rotates the file.
117: * @exception IOException if a file access or write related error occurs
118: */
119: protected synchronized void rotate() throws IOException {
120: close();
121:
122: final File file = m_fileStrategy.nextFile();
123: setFile(file, m_append);
124: openFile();
125: }
126:
127: /**
128: * Output the log message, and check if rotation is needed.
129: * @param data the date to write to the target
130: */
131: protected synchronized void write(final String data) {
132: // if rotation is needed, close old File, create new File
133: if (m_rotateStrategy.isRotationNeeded(data, getFile())) {
134: try {
135: rotate();
136:
137: m_rotateStrategy.reset();
138: } catch (final IOException ioe) {
139: getErrorHandler().error("Error rotating file", ioe,
140: null);
141: }
142: }
143:
144: // write the log message
145: super.write(data);
146: }
147: }
|