org.opends.server.core

Class LoggerConfigManager

java.lang.Object

org.opends.server.core.LoggerConfigManager

All Implemented Interfaces:

ConfigurationAddListener<LogPublisherCfg>, ConfigurationDeleteListener<LogPublisherCfg>

public class LoggerConfigManager
extends Object
implements ConfigurationAddListener<LogPublisherCfg>, ConfigurationDeleteListener<LogPublisherCfg>

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.

Constructor Summary

Constructors

Constructor and Description
LoggerConfigManager(ServerContext context) Create the logger config manager with the provided server context.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(LogPublisherCfg config) Adds a new configuration to this add listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(LogPublisherCfg config) Deletes an existing configuration from this delete listener.
void	initializeLoggerConfig() Initializes all the log publishers.
boolean	isConfigurationAddAcceptable(LogPublisherCfg config, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationDeleteAcceptable(LogPublisherCfg config, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoggerConfigManager

public LoggerConfigManager(ServerContext context)

Create the logger config manager with the provided server context.

Parameters:

context - The server context.

Method Detail

initializeLoggerConfig

public void initializeLoggerConfig()
                            throws org.forgerock.opendj.config.server.ConfigException,
                                   InitializationException

Initializes all the log publishers.

Throws:

org.forgerock.opendj.config.server.ConfigException - If an unrecoverable problem arises in the process of performing the initialization as a result of the server configuration.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(LogPublisherCfg config,
                                   List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed addition of a new configuration is acceptable to this add listener.

Specified by:

isConfigurationAddAcceptable in interface ConfigurationAddListener<LogPublisherCfg>

Parameters:

config - The configuration that will be added.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed addition is acceptable, or false if it is not.

applyConfigurationAdd

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationAdd(LogPublisherCfg config)

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<LogPublisherCfg>

Parameters:

config - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(LogPublisherCfg config,
                                      List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.

Specified by:

isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<LogPublisherCfg>

Parameters:

config - The configuration that will be deleted.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed deletion is acceptable, or false if it is not.

applyConfigurationDelete

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationDelete(LogPublisherCfg config)

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<LogPublisherCfg>

Parameters:

config - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.