AbstractLogger.java revision 7359dcd511c2a7c8dc6a296f91b9616cfa5bacd5
/*
* 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 2006-2008 Sun Microsystems, Inc.
* Portions Copyright 2011-2015 ForgeRock AS.
*/
/**
* This class defines the wrapper that will invoke all registered loggers for
* each type of request received or response sent. If no log publishers are
* registered, messages will be directed to standard out.
*
* @param <P>
* The type of the LogPublisher corresponding to this logger
* @param <C>
* The type of the LogPublisherCfg corresponding to this logger
*/
public abstract class AbstractLogger
<P extends LogPublisher<C>, C extends LogPublisherCfg>
implements ConfigurationAddListener<C>, ConfigurationDeleteListener<C>,
{
/**
* The storage designed to store log publishers. It is helpful in abstracting
* away the methods used to manage the collection.
*
* @param <P>
* The concrete {@link LogPublisher} type
* @param <C>
* The concrete {@link LogPublisherCfg} type
*/
protected static class LoggerStorage<P extends LogPublisher<C>,
C extends LogPublisherCfg>
{
/** Defined as public to allow subclasses of {@link AbstractLogger} to instantiate it. */
public LoggerStorage()
{
super();
}
/** The set of loggers that have been registered with the server. It will initially be empty. */
/**
* Add a log publisher to the logger.
*
* @param publisher
* The log publisher to add.
*/
public synchronized void addLogPublisher(P publisher)
{
}
/**
* Remove a log publisher from the logger.
*
* @param publisher
* The log publisher to remove.
* @return True if the log publisher is removed or false otherwise.
*/
public synchronized boolean removeLogPublisher(P publisher)
{
if (removed)
{
}
return removed;
}
/** Removes all existing log publishers from the logger. */
public synchronized void removeAllLogPublishers()
{
}
/**
* Returns the logPublishers.
*
* @return the collection of {@link LogPublisher}s
*/
public Collection<P> getLogPublishers()
{
return logPublishers;
}
}
/**
* Returns the log publishers.
*
* @return the collection of {@link LogPublisher}s
*/
protected abstract Collection<P> getLogPublishers();
/**
* Add a log publisher to the logger.
*
* @param publisher
* The log publisher to add.
*/
public abstract void addLogPublisher(P publisher);
/**
* Remove a log publisher from the logger.
*
* @param publisher
* The log publisher to remove.
* @return True if the log publisher is removed or false otherwise.
*/
public abstract boolean removeLogPublisher(P publisher);
/** Removes all existing log publishers from the logger. */
public abstract void removeAllLogPublishers();
/**
* Returns the java {@link ClassPropertyDefinition} for the current logger.
*
* @return the java {@link ClassPropertyDefinition} for the current logger.
*/
protected abstract ClassPropertyDefinition getJavaClassPropertyDefinition();
private final Class<P> logPublisherClass;
private ServerContext serverContext;
/**
* The constructor for this class.
*
* @param logPublisherClass
* the log publisher class
* @param invalidLoggerClassErrorMessage
* the error message to use if the logger class in invalid
*/
final Class<P> logPublisherClass,
{
this.logPublisherClass = logPublisherClass;
}
/**
* Initializes all the log publishers.
*
* @param configs The log publisher configurations.
* @param serverContext
* The server context.
* @throws ConfigException
* If an unrecoverable problem arises in the process of
* performing the initialization as a result of the server
* configuration.
* @throws InitializationException
* If a problem occurs during initialization that is not
* related to the server configuration.
*/
{
this.serverContext = serverContext;
{
{
}
}
}
{
return serverContext;
}
{
}
public boolean isConfigurationChangeAcceptable(C config, List<LocalizableMessage> unacceptableReasons)
{
}
{
{
}
return ccr;
}
{
{
try
{
}
catch(ConfigException e)
{
}
catch (Exception e)
{
ccr.addMessage(ERR_CONFIG_LOGGER_CANNOT_CREATE_LOGGER.get(config.dn(), stackTraceToSingleLineString(e)));
}
}
return ccr;
}
{
for (P publisher : getLogPublishers())
{
{
return publisher;
}
}
return null;
}
{
if (logPublisher == null)
{
{
// Needs to be added and enabled
return applyConfigurationAdd0(config);
}
}
else
{
{
// Changes to the class name cannot be
// applied dynamically, so if the class name did change then
// indicate that administrative action is required for that
// change to take effect.
{
ccr.setAdminActionRequired(true);
}
try
{
{
} // else the publisher is currently active, so we don't need to do anything.
}
catch (Exception e)
{
ccr.addMessage(ERR_CONFIG_LOGGER_CANNOT_UPDATE_LOGGER.get(config.dn(), stackTraceToSingleLineString(e)));
}
}
else
{
// The publisher is being disabled so shut down and remove.
return applyConfigurationDelete(config);
}
}
return ccr;
}
public boolean isConfigurationDeleteAcceptable(C config, List<LocalizableMessage> unacceptableReasons)
{
}
{
if(logPublisher != null)
{
try
{
{
}
}
catch (ConfigException e)
{
ccr.addMessage(ERR_CONFIG_LOGGER_CANNOT_DELETE_LOGGER.get(config.dn(), stackTraceToSingleLineString(e)));
}
}
else
{
}
return ccr;
}
private boolean isJavaClassAcceptable(C config,
{
try {
} catch (Exception e) {
return false;
}
}
{
try {
return logPublisher;
}
catch (Exception e)
{
throw new ConfigException(
}
}
{
return logPublisher;
}
}