|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.common.api.FileBasedErrorLogger
@Extensible @DirectoryServerExtension @DirectoryProxyServerExtension(appliesToLocalContent=true, appliesToRemoteContent=true) @SynchronizationServerExtension(appliesToLocalContent=true, appliesToSynchronizedContent=true) @MetricsEngineExtension @IdentityBrokerExtension @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class FileBasedErrorLogger
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.
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.
ErrorLogger
,
ScriptedErrorLogger
,
ScriptedFileBasedErrorLogger
Constructor Summary | |
---|---|
FileBasedErrorLogger()
Creates a new instance of this file-based error logger. |
Method Summary | |
---|---|
com.unboundid.ldap.sdk.ResultCode |
applyConfiguration(FileBasedErrorLoggerConfig config,
com.unboundid.util.args.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(com.unboundid.util.args.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,
com.unboundid.util.args.ArgumentParser parser)
Initializes this file-based error logger. |
boolean |
isConfigurationAcceptable(FileBasedErrorLoggerConfig config,
com.unboundid.util.args.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 |
---|
public FileBasedErrorLogger()
initializeErrorLogger
method.
Method Detail |
---|
public abstract java.lang.String getExtensionName()
getExtensionName
in interface UnboundIDExtension
public abstract java.lang.String[] getExtensionDescription()
getExtensionDescription
in interface UnboundIDExtension
null
or an empty array if no description should be available.public void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.util.args.ArgumentException
defineConfigArguments
in interface Configurable
parser
- The argument parser to be updated with the configuration
arguments which may be used by this extension.
com.unboundid.util.args.ArgumentException
- If a problem is encountered while updating the
provided argument parser.public void initializeErrorLogger(ServerContext serverContext, FileBasedErrorLoggerConfig config, com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.ldap.sdk.LDAPException
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.
com.unboundid.ldap.sdk.LDAPException
- If a problem occurs while initializing this
file-based error logger.public boolean isConfigurationAcceptable(FileBasedErrorLoggerConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)
isConfigurationAcceptable
in interface Reconfigurable<FileBasedErrorLoggerConfig>
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.
true
if the configuration in the provided argument parser
appears to be acceptable, or false
if not.public com.unboundid.ldap.sdk.ResultCode applyConfiguration(FileBasedErrorLoggerConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)
applyConfiguration
in interface Reconfigurable<FileBasedErrorLoggerConfig>
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.
SUCCESS
should be
used to indicate that all processing completed successfully. Any
other result will indicate that a problem occurred during
processing.public void finalizeErrorLogger()
public abstract java.lang.CharSequence logError(LogCategory category, LogSeverity severity, long messageID, java.lang.String message)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()
getExamplesArgumentSets
in interface ExampleUsageProvider
null
or empty if there should
not be any example argument sets.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |