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:
059: /**
060: * rotation stragety based when log writting started.
061: *
062: * @author <a href="mailto:bh22351@i-one.at">Bernhard Huber</a>
063: */
064: public class RotateStrategyByTime implements RotateStrategy {
065: ///time interval when rotation is triggered.
066: private long m_timeInterval;
067:
068: ///time when logging started.
069: private long m_startingTime;
070:
071: ///rotation count.
072: private long m_currentRotation;
073:
074: /**
075: * Rotate logs by time.
076: * By default do log rotation every 24 hours
077: */
078: public RotateStrategyByTime() {
079: this (1000 * 60 * 60 * 24);
080: }
081:
082: /**
083: * Rotate logs by time.
084: *
085: * @param timeInterval rotate before time-interval [ms] has expired
086: */
087: public RotateStrategyByTime(final long timeInterval) {
088: m_startingTime = System.currentTimeMillis();
089: m_currentRotation = 0;
090: m_timeInterval = timeInterval;
091: }
092:
093: /**
094: * reset interval history counters.
095: */
096: public void reset() {
097: m_startingTime = System.currentTimeMillis();
098: m_currentRotation = 0;
099: }
100:
101: /**
102: * Check if now a log rotation is neccessary.
103: * If
104: * <code>(current_time - m_startingTime) / m_timeInterval > m_currentRotation </code>
105: * rotation is needed.
106: *
107: * @param data the last message written to the log system
108: * @param file not used
109: * @return boolean return true if log rotation is neccessary, else false
110: */
111: public boolean isRotationNeeded(final String data, final File file) {
112: final long newRotation = (System.currentTimeMillis() - m_startingTime)
113: / m_timeInterval;
114:
115: if (newRotation > m_currentRotation) {
116: m_currentRotation = newRotation;
117: return true;
118: } else {
119: return false;
120: }
121: }
122: }
|