Package org.opends.server.loggers

Class ErrorLogPublisher<T extends ErrorLogPublisherCfg>

java.lang.Object

org.opends.server.loggers.ErrorLogPublisher<T>

Type Parameters:

T - The type of error log publisher configuration handled by this log publisher implementation.

All Implemented Interfaces:

Closeable, AutoCloseable, LogPublisher<T>

Direct Known Subclasses:

TextErrorLogPublisher, ThreadFilterTextErrorLogPublisher

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public abstract class ErrorLogPublisher<T extends ErrorLogPublisherCfg>
extends Object
implements LogPublisher<T>

This class defines the set of methods and structures that must be implemented for a Directory Server error log publisher.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<Severity>	defaultSeverities	The set of default log severities that will be used if no custom severities have been defined for the associated category.
protected Map<String,Set<Severity>>	definedSeverities	The hash map that will be used to define specific log severities for the various categories.

Constructor Summary

Constructors

Constructor	Description
ErrorLogPublisher()

Method Summary

Modifier and Type	Method	Description
boolean	isConfigurationAcceptable(T configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the provided configuration is acceptable for this log publisher.
abstract boolean	isEnabledFor(String category, Severity severity)	Check if a message should be logged for the provided category and severity.
abstract void	log(String category, Severity severity, org.forgerock.i18n.LocalizableMessage message, Throwable exception)	Writes a message to the error log using the provided information.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opends.server.loggers.LogPublisher

close, getDN, initializeLogPublisher

Field Detail

definedSeverities

protected Map<String,Set<Severity>> definedSeverities

The hash map that will be used to define specific log severities for the various categories.

defaultSeverities

protected Set<Severity> defaultSeverities

The set of default log severities that will be used if no custom severities have been defined for the associated category.

Constructor Detail

ErrorLogPublisher

public ErrorLogPublisher()

Method Detail

isConfigurationAcceptable

public boolean isConfigurationAcceptable(T configuration,
                                         List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Description copied from interface: LogPublisher

Indicates whether the provided configuration is acceptable for this log publisher. It should be possible to call this method on an uninitialized log publisher instance in order to determine whether the log publisher would be able to use the provided configuration.

Note that implementations which use a subclass of the provided configuration class will likely need to cast the configuration to the appropriate subclass type.

Specified by:

isConfigurationAcceptable in interface LogPublisher<T extends ErrorLogPublisherCfg>

Parameters:

configuration - The log publisher configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this log publisher, or false if not.

log

public abstract void log(String category,
                         Severity severity,
                         org.forgerock.i18n.LocalizableMessage message,
                         Throwable exception)

Writes a message to the error log using the provided information.

The category and severity information are used to determine whether to actually log this message.

Category is defined using either short name (used for classes in well defined packages) or fully qualified classname. Conversion to short name is done automatically when loggers are created, see LoggingCategoryNames for list of existing short names.

Parameters:

category - The category of the message, which is either a classname or a simple category name defined in LoggingCategoryNames class.

severity - The severity of the message.

message - The message to be logged.

exception - The exception to be logged. May be null.

isEnabledFor

public abstract boolean isEnabledFor(String category,
                                     Severity severity)

Check if a message should be logged for the provided category and severity.

Parameters:

category - The category of the message, which is either a classname or a simple category name defined in LoggingCategoryNames class.

severity - The severity of the message.

Returns:

true if the message should be logged, false otherwise