kieker.common.logging.LogImplJUnit Maven / Gradle / Ivy

Go to download
/***************************************************************************
 * Copyright 2015 Kieker Project (http://kieker-monitoring.net)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ***************************************************************************/

package kieker.common.logging;

import java.util.HashSet;
import java.util.Set;

/**
 *
 * This is an actual implementation of the logging interface used by the JUnit logger.
 *
 * @author Jan Waller
 *
 * @since 1.6
 */
public final class LogImplJUnit implements Log {

	private static final Log LOG = LogFactory.getLog(LogImplJUnit.class); // NOPMD
	private static final Set> DISABLED_THROWABLES = new HashSet>();

	private final java.util.logging.Logger logger; // NOPMD (Implementation of an logger)
	private final String name;

	/**
	 * Creates a new instance of this class.
	 *
	 * @param name
	 *            The name of the logger.
	 */
	protected LogImplJUnit(final String name) {
		this.name = name;
		this.logger = java.util.logging.Logger.getLogger(name);
	}

	private final void log(final java.util.logging.Level level, final String message, final Throwable t) {
		if (this.logger.isLoggable(level)) {
			final String sourceClass = this.name;
			final String sourceMethod;
			{ // NOCS detect calling class and method
				final StackTraceElement[] stackArray = new Throwable().getStackTrace(); // NOPMD (throwable)
				if (stackArray.length > 2) { // our stackDepth
					sourceMethod = stackArray[2].getMethodName();
				} else {
					sourceMethod = "unknown";
				}
			}
			if (t != null) {
				this.logger.logp(level, sourceClass, sourceMethod, message, t);
			} else {
				this.logger.logp(level, sourceClass, sourceMethod, message);
			}
		}
	}

	@Override
	public boolean isTraceEnabled() {
		return this.logger.isLoggable(java.util.logging.Level.FINER);
	}

	@Override
	public void trace(final String message) {
		this.log(java.util.logging.Level.FINER, message, null);
	}

	@Override
	public void trace(final String message, final Throwable t) {
		this.log(java.util.logging.Level.FINER, message, t);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public final boolean isDebugEnabled() {
		return this.logger.isLoggable(java.util.logging.Level.FINE);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public final void debug(final String message) {
		this.log(java.util.logging.Level.FINE, message, null);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public final void debug(final String message, final Throwable t) {
		this.log(java.util.logging.Level.FINE, message, t);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public final void info(final String message) {
		this.log(java.util.logging.Level.INFO, message, null);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public final void info(final String message, final Throwable t) {
		synchronized (DISABLED_THROWABLES) {
			for (final Class clazz : DISABLED_THROWABLES) {
				if (clazz.isInstance(t)) {
					this.log(java.util.logging.Level.FINE, message, t);
					return;
				}
			}
		}
		this.log(java.util.logging.Level.INFO, message, t);
	}

	@Override
	public boolean isWarnEnabled() {
		return this.logger.isLoggable(java.util.logging.Level.WARNING);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public final void warn(final String message) {
		this.log(java.util.logging.Level.WARNING, message, null);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public final void warn(final String message, final Throwable t) {
		synchronized (DISABLED_THROWABLES) {
			for (final Class clazz : DISABLED_THROWABLES) {
				if (clazz.isInstance(t)) {
					this.debug(message, t);
					this.log(java.util.logging.Level.FINE, message, t);
					return;
				}
			}
		}
		this.log(java.util.logging.Level.WARNING, message, t);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public final void error(final String message) {
		this.log(java.util.logging.Level.SEVERE, message, null);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public final void error(final String message, final Throwable t) {
		synchronized (DISABLED_THROWABLES) {
			for (final Class clazz : DISABLED_THROWABLES) {
				if (clazz.isInstance(t)) {
					this.log(java.util.logging.Level.FINE, message, t);
					return;
				}
			}
		}
		this.log(java.util.logging.Level.SEVERE, message, t);
	}

	/**
	 * Add a throwable to the list of throwables to be ignored for normal logging.
	 *
	 * @param clazz
	 *            throwable class
	 */
	public static final void disableThrowable(final Class clazz) {
		synchronized (DISABLED_THROWABLES) {
			DISABLED_THROWABLES.add(clazz);
		}
		LOG.info("Logging " + clazz.getName() + " only to DEBUG log level.");
	}

	/**
	 * Clear list of disabled throwables.
	 */
	public static final void reset() {
		synchronized (DISABLED_THROWABLES) {
			if (!DISABLED_THROWABLES.isEmpty()) {
				DISABLED_THROWABLES.clear();
				LOG.info("Logging all messaged to default log level.");
			}
		}
	}

}