com.unboundid.directory.sdk.common.api

Class FileBasedErrorLogger

java.lang.Object

com.unboundid.directory.sdk.common.api.FileBasedErrorLogger

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<FileBasedErrorLoggerConfig>, UnboundIDExtension

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

This class defines an API that may be used to create a specific type of error logger which is intended to write log messages to text files. This is a convenience for developers which wish to create custom error loggers that write to text files and provides support for a wide range of functionality including high-performance and highly-concurrent logging. All of the options available to ErrorLogger implementations are available for file-based error loggers, as well as options for indicating the log file path, the rotation and retention policies, whether to buffer the output, etc.

Note that file-based error loggers will automatically be registered within the server as disk space consumers, so there is no need to implement the DiskSpaceConsumer interface. Also note that configuration change related to the log file (e.g., the log file path, buffer size, queue size, etc.) will also automatically be handled by the server, so subclasses only need to be concerned about changes to the custom arguments they define.

Configuring File-Based Error Loggers

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

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

where "{logger-name}" is the name to use for the error logger instance, "{path}" is the path to the log file to be written, "{rotation-policy-name}" is the name of the log rotation policy to use for the log file, "{retention-policy-name}" is the name of the log retention policy to use for the log file, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.common.api.FileBasedErrorLogger, 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. It is also possible to specify multiple log rotation and/or retention policies if desired.

See Also:

ErrorLogger, ScriptedErrorLogger, ScriptedFileBasedErrorLogger

Constructor Summary

Constructors

Constructor and Description
FileBasedErrorLogger() Creates a new instance of this file-based error logger.

Method Summary

Modifier and Type	Method and Description
ResultCode	applyConfiguration(FileBasedErrorLoggerConfig 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 file-based 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, FileBasedErrorLoggerConfig config, ArgumentParser parser) Initializes this file-based error logger.
boolean	isConfigurationAcceptable(FileBasedErrorLoggerConfig 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 java.lang.CharSequence	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

FileBasedErrorLogger

public FileBasedErrorLogger()

Creates a new instance of this file-based error logger. All file-based 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,
                                  FileBasedErrorLoggerConfig config,
                                  ArgumentParser parser)
                           throws LDAPException

Initializes this file-based 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 file-based error logger.

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

Throws:

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

isConfigurationAcceptable

public boolean isConfigurationAcceptable(FileBasedErrorLoggerConfig 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<FileBasedErrorLoggerConfig>

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(FileBasedErrorLoggerConfig 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<FileBasedErrorLoggerConfig>

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 file-based error logger is to be taken out of service.

logError

public abstract java.lang.CharSequence 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.

Returns:

The content of the log message that should be written. It may be null or empty if no message should be written. It may optionally include line breaks if the log message should span multiple lines.

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.