Package com.unboundid.directory.sdk.common.api

Class ErrorLogger

java.lang.Object

com.unboundid.directory.sdk.common.api.ErrorLogger

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<ErrorLoggerConfig>, UnboundIDExtension

@Extensible
@DirectoryServerExtension
@DirectoryProxyServerExtension(appliesToLocalContent=true,
                               appliesToRemoteContent=true)
@SynchronizationServerExtension(appliesToLocalContent=true,
                                appliesToSynchronizedContent=true)
@MetricsEngineExtension
@BrokerExtension
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class ErrorLogger
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<ErrorLoggerConfig>, ExampleUsageProvider

This class defines an API that must be implemented by extensions which record information about warnings, errors, and events which occur in the server.

Each error logger may be configured to indicate whether to include or exclude log messages based on their category and/or severity. This is handled automatically by the server, so individual error logger implementations no not need to attempt to perform that filtering on their own. However, they may perform additional processing if desired to further narrow the set of messages that should be logged.

Configuring Error Loggers

In order to configure an error logger created using this API, use a command like:

      dsconfig create-log-publisher \
           --publisher-name "{logger-name}" \
           --type third-party-error \
           --set enabled:true \
           --set "extension-class:{class-name}" \
           --set "extension-argument:{name=value}"
 

where "{logger-name}" is the name to use for the error logger instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.common.api.ErrorLogger, and "{name=value}" represents name-value pairs for any arguments to provide to the logger. If multiple arguments should be provided to the logger, then the "--set extension-argument:{name=value}" option should be provided multiple times.

See Also:

FileBasedErrorLogger, ScriptedErrorLogger, ScriptedFileBasedErrorLogger

Constructor Summary

Constructors

Constructor	Description
ErrorLogger()	Creates a new instance of this error logger.

Method Summary

Modifier and Type	Method	Description
ResultCode	applyConfiguration(ErrorLoggerConfig config, ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)	Attempts to apply the configuration from the provided argument parser to this extension.
void	defineConfigArguments(ArgumentParser parser)	Updates the provided argument parser to define any configuration arguments which may be used by this extension.
void	finalizeErrorLogger()	Performs any cleanup which may be necessary when this error logger is to be taken out of service.
java.util.Map<java.util.List<java.lang.String>,java.lang.String>	getExamplesArgumentSets()	Retrieves a map containing examples of configurations that may be used for this extension.
abstract java.lang.String[]	getExtensionDescription()	Retrieves a human-readable description for this extension.
abstract java.lang.String	getExtensionName()	Retrieves a human-readable name for this extension.
void	initializeErrorLogger(ServerContext serverContext, ErrorLoggerConfig config, ArgumentParser parser)	Initializes this error logger.
boolean	isConfigurationAcceptable(ErrorLoggerConfig config, ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)	Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.
abstract void	logError(LogCategory category, LogSeverity severity, long messageID, java.lang.String message)	Records information about the provided message, if appropriate.

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorLogger

public ErrorLogger()

Creates a new instance of this error logger. All error logger implementations must include a default constructor, but any initialization should generally be done in the initializeErrorLogger method.

Method Detail

getExtensionName

public abstract java.lang.String getExtensionName()

Retrieves a human-readable name for this extension.

Specified by:

getExtensionName in interface UnboundIDExtension

Returns:

A human-readable name for this extension.

getExtensionDescription

public abstract java.lang.String[] getExtensionDescription()

Retrieves a human-readable description for this extension. Each element of the array that is returned will be considered a separate paragraph in generated documentation.

Specified by:

getExtensionDescription in interface UnboundIDExtension

Returns:

A human-readable description for this extension, or null or an empty array if no description should be available.

defineConfigArguments

public void defineConfigArguments(ArgumentParser parser)
                           throws ArgumentException

Updates the provided argument parser to define any configuration arguments which may be used by this extension. The argument parser may also be updated to define relationships between arguments (e.g., to specify required, exclusive, or dependent argument sets).

Specified by:

defineConfigArguments in interface Configurable

Parameters:

parser - The argument parser to be updated with the configuration arguments which may be used by this extension.

Throws:

ArgumentException - If a problem is encountered while updating the provided argument parser.

initializeErrorLogger

public void initializeErrorLogger(ServerContext serverContext,
                                  ErrorLoggerConfig config,
                                  ArgumentParser parser)
                           throws LDAPException

Initializes this error logger.

Parameters:

serverContext - A handle to the server context for the server in which this extension is running.

config - The general configuration for this error logger.

parser - The argument parser which has been initialized from the configuration for this error logger.

Throws:

LDAPException - If a problem occurs while initializing this error logger.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(ErrorLoggerConfig config,
                                         ArgumentParser parser,
                                         java.util.List<java.lang.String> unacceptableReasons)

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension. The parser will have been used to parse any configuration available for this extension, and any automatic validation will have been performed. This method may be used to perform any more complex validation which cannot be performed automatically by the argument parser.

Specified by:

isConfigurationAcceptable in interface Reconfigurable<ErrorLoggerConfig>

Parameters:

config - The general configuration for this extension.

parser - The argument parser that has been used to parse the proposed configuration for this extension.

unacceptableReasons - A list to which messages may be added to provide additional information about why the provided configuration is not acceptable.

Returns:

true if the configuration in the provided argument parser appears to be acceptable, or false if not.

applyConfiguration

public ResultCode applyConfiguration(ErrorLoggerConfig config,
                                     ArgumentParser parser,
                                     java.util.List<java.lang.String> adminActionsRequired,
                                     java.util.List<java.lang.String> messages)

Attempts to apply the configuration from the provided argument parser to this extension.

Specified by:

applyConfiguration in interface Reconfigurable<ErrorLoggerConfig>

Parameters:

config - The general configuration for this extension.

parser - The argument parser that has been used to parse the new configuration for this extension.

adminActionsRequired - A list to which messages may be added to provide additional information about any additional administrative actions that may be required to apply some of the configuration changes.

messages - A list to which messages may be added to provide additional information about the processing performed by this method.

Returns:

A result code providing information about the result of applying the configuration change. A result of SUCCESS should be used to indicate that all processing completed successfully. Any other result will indicate that a problem occurred during processing.

finalizeErrorLogger

public void finalizeErrorLogger()

Performs any cleanup which may be necessary when this error logger is to be taken out of service.

logError

public abstract void logError(LogCategory category,
                              LogSeverity severity,
                              long messageID,
                              java.lang.String message)

Records information about the provided message, if appropriate.

Parameters:

category - The category for the message to be logged.

severity - The severity for the message to be logged.

messageID - The unique identifier with which the message text is associated.

message - The message to be logged.

getExamplesArgumentSets

public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()

Retrieves a map containing examples of configurations that may be used for this extension. The map key should be a list of sample arguments, and the corresponding value should be a description of the behavior that will be exhibited by the extension when used with that configuration.

Specified by:

getExamplesArgumentSets in interface ExampleUsageProvider

Returns:

A map containing examples of configurations that may be used for this extension. It may be null or empty if there should not be any example argument sets.