001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/Logger.java,v 1.3 2001/07/22 20:13:30 pier Exp $
003: * $Revision: 1.3 $
004: * $Date: 2001/07/22 20:13:30 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina;
065:
066: import java.beans.PropertyChangeListener;
067:
068: /**
069: * A <b>Logger</b> is a generic interface for the message and exception
070: * logging methods of the ServletContext interface. Loggers can be
071: * attached at any Container level, but will typically only be attached
072: * to a Context, or higher level, Container.
073: *
074: * @author Craig R. McClanahan
075: * @version $Revision: 1.3 $ $Date: 2001/07/22 20:13:30 $
076: */
077:
078: public interface Logger {
079:
080: // ----------------------------------------------------- Manifest Constants
081:
082: /**
083: * Verbosity level constants for log messages that may be filtered
084: * by the underlying logger.
085: */
086:
087: public static final int FATAL = Integer.MIN_VALUE;
088:
089: public static final int ERROR = 1;
090:
091: public static final int WARNING = 2;
092:
093: public static final int INFORMATION = 3;
094:
095: public static final int DEBUG = 4;
096:
097: // ------------------------------------------------------------- Properties
098:
099: /**
100: * Return the Container with which this Logger has been associated.
101: */
102: public Container getContainer();
103:
104: /**
105: * Set the Container with which this Logger has been associated.
106: *
107: * @param container The associated Container
108: */
109: public void setContainer(Container container);
110:
111: /**
112: * Return descriptive information about this Logger implementation and
113: * the corresponding version number, in the format
114: * <code><description>/<version></code>.
115: */
116: public String getInfo();
117:
118: /**
119: * Return the verbosity level of this logger. Messages logged with a
120: * higher verbosity than this level will be silently ignored.
121: */
122: public int getVerbosity();
123:
124: /**
125: * Set the verbosity level of this logger. Messages logged with a
126: * higher verbosity than this level will be silently ignored.
127: *
128: * @param verbosity The new verbosity level
129: */
130: public void setVerbosity(int verbosity);
131:
132: // --------------------------------------------------------- Public Methods
133:
134: /**
135: * Add a property change listener to this component.
136: *
137: * @param listener The listener to add
138: */
139: public void addPropertyChangeListener(
140: PropertyChangeListener listener);
141:
142: /**
143: * Writes the specified message to a servlet log file, usually an event
144: * log. The name and type of the servlet log is specific to the
145: * servlet container. This message will be logged unconditionally.
146: *
147: * @param message A <code>String</code> specifying the message to be
148: * written to the log file
149: */
150: public void log(String message);
151:
152: /**
153: * Writes the specified exception, and message, to a servlet log file.
154: * The implementation of this method should call
155: * <code>log(msg, exception)</code> instead. This method is deprecated
156: * in the ServletContext interface, but not deprecated here to avoid
157: * many useless compiler warnings. This message will be logged
158: * unconditionally.
159: *
160: * @param exception An <code>Exception</code> to be reported
161: * @param msg The associated message string
162: */
163: public void log(Exception exception, String msg);
164:
165: /**
166: * Writes an explanatory message and a stack trace for a given
167: * <code>Throwable</code> exception to the servlet log file. The name
168: * and type of the servlet log file is specific to the servlet container,
169: * usually an event log. This message will be logged unconditionally.
170: *
171: * @param message A <code>String</code> that describes the error or
172: * exception
173: * @param throwable The <code>Throwable</code> error or exception
174: */
175: public void log(String message, Throwable throwable);
176:
177: /**
178: * Writes the specified message to the servlet log file, usually an event
179: * log, if the logger is set to a verbosity level equal to or higher than
180: * the specified value for this message.
181: *
182: * @param message A <code>String</code> specifying the message to be
183: * written to the log file
184: * @param verbosity Verbosity level of this message
185: */
186: public void log(String message, int verbosity);
187:
188: /**
189: * Writes the specified message and exception to the servlet log file,
190: * usually an event log, if the logger is set to a verbosity level equal
191: * to or higher than the specified value for this message.
192: *
193: * @param message A <code>String</code> that describes the error or
194: * exception
195: * @param throwable The <code>Throwable</code> error or exception
196: * @param verbosity Verbosity level of this message
197: */
198: public void log(String message, Throwable throwable, int verbosity);
199:
200: /**
201: * Remove a property change listener from this component.
202: *
203: * @param listener The listener to remove
204: */
205: public void removePropertyChangeListener(
206: PropertyChangeListener listener);
207:
208: }
|