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 strategy based on size written to log file.
061: * The strategy will signal that a rotation is needed if the
062: * size goes above a set limit. Due to performance reasons
063: * the limit is not strictly enforced, however, the strategy has
064: * at most an error of the longest single data message written to the
065: * logging system. The error will occur immediately after a rotation,
066: * when the strategy is reset and the data that triggered the
067: * rotation is written. The strategy's internal counter will then
068: * be off with data.length() bytes.
069: *
070: * @author <a href="mailto:leo.sutic@inspireinfrastructure.com">Leo Sutic</a>
071: * @author <a href="mailto:bh22351@i-one.at">Bernhard Huber</a>
072: */
073: public class RotateStrategyBySize implements RotateStrategy {
074: private long m_maxSize;
075: private long m_currentSize;
076:
077: /**
078: * Rotate logs by size.
079: * By default do log rotation before writing approx. 1MB of messages
080: */
081: public RotateStrategyBySize() {
082: this (1024 * 1024);
083: }
084:
085: /**
086: * Rotate logs by size.
087: *
088: * @param maxSize rotate before writing maxSize [byte] of messages
089: */
090: public RotateStrategyBySize(final long maxSize) {
091: m_currentSize = 0;
092: m_maxSize = maxSize;
093: }
094:
095: /**
096: * Reset log size written so far.
097: */
098: public void reset() {
099: m_currentSize = 0;
100: }
101:
102: /**
103: * Check if now a log rotation is neccessary.
104: *
105: * @param data the message about to be written to the log system
106: * @return boolean return true if log rotation is neccessary, else false
107: * @param file not used
108: */
109: public boolean isRotationNeeded(final String data, final File file) {
110: m_currentSize += data.length();
111:
112: return m_currentSize >= m_maxSize;
113: }
114: }
|