org.eclipse.californium.core.CaliforniumLogger Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2015 Institute for Pervasive Computing, ETH Zurich and others.
 * 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v1.0 which accompany this distribution.
 * 
 * The Eclipse Public License is available at
 *    http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 *    http://www.eclipse.org/org/documents/edl-v10.html.
 * 
 * Contributors:
 *    Matthias Kovatsch - creator and main architect
 *    Martin Lanter - architect and re-implementation
 *    Dominique Im Obersteg - parsers and initial implementation
 *    Daniel Pauli - parsers and initial implementation
 *    Kai Hudalla - logging
 ******************************************************************************/
package org.eclipse.californium.core;

import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
import java.util.logging.StreamHandler;

import org.eclipse.californium.core.CaliforniumFormatter;
import org.eclipse.californium.elements.Connector;

/**
 * CalifonriumLogger is a helper class for logging in Californium when
 * java.util.logging.config.file is not used. Make a static call to
 * CaliforniumLogger.initializeLogger() to configure the
 * {@link CaliforniumFormatter}. Make a call to
 * CaliforniumLogger.setLoggerLevel() to adjust the logging level for all or
 * specific classes.
 */
public class CaliforniumLogger {
	
	private static final Logger CALIFORNIUM_LOGGER = Logger.getLogger(CaliforniumLogger.class.getPackage().getName());
	private static final Logger CONNECTOR_LOGGER = Logger.getLogger(Connector.class.getPackage().getName());
	
	/**
	 * Initializes the logger. The resulting format of logged messages is
	 * 
	 * 	 * {@code
	 * | Thread ID | Level | Message | Class | Line No | Method | Thread name |
	 * }
	 * 
	 * 
	 * where Level is the {@link Level} of the message, the Class
	 * is the class in which the log statement is located, the
	 * Line No is the line number of the logging statement, the
	 * Method is the method name in which the statement is located
	 * and the Thread name is the name of the thread that executed
	 * the logging statement.
	 */
	public static void initialize() {
		CALIFORNIUM_LOGGER.setUseParentHandlers(false);
		CALIFORNIUM_LOGGER.addHandler(new CaliforniumHandler());
		CONNECTOR_LOGGER.setUseParentHandlers(false);
		CONNECTOR_LOGGER.addHandler(new CaliforniumHandler());
	}
	
	/**
	 * Disables logging by setting the level of all loggers that have been
	 * requested over this class to OFF.
	 */
	public static void disableLogging() {
		CALIFORNIUM_LOGGER.setLevel(Level.OFF);
		CONNECTOR_LOGGER.setLevel(Level.OFF);
	}

	/**
	 * Sets the logger level of all loggers that have been requests over this
	 * class to the specified level and sets this level for all loggers that are
	 * going to be requested over this class in the future.
	 * 
	 * @param level
	 *            the new logger level
	 */
	public static void setLevel(Level level) {
		CALIFORNIUM_LOGGER.setLevel(level);
		CONNECTOR_LOGGER.setLevel(level);
	}

	private static class CaliforniumHandler extends StreamHandler {

		public CaliforniumHandler() {
			super(System.out, new CaliforniumFormatter());
			this.setLevel(Level.ALL);
		}

		@Override
		public synchronized void publish(LogRecord record) {
			super.publish(record);
			super.flush();
		}
	}
}