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.format;
056:
057: import org.apache.log.ContextMap;
058: import org.apache.log.LogEvent;
059: import org.apache.log.Logger;
060: import org.apache.log.util.StackIntrospector;
061:
062: /**
063: * Formatter especially designed for debugging applications.
064: *
065: * This formatter extends the standard PatternFormatter to add
066: * two new possible expansions. These expansions are %{method}
067: * and %{thread}. In both cases the context map is first checked
068: * for values with specified key. This is to facilitate passing
069: * information about caller/thread when threads change (as in
070: * AsyncLogTarget). They then attempt to determine appropriate
071: * information dynamically.
072: *
073: * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
074: * @author <a href="mailto:peter@apache.org">Peter Donald</a>
075: * @version CVS $Revision: 1.11 $ $Date: 2003/02/09 23:33:22 $
076: */
077: public class ExtendedPatternFormatter extends PatternFormatter {
078: private static final int TYPE_METHOD = MAX_TYPE + 1;
079: private static final int TYPE_THREAD = MAX_TYPE + 2;
080:
081: private static final String TYPE_METHOD_STR = "method";
082: private static final String TYPE_THREAD_STR = "thread";
083:
084: private int m_callStackOffset = 0;
085:
086: /**
087: * Creation of a new extended pattern formatter.
088: * @param format the format string
089: */
090: public ExtendedPatternFormatter(final String format) {
091: this (format, 0);
092: }
093:
094: /**
095: * Creation of a new extended pattern formatter.
096: * @param format the format string
097: * @param callStackOffset the offset
098: */
099: public ExtendedPatternFormatter(final String format,
100: final int callStackOffset) {
101: super (format);
102: m_callStackOffset = callStackOffset;
103: }
104:
105: /**
106: * Retrieve the type-id for a particular string.
107: *
108: * @param type the string
109: * @return the type-id
110: */
111: protected int getTypeIdFor(final String type) {
112: if (type.equalsIgnoreCase(TYPE_METHOD_STR)) {
113: return TYPE_METHOD;
114: } else if (type.equalsIgnoreCase(TYPE_THREAD_STR)) {
115: return TYPE_THREAD;
116: } else {
117: return super .getTypeIdFor(type);
118: }
119: }
120:
121: /**
122: * Formats a single pattern run (can be extended in subclasses).
123: * @param event the log event
124: * @param run the pattern run to format.
125: * @return the formatted result.
126: */
127: protected String formatPatternRun(final LogEvent event,
128: final PatternRun run) {
129: switch (run.m_type) {
130: case TYPE_METHOD:
131: return getMethod(event, run.m_format);
132: case TYPE_THREAD:
133: return getThread(event, run.m_format);
134: default:
135: return super .formatPatternRun(event, run);
136: }
137: }
138:
139: /**
140: * Utility method to format category.
141: *
142: * @param event the event
143: * @param format ancilliary format parameter - allowed to be null
144: * @return the formatted string
145: */
146: private String getMethod(final LogEvent event, final String format) {
147: final ContextMap map = event.getContextMap();
148: if (null != map) {
149: final Object object = map.get("method");
150: if (null != object) {
151: return object.toString();
152: }
153: }
154:
155: //Determine callee of user's class. If offset is 0, we need to find
156: // Logger.class. If offset is 1, We need to find caller of Logger.class, etc.
157: final Class clazz = StackIntrospector.getCallerClass(
158: Logger.class, m_callStackOffset - 1);
159: if (null == clazz) {
160: return "UnknownMethod";
161: }
162:
163: final String result = StackIntrospector.getCallerMethod(clazz);
164: if (null == result) {
165: return "UnknownMethod";
166: }
167: return result;
168: }
169:
170: /**
171: * Utility thread to format category.
172: *
173: * @param event the even
174: * @param format ancilliary format parameter - allowed to be null
175: * @return the formatted string
176: */
177: private String getThread(final LogEvent event, final String format) {
178: final ContextMap map = event.getContextMap();
179: if (null != map) {
180: final Object object = map.get("thread");
181: if (null != object) {
182: return object.toString();
183: }
184: }
185:
186: return Thread.currentThread().getName();
187: }
188: }
|