2 * jFCPlib-high-level-client - Logging.java -
3 * Copyright © 2008 David Roden
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 package net.pterodactylus.util.logging;
22 import java.text.DateFormat;
23 import java.text.SimpleDateFormat;
24 import java.util.ArrayList;
25 import java.util.Collections;
26 import java.util.Date;
27 import java.util.List;
28 import java.util.logging.ConsoleHandler;
29 import java.util.logging.Formatter;
30 import java.util.logging.Handler;
31 import java.util.logging.Level;
32 import java.util.logging.LogRecord;
33 import java.util.logging.Logger;
38 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
41 public class Logging {
43 /** The log handler. */
44 private static final LogHandler logHandler = new LogHandler();
47 logHandler.setLevel(Level.ALL);
50 /** The root name of the hierarchy. */
51 private static String hierarchyRootName;
54 * Adds a listener to the log handler.
56 * @param loggingListener
59 public static void addLoggingListener(LoggingListener loggingListener) {
60 logHandler.addLoggingListener(loggingListener);
64 * Removes a listener from the log handler.
66 * @param loggingListener
67 * The listener to remove
69 public static void removeLoggingListener(LoggingListener loggingListener) {
70 logHandler.removeLoggingListener(loggingListener);
74 * Sets up logging and installs the log handler.
76 * @param hierarchyName
77 * The name of the hierarchy root logger
79 public static void setup(String hierarchyName) {
80 hierarchyRootName = hierarchyName;
81 Logger rootLogger = Logger.getLogger(hierarchyName);
82 rootLogger.addHandler(logHandler);
83 Handler consoleHandler = new ConsoleHandler();
84 consoleHandler.setLevel(Level.ALL);
85 consoleHandler.setFormatter(new Formatter() {
86 private StringBuffer recordBuffer = new StringBuffer();
87 private DateFormat dateFormatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS Z");
92 public synchronized String format(LogRecord record) {
93 recordBuffer.setLength(0);
94 recordBuffer.append(dateFormatter.format(new Date(record.getMillis()))).append(' ').append(record.getLevel().getName()).append(' ');
95 recordBuffer.append(record.getSourceClassName()).append('.').append(record.getSourceMethodName()).append(' ');
96 recordBuffer.append(record.getMessage());
97 recordBuffer.append("\r\n");
98 return recordBuffer.toString();
101 rootLogger.addHandler(consoleHandler);
102 rootLogger.setUseParentHandlers(false);
103 rootLogger.setLevel(Level.ALL);
107 * Returns a named logger from the jSite hierarchy.
110 * The name of the logger
113 public static Logger getLogger(String name) {
114 Logger logger = Logger.getLogger(hierarchyRootName + "." + name);
119 * The log handler simply forwards every log message it receives to all
120 * registered listeners.
122 * @see LoggingListener
123 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
126 private static class LogHandler extends Handler {
129 * Package-private constructor.
135 /** The list of the listeners. */
136 private final List<LoggingListener> loggingListeners = Collections.synchronizedList(new ArrayList<LoggingListener>());
143 * Adds a listener to the log handler.
145 * @param loggingListener
146 * The listener to add
148 public void addLoggingListener(LoggingListener loggingListener) {
149 loggingListeners.add(loggingListener);
153 * Removes a listener from the log handler.
155 * @param loggingListener
156 * The listener to remove
158 public void removeLoggingListener(LoggingListener loggingListener) {
159 loggingListeners.remove(loggingListener);
163 * Notifies all listeners that a log record was received.
166 * The received log record
168 private void fireLogged(LogRecord logRecord) {
169 for (LoggingListener loggingListener: loggingListeners) {
170 loggingListener.logged(logRecord);
182 public void close() throws SecurityException {
190 public void flush() {
198 public void publish(LogRecord logRecord) {
199 fireLogged(logRecord);