Class LogFileRotationListener
- java.lang.Object
-
- com.unboundid.directory.sdk.common.api.LogFileRotationListener
-
- All Implemented Interfaces:
Configurable
,ExampleUsageProvider
,Reconfigurable<LogFileRotationListenerConfig>
,UnboundIDExtension
@Extensible @DirectoryServerExtension @DirectoryProxyServerExtension(appliesToLocalContent=true, appliesToRemoteContent=true) @SynchronizationServerExtension(appliesToLocalContent=true, appliesToSynchronizedContent=false) @MetricsEngineExtension @BrokerExtension @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class LogFileRotationListener extends java.lang.Object implements UnboundIDExtension, Reconfigurable<LogFileRotationListenerConfig>, ExampleUsageProvider
This class defines an API that may be used to perform custom processing whenever a log file is rotated.
Configuring Log File Rotation Listeners
In order to configure a log file rotation listener created using this API, use a command like:dsconfig create-log-file-rotation-listener \ --listener-name "{listener-name}" \ --type third-party \ --set enabled:true \ --set "extension-class:{class-name}" \ --set "extension-argument:{name=value}"
where "{listener-name}" is the name to use for the log file rotation listener instance, "{class-name}" is the fully-qualified name of the Java class that extendscom.unboundid.directory.sdk.common.api.LogFileRotationListener
, and "{name=value}" represents name-value pairs for any arguments to provide to the listener. If multiple arguments should be provided to the listener, then the "--set extension-argument:{name=value}
" option should be provided multiple times.
-
-
Constructor Summary
Constructors Constructor Description LogFileRotationListener()
Creates a new instance of this log file rotation listener.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description ResultCode
applyConfiguration(LogFileRotationListenerConfig 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.abstract void
doPostRotationProcessing(java.io.File f)
Performs any appropriate processing for a log file that has been rotated.void
finalizeLogFileRotationListener()
Performs any cleanup which may be necessary when this log file rotation listener 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
initializeLogFileRotationListener(ServerContext serverContext, LogFileRotationListenerConfig config, ArgumentParser parser)
Initializes this log file rotation listener.boolean
isConfigurationAcceptable(LogFileRotationListenerConfig 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.
-
-
-
Constructor Detail
-
LogFileRotationListener
public LogFileRotationListener()
Creates a new instance of this log file rotation listener. All log file rotation listener implementations must include a default constructor, but any initialization should generally be done in theinitializeLogFileRotationListener
method.
-
-
Method Detail
-
getExtensionName
public abstract java.lang.String getExtensionName()
Retrieves a human-readable name for this extension.- Specified by:
getExtensionName
in interfaceUnboundIDExtension
- 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 interfaceUnboundIDExtension
- 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 interfaceConfigurable
- 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.
-
initializeLogFileRotationListener
public void initializeLogFileRotationListener(ServerContext serverContext, LogFileRotationListenerConfig config, ArgumentParser parser) throws LDAPException
Initializes this log file rotation listener.- Parameters:
serverContext
- A handle to the server context for the server in which this extension is running.config
- The general configuration for this log file rotation listener.parser
- The argument parser which has been initialized from the configuration for this log file rotation listener.- Throws:
LDAPException
- If a problem occurs while initializing this log file rotation listener.
-
isConfigurationAcceptable
public boolean isConfigurationAcceptable(LogFileRotationListenerConfig 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 interfaceReconfigurable<LogFileRotationListenerConfig>
- 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, orfalse
if not.
-
applyConfiguration
public ResultCode applyConfiguration(LogFileRotationListenerConfig 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 interfaceReconfigurable<LogFileRotationListenerConfig>
- 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.
-
finalizeLogFileRotationListener
public void finalizeLogFileRotationListener()
Performs any cleanup which may be necessary when this log file rotation listener is to be taken out of service.
-
doPostRotationProcessing
public abstract void doPostRotationProcessing(java.io.File f) throws LDAPException
Performs any appropriate processing for a log file that has been rotated.- Parameters:
f
- The log file that has been rotated. This file must not be deleted, moved, renamed, or otherwise altered during processing.- Throws:
LDAPException
- If a problem is encountered during processing.
-
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 interfaceExampleUsageProvider
- 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.
-
-