001: package com.protomatter.syslog;
002:
003: /**
004: * {{{ The Protomatter Software License, Version 1.0
005: * derived from The Apache Software License, Version 1.1
006: *
007: * Copyright (c) 1998-2002 Nate Sammons. All rights reserved.
008: *
009: * Redistribution and use in source and binary forms, with or without
010: * modification, are permitted provided that the following conditions
011: * are met:
012: *
013: * 1. Redistributions of source code must retain the above copyright
014: * notice, this list of conditions and the following disclaimer.
015: *
016: * 2. Redistributions in binary form must reproduce the above copyright
017: * notice, this list of conditions and the following disclaimer in
018: * the documentation and/or other materials provided with the
019: * distribution.
020: *
021: * 3. The end-user documentation included with the redistribution,
022: * if any, must include the following acknowledgment:
023: * "This product includes software developed for the
024: * Protomatter Software Project
025: * (http://protomatter.sourceforge.net/)."
026: * Alternately, this acknowledgment may appear in the software itself,
027: * if and wherever such third-party acknowledgments normally appear.
028: *
029: * 4. The names "Protomatter" and "Protomatter Software Project" must
030: * not be used to endorse or promote products derived from this
031: * software without prior written permission. For written
032: * permission, please contact support@protomatter.com.
033: *
034: * 5. Products derived from this software may not be called "Protomatter",
035: * nor may "Protomatter" appear in their name, without prior written
036: * permission of the Protomatter Software Project
037: * (support@protomatter.com).
038: *
039: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
040: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
041: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
042: * DISCLAIMED. IN NO EVENT SHALL THE PROTOMATTER SOFTWARE PROJECT OR
043: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
044: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
045: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
046: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
047: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
048: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
049: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
050: * SUCH DAMAGE. }}}
051: */
052:
053: import java.io.PrintWriter;
054: import java.util.*;
055: import java.text.*;
056: import java.io.*;
057: import java.net.*;
058:
059: import com.protomatter.util.*;
060:
061: /**
062: * The interface for the pluggable text formatting system. It is used
063: * to format log entries by subclasses of the <tt>BasicLogger</tt>
064: * logger.
065: *
066: * @see SimpleSyslogTextFormatter
067: */
068: public interface SyslogTextFormatter {
069: /**
070: * Format the given log entry. The time given is formatted according
071: * to the date format and timezone set in the <tt>BasicLogger</tt>
072: * class.
073: */
074: public void formatLogEntry(StringBuffer b, SyslogMessage message);
075:
076: /**
077: * Format the given log message's detail.
078: */
079: public void formatMessageDetail(StringBuffer b,
080: SyslogMessage message);
081:
082: /**
083: * Get the header text that should be included at the
084: * top of each log file.
085: */
086: public String getLogHeader();
087:
088: /**
089: * Get the footer text that should be included at the
090: * bottom of each log file.
091: */
092: public String getLogFooter();
093:
094: /**
095: * Reset the formatter's date format. This method is used by
096: * rolling log implementations so that the date is always
097: * correct, even if the formatter is caching dates, which is
098: * recomended.
099: */
100: public void resetDateFormat();
101: }
|