/*
* 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
* or http://forgerock.org/license/CDDLv1.0.html.
* 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.
*/
package org.opends.server.loggers;
import static org.opends.messages.ConfigMessages.*;
import static org.opends.server.util.StaticUtils.*;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;
import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.i18n.LocalizableMessageDescriptor.Arg3;
import org.forgerock.i18n.slf4j.LocalizedLogger;
import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.forgerock.opendj.config.server.ConfigException;
import org.forgerock.opendj.ldap.ResultCode;
import org.opends.server.admin.ClassPropertyDefinition;
import org.opends.server.admin.server.ConfigurationAddListener;
import org.opends.server.admin.server.ConfigurationChangeListener;
import org.opends.server.admin.server.ConfigurationDeleteListener;
import org.opends.server.admin.std.server.LogPublisherCfg;
import org.opends.server.core.DirectoryServer;
import org.opends.server.core.ServerContext;
import org.opends.server.types.DN;
import org.opends.server.types.InitializationException;
import org.opends.server.util.StaticUtils;
/**
* 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
* The type of the LogPublisher corresponding to this logger
* @param
* The type of the LogPublisherCfg corresponding to this logger
*/
public abstract class AbstractLogger
, C extends LogPublisherCfg>
implements ConfigurationAddListener, ConfigurationDeleteListener,
ConfigurationChangeListener
{
/**
* The storage designed to store log publishers. It is helpful in abstracting
* away the methods used to manage the collection.
*
* @param
* The concrete {@link LogPublisher} type
* @param
* The concrete {@link LogPublisherCfg} type
*/
protected static class LoggerStorage
,
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. */
private Collection
logPublishers = new CopyOnWriteArrayList<>();
/**
* Add a log publisher to the logger.
*
* @param publisher
* The log publisher to add.
*/
public synchronized void addLogPublisher(P publisher)
{
logPublishers.add(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)
{
boolean removed = logPublishers.remove(publisher);
if (removed)
{
publisher.close();
}
return removed;
}
/** Removes all existing log publishers from the logger. */
public synchronized void removeAllLogPublishers()
{
StaticUtils.close(logPublishers);
logPublishers.clear();
}
/**
* Returns the logPublishers.
*
* @return the collection of {@link LogPublisher}s
*/
public Collection
getLogPublishers()
{
return logPublishers;
}
}
/**
* Returns the log publishers.
*
* @return the collection of {@link LogPublisher}s
*/
protected abstract Collection
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