/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2007-2009 Sun Microsystems, Inc.
* Portions Copyright 2013-2015 ForgeRock AS
*/
/**
* A logger for debug and trace logging. DebugLogger provides a debugging
* management access point. It is used to configure the Tracers, as well as
* to register a per-class tracer.
*
* Various stub debug methods are provided to log different types of debug
* messages. However, these methods do not contain any actual implementation.
* Tracer aspects are later weaved to catch alls to these stub methods and
* do the work of logging the message.
*
* DebugLogger is self-initializing.
*/
{
/** The set of all DebugTracer instances. */
/**
* Trace methods will use this static boolean to determine if debug is enabled
* so to not incur the cost of calling debugPublishers.isEmpty().
*/
static boolean enabled;
private static final LoggerStorage
/** The singleton instance of this class. */
/**
* The constructor for this class.
*/
private DebugLogger()
{
super((Class) DebugLogPublisher.class,
}
/** {@inheritDoc} */
{
return DebugLogPublisherCfgDefn.getInstance()
}
/** {@inheritDoc} */
{
return loggerStorage.getLogPublishers();
}
/**
* Update all debug tracers with the settings in the registered
* publishers.
*/
static void updateTracerSettings()
{
{
}
}
/**
* Indicates if debug logging is enabled.
*
* @return True if debug logging is enabled. False otherwise.
*/
public static boolean debugEnabled()
{
return enabled;
}
/**
* Retrieve the singleton instance of this class.
*
* @return The singleton instance of this logger.
*/
{
return instance;
}
/**
* Returns the registered Debug Tracer for a traced class.
*
* @param className The name of the class tracer to retrieve.
* @return The tracer for the provided class or null if there are
* no tracers registered.
*/
{
{
tracer =
new DebugLogPublisher[0]));
}
return tracer;
}
/**
* Adds a text debug log publisher that will print all messages to the
* provided writer, based on debug target(s) defined through system
* properties.
* <p>
* It is expected that one or more system properties beginning with
* {@code PROPERTY_DEBUG_TARGET} are set to define the properties of the debug
* targets used by the publisher, otherwise no publisher is added.
*
* @param writer
* The text writer where the message will be written to.
* @return the publisher. It may be {@code null} if no publisher is added.
*/
{
if (!debugTargets.isEmpty())
{
}
}
return publisher;
}
{
{
{
}
}
return targets;
}
/** {@inheritDoc} */
public final synchronized void addLogPublisher(
{
enabled = true;
}
/** {@inheritDoc} */
public final synchronized boolean removeLogPublisher(
{
return removed;
}
/** {@inheritDoc} */
public final synchronized void removeAllLogPublishers()
{
enabled = false;
}
}