Package com.unboundid.directory.sdk.ds.api

Class PostLDIFExportTaskProcessor

java.lang.Object

com.unboundid.directory.sdk.ds.api.PostLDIFExportTaskProcessor

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<PostLDIFExportTaskProcessorConfig>, UnboundIDExtension

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

This class defines an API that must be implemented by extensions that perform some processing immediately after an LDIF export task has completed. Note that this is only an option for LDIF exports invoked as administrative tasks (including as part of a recurring task), and not for standalone exports not invoked by an administrative task.

Configuring Post-LDIF-Export Task P rocessors

In order to configure a post-LDIF-export task processor created using this API, use a command like:

      dsconfig create-post-ldif-export-task-processor \
           --processor-name "{processor-name}" \
           --type third-party \
           --set enabled:true \
           --set "extension-class:{class-name}" \
           --set "extension-argument:{name=value}"
 

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

Constructor Summary

Constructors

Constructor	Description
PostLDIFExportTaskProcessor()	Creates a new instance of this post-LDIF-export task processor.

Method Summary

Modifier and Type	Method	Description
ResultCode	applyConfiguration(PostLDIFExportTaskProcessorConfig 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	doPostLDIFExportTaskProcessing(LDIFExportTaskProperties exportProperties)	Performs any appropriate processing for an LDIF export file that has been generated by an administrative task.
void	finalizePostLDIFExportTaskProcessor()	Performs any cleanup which may be necessary when this post-LDIF-export task processor 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	initializePostLDIFExportTaskProcessor(DirectoryServerContext serverContext, PostLDIFExportTaskProcessorConfig config, ArgumentParser parser)	Initializes this post-LDIF-export task processor.
boolean	isConfigurationAcceptable(PostLDIFExportTaskProcessorConfig 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PostLDIFExportTaskProcessor

public PostLDIFExportTaskProcessor()

Creates a new instance of this post-LDIF-export task processor. All post-LDIF-export task processor implementations must include a default constructor, but any initialization should generally be done in the initializePostLDIFExportTaskProcessor method.

Method Detail

getExtensionName

@NotNull
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

@Nullable
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(@NotNull
                                  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.

initializePostLDIFExportTaskProcessor

public void initializePostLDIFExportTaskProcessor(@NotNull
                                                  DirectoryServerContext serverContext,
                                                  @NotNull
                                                  PostLDIFExportTaskProcessorConfig config,
                                                  @NotNull
                                                  ArgumentParser parser)
                                           throws LDAPException

Initializes this post-LDIF-export task processor.

Parameters:

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

config - The general configuration for this post-LDIF-export task processor.

parser - The argument parser which has been initialized from the configuration for this post-LDIF-export task processor.

Throws:

LDAPException - If a problem occurs while initializing this post-LDIF-export task processor.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(@NotNull
                                         PostLDIFExportTaskProcessorConfig config,
                                         @NotNull
                                         ArgumentParser parser,
                                         @NotNull
                                         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<PostLDIFExportTaskProcessorConfig>

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(@NotNull
                                     PostLDIFExportTaskProcessorConfig config,
                                     @NotNull
                                     ArgumentParser parser,
                                     @NotNull
                                     java.util.List<java.lang.String> adminActionsRequired,
                                     @NotNull
                                     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<PostLDIFExportTaskProcessorConfig>

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.

finalizePostLDIFExportTaskProcessor

public void finalizePostLDIFExportTaskProcessor()

Performs any cleanup which may be necessary when this post-LDIF-export task processor is to be taken out of service.

doPostLDIFExportTaskProcessing

public abstract void doPostLDIFExportTaskProcessing(@NotNull
                                                    LDIFExportTaskProperties exportProperties)
                                             throws LDAPException

Performs any appropriate processing for an LDIF export file that has been generated by an administrative task. Note that while this method may access the resulting export file (for example, to examine its contents or copy it to an alternative location), it must not delete, move, rename, or otherwise alter the file in any way.

Parameters:

exportProperties - An object with information about the LDIF export task that was completed.

Throws:

LDAPException - If a problem is encountered during processing.

getExamplesArgumentSets

@Nullable
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.