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: * Hierarchical rotation strategy.
061: * This object is initialised with several rotation strategy objects.
062: * The <code>isRotationNeeded</code> method checks the first rotation
063: * strategy object. If a rotation is needed, this result is returned.
064: * If not, the next rotation strategy object is checked, and so on.
065: *
066: * @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
067: */
068: public class OrRotateStrategy implements RotateStrategy {
069: private RotateStrategy[] m_strategies;
070:
071: /** The rotation strategy used. This marker is required for the reset()
072: * method.
073: */
074: private int m_usedRotation = -1;
075:
076: /**
077: * Constructor
078: * @param strategies the set of rotation strategies
079: */
080: public OrRotateStrategy(final RotateStrategy[] strategies) {
081: this .m_strategies = strategies;
082: }
083:
084: /**
085: * reset.
086: */
087: public void reset() {
088: for (int i = 0; i < m_strategies.length; i++) {
089: m_strategies[i].reset();
090: }
091: }
092:
093: /**
094: * check if now a log rotation is neccessary.
095: * This object is initialised with several rotation strategy objects.
096: * The <code>isRotationNeeded</code> method checks the first rotation
097: * strategy object. If a rotation is needed, this result is returned.
098: * If not the next rotation strategy object is asked and so on.
099: * @param data the last message written to the log system
100: * @param file ???
101: * @return boolean return true if log rotation is neccessary, else false
102: */
103: public boolean isRotationNeeded(final String data, final File file) {
104: m_usedRotation = -1;
105:
106: if (null != m_strategies) {
107: final int length = m_strategies.length;
108: for (int i = 0; i < length; i++) {
109: if (true == m_strategies[i]
110: .isRotationNeeded(data, file)) {
111: m_usedRotation = i;
112: return true;
113: }
114: }
115: }
116:
117: return false;
118: }
119: }
|