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.lf5;
056:
057: import org.apache.log.format.Formatter;
058: import org.apache.log.format.PatternFormatter;
059: import org.apache.log.LogTarget;
060: import org.apache.log.LogEvent;
061:
062: import org.apache.log4j.lf5.viewer.LogBrokerMonitor;
063:
064: /**
065: * A {@link LogTarget} that displays log events using the
066: * <a href="http://jakarta.apache.org/log4j/docs/lf5/overview.html">LogFactor5</a>
067: * Swing GUI.
068: *
069: * @author <a href="sylvain@apache.org">Sylvain Wallez</a>
070: * @version CVS $Revision: 1.5 $ $Date: 2003/02/09 23:33:24 $
071: */
072: public class LF5LogTarget implements LogTarget {
073: /** Common monitor */
074: private static LogBrokerMonitor c_defaultLogMonitor;
075:
076: /** Default context map formatter */
077: private static Formatter c_defaultContextFormatter = new PatternFormatter(
078: "");
079:
080: /** Monitor for this LogTarget */
081: private LogBrokerMonitor m_monitor;
082:
083: /** Format for context maps */
084: private Formatter m_contextFormatter = c_defaultContextFormatter;
085:
086: /**
087: * Create a <code>LogFactorLogTarget</code> on a given <code>LogBrokerMonitor</code>.
088: * @param monitor the monitor
089: */
090: public LF5LogTarget(final LogBrokerMonitor monitor) {
091: m_monitor = monitor;
092: }
093:
094: /**
095: * Create <code>LogFactorLogTarget</code> on the default <code>LogBrokerMonitor</code>.
096: */
097: public LF5LogTarget() {
098: // Creation of m_monitor is deferred up to the first call to processEvent().
099: // This allows the Swing window to pop up only if this target is actually used.
100: }
101:
102: /**
103: * Sets the {@link Formatter} that will be used to produce the "NDC" (nested diagnostic
104: * context) text on the GUI.
105: * @param formatter the message formatter
106: */
107: public void setNDCFormatter(Formatter formatter) {
108: m_contextFormatter = formatter;
109: }
110:
111: /**
112: * Get the default <code>LogBrokerMonitor</code> instance.
113: * @return the monitor
114: */
115: public static synchronized LogBrokerMonitor getDefaultMonitor() {
116: if (null == c_defaultLogMonitor) {
117: c_defaultLogMonitor = new LogBrokerMonitor(
118: LogKitLogRecord.LOGKIT_LOGLEVELS);
119: c_defaultLogMonitor.setFontSize(12);
120: c_defaultLogMonitor.show();
121: }
122:
123: return c_defaultLogMonitor;
124: }
125:
126: /**
127: * Process a log event.
128: * @param event the log event
129: */
130: public void processEvent(final LogEvent event) {
131: if (null == m_monitor) {
132: m_monitor = getDefaultMonitor();
133: }
134:
135: m_monitor.addMessage(new LogKitLogRecord(event,
136: m_contextFormatter));
137: }
138: }
|