org.opends.server.loggers

Class AbstractLogger<P extends LogPublisher<C>,C extends org.forgerock.opendj.server.config.server.LogPublisherCfg>

java.lang.Object

org.opends.server.loggers.AbstractLogger<P,C>

Type Parameters:

P - The type of the LogPublisher corresponding to this logger

C - The type of the LogPublisherCfg corresponding to this logger

All Implemented Interfaces:

org.forgerock.opendj.config.server.ConfigurationAddListener<C>, org.forgerock.opendj.config.server.ConfigurationChangeListener<C>, org.forgerock.opendj.config.server.ConfigurationDeleteListener<C>

Direct Known Subclasses:

AccessLogger, DebugLogger, ErrorLogger, HTTPAccessLogger

public abstract class AbstractLogger<P extends LogPublisher<C>,C extends org.forgerock.opendj.server.config.server.LogPublisherCfg>
extends Object
implements org.forgerock.opendj.config.server.ConfigurationAddListener<C>, org.forgerock.opendj.config.server.ConfigurationDeleteListener<C>, org.forgerock.opendj.config.server.ConfigurationChangeListener<C>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractLogger.LoggerStorage<P extends LogPublisher<C>,C extends org.forgerock.opendj.server.config.server.LogPublisherCfg> The storage designed to store log publishers.

Method Summary

Modifier and Type	Method and Description
abstract void	addLogPublisher(P publisher) Add a log publisher to the logger.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(C config)
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(C config)
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(C config)
protected abstract org.forgerock.opendj.config.ClassPropertyDefinition	getJavaClassPropertyDefinition() Returns the java ClassPropertyDefinition for the current logger.
protected abstract Collection<P>	getLogPublishers() Returns the log publishers.
void	initializeLogger(List<C> configs, ServerContext serverContext) Initializes all the log publishers.
boolean	isConfigurationAddAcceptable(C config, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
boolean	isConfigurationChangeAcceptable(C config, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
boolean	isConfigurationDeleteAcceptable(C config, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
abstract void	removeAllLogPublishers() Removes all existing log publishers from the logger.
abstract boolean	removeLogPublisher(P publisher) Remove a log publisher from the logger.

Methods inherited from class java.lang.Object

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

Method Detail

getLogPublishers

protected abstract Collection<P> getLogPublishers()

Returns the log publishers.

Returns:

the collection of LogPublishers

addLogPublisher

public abstract void addLogPublisher(P publisher)

Add a log publisher to the logger.

Parameters:

publisher - The log publisher to add.

removeLogPublisher

public abstract boolean removeLogPublisher(P publisher)

Remove a log publisher from the logger.

Parameters:

publisher - The log publisher to remove.

Returns:

True if the log publisher is removed or false otherwise.

removeAllLogPublishers

public abstract void removeAllLogPublishers()

Removes all existing log publishers from the logger.

getJavaClassPropertyDefinition

protected abstract org.forgerock.opendj.config.ClassPropertyDefinition getJavaClassPropertyDefinition()

Returns the java ClassPropertyDefinition for the current logger.

Returns:

the java ClassPropertyDefinition for the current logger.

initializeLogger

public void initializeLogger(List<C> configs,
                             ServerContext serverContext)
                      throws org.forgerock.opendj.config.server.ConfigException,
                             InitializationException

Initializes all the log publishers.

Parameters:

configs - The log publisher configurations.

serverContext - The server context.

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(C config,
                                            List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationAddAcceptable in interface org.forgerock.opendj.config.server.ConfigurationAddListener<C extends org.forgerock.opendj.server.config.server.LogPublisherCfg>

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(C config,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationChangeAcceptable in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<C extends org.forgerock.opendj.server.config.server.LogPublisherCfg>

applyConfigurationAdd

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

Specified by:

applyConfigurationAdd in interface org.forgerock.opendj.config.server.ConfigurationAddListener<C extends org.forgerock.opendj.server.config.server.LogPublisherCfg>

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(C config)

Specified by:

applyConfigurationChange in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<C extends org.forgerock.opendj.server.config.server.LogPublisherCfg>

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(C config,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationDeleteAcceptable in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<C extends org.forgerock.opendj.server.config.server.LogPublisherCfg>

applyConfigurationDelete

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

Specified by:

applyConfigurationDelete in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<C extends org.forgerock.opendj.server.config.server.LogPublisherCfg>