/*
* 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 2013-2015 ForgeRock AS
*/
package org.opends.server.core;
import static org.opends.messages.ConfigMessages.*;
import java.util.ArrayList;
import java.util.List;
import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.i18n.slf4j.LocalizedLogger;
import org.forgerock.opendj.config.server.ConfigException;
import org.forgerock.opendj.ldap.ResultCode;
import org.opends.server.admin.server.ConfigurationAddListener;
import org.opends.server.admin.server.ConfigurationDeleteListener;
import org.opends.server.admin.server.ServerManagementContext;
import org.opends.server.admin.std.server.AccessLogPublisherCfg;
import org.opends.server.admin.std.server.DebugLogPublisherCfg;
import org.opends.server.admin.std.server.ErrorLogPublisherCfg;
import org.opends.server.admin.std.server.HTTPAccessLogPublisherCfg;
import org.opends.server.admin.std.server.LogPublisherCfg;
import org.opends.server.admin.std.server.RootCfg;
import org.opends.server.loggers.AbstractLogger;
import org.opends.server.loggers.AccessLogger;
import org.opends.server.loggers.DebugLogger;
import org.opends.server.loggers.ErrorLogger;
import org.opends.server.loggers.HTTPAccessLogger;
import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.opends.server.types.InitializationException;
/**
* This class defines a utility that will be used to manage the set of loggers
* used in the Directory Server. It will perform the logger initialization when
* the server is starting, and then will manage any additions, removals, or
* modifications of any loggers while the server is running.
*/
public class LoggerConfigManager implements
ConfigurationAddListener<LogPublisherCfg>,
ConfigurationDeleteListener<LogPublisherCfg>
{
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
private final ServerContext serverContext;
/**
* Create the logger config manager with the provided
* server context.
*
* @param context
* The server context.
*/
public LoggerConfigManager(final ServerContext context)
{
this.serverContext = context;
}
/**
* Initializes all the log publishers.
*
* @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.
*/
public void initializeLoggerConfig()
throws ConfigException, InitializationException
{
// Create an internal server management context and retrieve
// the root configuration which has the log publisher relation.
ServerManagementContext context = ServerManagementContext.getInstance();
RootCfg root = context.getRootConfiguration();
root.addLogPublisherAddListener(this);
root.addLogPublisherDeleteListener(this);
List<DebugLogPublisherCfg> debugPublisherCfgs = new ArrayList<>();
List<AccessLogPublisherCfg> accessPublisherCfgs = new ArrayList<>();
List<HTTPAccessLogPublisherCfg> httpAccessPublisherCfgs = new ArrayList<>();
List<ErrorLogPublisherCfg> errorPublisherCfgs = new ArrayList<>();
for (String name : root.listLogPublishers())
{
LogPublisherCfg config = root.getLogPublisher(name);
if(config instanceof DebugLogPublisherCfg)
{
debugPublisherCfgs.add((DebugLogPublisherCfg)config);
}
else if(config instanceof AccessLogPublisherCfg)
{
accessPublisherCfgs.add((AccessLogPublisherCfg)config);
}
else if (config instanceof HTTPAccessLogPublisherCfg)
{
httpAccessPublisherCfgs.add((HTTPAccessLogPublisherCfg) config);
}
else if(config instanceof ErrorLogPublisherCfg)
{
errorPublisherCfgs.add((ErrorLogPublisherCfg)config);
}
else
{
throw new ConfigException(ERR_CONFIG_LOGGER_INVALID_OBJECTCLASS.get(config.dn()));
}
}
// See if there are active loggers in all categories. If not, then log a
// message.
// Do not output warn message for debug loggers because it is valid to fully
// disable all debug loggers.
if (accessPublisherCfgs.isEmpty())
{
logger.warn(WARN_CONFIG_LOGGER_NO_ACTIVE_ACCESS_LOGGERS);
}
if (errorPublisherCfgs.isEmpty())
{
logger.warn(WARN_CONFIG_LOGGER_NO_ACTIVE_ERROR_LOGGERS);
}
DebugLogger.getInstance().initializeLogger(debugPublisherCfgs, serverContext);
AccessLogger.getInstance().initializeLogger(accessPublisherCfgs, serverContext);
HTTPAccessLogger.getInstance().initializeLogger(httpAccessPublisherCfgs, serverContext);
ErrorLogger.getInstance().initializeLogger(errorPublisherCfgs, serverContext);
}
/**
* Returns the logger instance corresponding to the provided config. If no
* logger corresponds to it, null will be returned and a message will be added
* to the provided messages list.
*
* @param config
* the config for which to return the logger instance
* @param messages
* where the error message will be output if no logger correspond to
* the provided config.
* @return the logger corresponding to the provided config, null if no logger
* corresponds.
*/
private AbstractLogger getLoggerInstance(LogPublisherCfg config,
List<LocalizableMessage> messages)
{
if (config instanceof DebugLogPublisherCfg)
{
return DebugLogger.getInstance();
}
else if (config instanceof AccessLogPublisherCfg)
{
return AccessLogger.getInstance();
}
else if (config instanceof HTTPAccessLogPublisherCfg)
{
return HTTPAccessLogger.getInstance();
}
else if (config instanceof ErrorLogPublisherCfg)
{
return ErrorLogger.getInstance();
}
else
{
messages.add(ERR_CONFIG_LOGGER_INVALID_OBJECTCLASS.get(config.dn()));
return null;
}
}
/** {@inheritDoc} */
@Override
public boolean isConfigurationAddAcceptable(LogPublisherCfg config,
List<LocalizableMessage> unacceptableReasons)
{
AbstractLogger instance = getLoggerInstance(config, unacceptableReasons);
return instance != null
&& instance.isConfigurationAddAcceptable(config, unacceptableReasons);
}
/** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationAdd(LogPublisherCfg config)
{
final ConfigChangeResult ccr = new ConfigChangeResult();
AbstractLogger instance = getLoggerInstance(config, ccr.getMessages());
if (instance != null)
{
return instance.applyConfigurationAdd(config);
}
else
{
ccr.setResultCode(ResultCode.UNWILLING_TO_PERFORM);
return ccr;
}
}
/** {@inheritDoc} */
@Override
public boolean isConfigurationDeleteAcceptable(LogPublisherCfg config,
List<LocalizableMessage> unacceptableReasons)
{
AbstractLogger instance = getLoggerInstance(config, unacceptableReasons);
return instance != null
&& instance.isConfigurationDeleteAcceptable(config, unacceptableReasons);
}
/** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationDelete(LogPublisherCfg config)
{
final ConfigChangeResult ccr = new ConfigChangeResult();
AbstractLogger instance = getLoggerInstance(config, ccr.getMessages());
if (instance != null)
{
return instance.applyConfigurationDelete(config);
}
else
{
ccr.setResultCode(ResultCode.UNWILLING_TO_PERFORM);
return ccr;
}
}
}