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.text.SimpleDateFormat;
059: import java.util.Date;
060:
061: /**
062: * Strategy for naming log files based on appending time suffix.
063: * A file name can be based on simply appending the number of miliseconds
064: * since (not really sure) 1/1/1970.
065: * Other constructors accept a pattern of a <code>SimpleDateFormat</code>
066: * to form the appended string to the base file name as well as a suffix
067: * which should be appended last.
068: *
069: * A <code>new UniqueFileStrategy( new File( "foo." ), "yyyy-MM-dd", ".log" )</code>
070: * object will return <code>File</code> objects with file names like
071: * <code>foo.2001-12-24.log</code>
072: *
073: * @author <a href="mailto:bh22351@i-one.at">Bernhard Huber</a>
074: * @author <a href="mailto:giacomo@apache.org">Giacomo Pati</a>
075: */
076: public class UniqueFileStrategy implements FileStrategy {
077: private File m_baseFile;
078:
079: private SimpleDateFormat m_formatter;
080:
081: private String m_suffix;
082:
083: /**
084: * Creation of a new Unique File Strategy ??
085: * @param baseFile the base file
086: */
087: public UniqueFileStrategy(final File baseFile) {
088: m_baseFile = baseFile;
089: }
090:
091: /**
092: * Creation of a new Unique File Strategy ??
093: * @param baseFile the base file
094: * @param pattern the format pattern
095: */
096: public UniqueFileStrategy(final File baseFile, String pattern) {
097: this (baseFile);
098: m_formatter = new SimpleDateFormat(pattern);
099: }
100:
101: /**
102: * Creation of a new Unique File Strategy ??
103: * @param baseFile the base file
104: * @param pattern the format pattern
105: * @param suffix the suffix ??
106: */
107: public UniqueFileStrategy(final File baseFile, String pattern,
108: String suffix) {
109: this (baseFile, pattern);
110: m_suffix = suffix;
111: }
112:
113: /**
114: * Calculate the real file name from the base filename.
115: *
116: * @return File the calculated file name
117: */
118: public File nextFile() {
119: final StringBuffer sb = new StringBuffer();
120: sb.append(m_baseFile);
121: if (m_formatter == null) {
122: sb.append(System.currentTimeMillis());
123: } else {
124: final String dateString = m_formatter.format(new Date());
125: sb.append(dateString);
126: }
127:
128: if (m_suffix != null) {
129: sb.append(m_suffix);
130: }
131:
132: return new File(sb.toString());
133: }
134: }
|