Package com.unboundid.directory.sdk.sync.api

Class LDAPSyncDestinationPlugin

  • All Implemented Interfaces:
    Configurable, ExampleUsageProvider, Reconfigurable<LDAPSyncDestinationPluginConfig>, UnboundIDExtension
    @Extensible
@SynchronizationServerExtension(appliesToLocalContent=false,
                                appliesToSynchronizedContent=true)
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class LDAPSyncDestinationPlugin
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<LDAPSyncDestinationPluginConfig>, ExampleUsageProvider
    This class defines an API that must be implemented by extensions that perform processing on synchronization operations within an LDAP Sync Destination. These extensions may be used to
    • Filter out certain changes from being synchronized.
    • Change how an entry is fetched.
    • Change how an entry is modified or created.

    A note on exception handling: in general subclasses should not catch LDAPExceptions that are thrown when using the provided LDAPInterface unless there are specific exceptions that are expected. The Data Sync Server will handle LDAPExceptions in an appropriate way based on the specific cause of the exception. For example, some errors will result in the SyncOperation being retried, and others will trigger fail over to a different server.

    Configuring LDAP Sync Destination Plugins

    In order to configure an LDAP sync destination plugin created using this API, use a command like: 
          dsconfig create-sync-destination-plugin \
           --plugin-name "{plugin-name}" \
           --type third-party-ldap \
           --set "extension-class:{class-name}" \
           --set "extension-argument:{name=value}"
    where "{plugin-name}" is the name to use for the LDAP sync destination plugin instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin, and "{name=value}" represents name-value pairs for any arguments to provide to the LDAP sync destination plugin. If multiple arguments should be provided to the LDAP sync destination plugin, then the "--set extension-argument:{name=value}" option should be provided multiple times.
    See Also:
    ScriptedLDAPSyncDestinationPlugin

    • Constructor Detail

      • LDAPSyncDestinationPlugin

        public LDAPSyncDestinationPlugin()
        Creates a new instance of this LDAP sync destination plugin. All sync destination implementations must include a default constructor, but any initialization should generally be done in the initializeLDAPSyncDestinationPlugin method.

    • Method Detail

      • 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.

      • initializeLDAPSyncDestinationPlugin

        public void initializeLDAPSyncDestinationPlugin​(SyncServerContext serverContext,
                                                LDAPSyncDestinationPluginConfig config,
                                                ArgumentParser parser)
                                         throws LDAPException
        Initializes this LDAP sync destination plugin. This method will be called before any other methods in the class.
        Parameters:
        serverContext - A handle to the server context for the Data Sync Server in which this extension is running. Extensions should typically store this in a class member.
        config - The general configuration for this proxy transformation.
        parser - The argument parser which has been initialized from the configuration for this LDAP sync destination plugin.
        Throws:
        LDAPException - If a problem occurs while initializing this ldap sync destination plugin.

      • isConfigurationAcceptable

        public boolean isConfigurationAcceptable​(LDAPSyncDestinationPluginConfig 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<LDAPSyncDestinationPluginConfig>
        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​(LDAPSyncDestinationPluginConfig 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<LDAPSyncDestinationPluginConfig>
        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.

      • finalizeLDAPSyncDestinationPlugin

        public void finalizeLDAPSyncDestinationPlugin()
        Performs any cleanup which may be necessary when this LDAP sync destination plugin is taken out of service. This can happen when it is deleted from the configuration and at server shutdown.

      • preFetch

        public PreStepResult preFetch​(LDAPInterface destinationConnection,
                              SearchRequest searchRequest,
                              java.util.List<Entry> fetchedEntries,
                              SyncOperation operation)
                       throws LDAPException
        This method is called before a destination entry is fetched. A connection to the destination server is provided along with the SearchRequest that will be sent to the server. This method is overridden by plugins that need to have access to the search request before it is sent to the destination server. This includes updating the search request as well as performing the search instead of the core server, including doing additional searches. For plugins that need to manipulate the entries that the core LDAP Sync Destination code retrieves from the destination, implementing the postFetch(com.unboundid.ldap.sdk.LDAPInterface, com.unboundid.ldap.sdk.SearchRequest, java.util.List<com.unboundid.ldap.sdk.Entry>, com.unboundid.directory.sdk.sync.types.SyncOperation) method is more natural.

        This method might be called multiple times for a single synchronization operation, specifically when there are multiple search criteria or multiple base DNs defined for the Sync Destination.

        Parameters:
        destinationConnection - A connection to the destination server.
        searchRequest - The search request that the LDAP Sync Destination will use to fetch the entry.
        fetchedEntries - A list of entries that have been fetched. When the search criteria matches multiple entries, they should all be returned. A plugin that wishes to implement the fetch should put the fetched entries here and return PreStepResult#SKIP_CURRENT_STEP.
        operation - The synchronization operation for this change.
        Returns:
        The result of the plugin processing. Be very careful when returning PreStepResult#RETRY_OPERATION_UNLIMITED as this can stall all in flight operations until this operation completes. This return value should only be used in situations where a remote service (e.g., the LDAP server) is unavailable. In this case, it's preferable to just throw the underlying LDAPException, which the Data Sync Server will handle correctly based on the type of the operation. Note: PreStepResult#SKIP_CURRENT_STEP should only be returned if this plugin takes responsibility for fully fetching the entry according to the search request and for populating the fetched entry list.
        Throws:
        LDAPException - In general subclasses should not catch LDAPExceptions that are thrown when using the LDAPInterface unless there are specific exceptions that are expected. The Data Sync Server will handle LDAPExceptions in an appropriate way based on the specific cause of the exception. For example, some errors will result in the SyncOperation being retried, and others will trigger fail over to a different server. Plugins should only throw LDAPException for errors related to communication with the LDAP server. Use the return code to indicate other types of errors, which might require retry.

      • postFetch

        public PostStepResult postFetch​(LDAPInterface destinationConnection,
                                SearchRequest searchRequest,
                                java.util.List<Entry> fetchedEntries,
                                SyncOperation operation)
                         throws LDAPException
        This method is called after an attempt to fetch a destination entry. An connection to the destination server is provided along with the SearchRequest that was sent to the server. This method is overridden by plugins that need to manipulate the search results that are returned to the Sync Pipe. This can include filtering out certain entries, remove information from the entries, or adding additional information, possibly by doing a followup LDAP search.

        This method might be called multiple times for a single synchronization operation, specifically when there are multiple search criteria or multiple base DNs defined for the Sync Destination.

        This method will not be called if the search fails, for instance, if the base DN of the search does not exist.

        Parameters:
        destinationConnection - A connection to the destination server.
        searchRequest - The search request that the LDAP Sync Destination used to fetch the entry.
        fetchedEntries - A list of entries that have been fetched. When the search criteria matches multiple entries, they will all be returned. Entries in this list can be edited directly, and the list can be edited as well.
        operation - The synchronization operation for this change.
        Returns:
        The result of the plugin processing. Be very careful when returning PostStepResult#RETRY_OPERATION_UNLIMITED as this can stall all in flight operations until this operation completes. This return value should only be used in situations where a remote service (e.g., the LDAP server) is unavailable. In this case, it's preferable to just throw the underlying LDAPException, which the Data Sync Server will handle correctly based on the type of the operation.
        Throws:
        LDAPException - In general subclasses should not catch LDAPExceptions that are thrown when using the LDAPInterface unless there are specific exceptions that are expected. The Data Sync Server will handle LDAPExceptions in an appropriate way based on the specific cause of the exception. For example, some errors will result in the SyncOperation being retried, and others will trigger fail over to a different server. Plugins should only throw LDAPException for errors related to communication with the LDAP server. Use the return code to indicate other types of errors, which might require retry.

      • preCreate

        public PreStepResult preCreate​(LDAPInterface destinationConnection,
                               Entry entryToCreate,
                               SyncOperation operation)
                        throws LDAPException
        This method is called before a destination entry is created. A connection to the destination server is provided along with the Entry that will be sent to the server. This method is overridden by plugins that need to alter the entry before it is created at the server.
        Parameters:
        destinationConnection - A connection to the destination server.
        entryToCreate - The entry that will be created at the destination. A plugin that wishes to create the entry should be sure to return PreStepResult#SKIP_CURRENT_STEP.
        operation - The synchronization operation for this change.
        Returns:
        The result of the plugin processing. Be very careful when returning PreStepResult#RETRY_OPERATION_UNLIMITED as this can stall all in flight operations until this operation completes. This return value should only be used in situations where a remote service (e.g., the LDAP server) is unavailable. In this case, it's preferable to just throw the underlying LDAPException, which the Data Sync Server will handle correctly based on the type of the operation.
        Throws:
        LDAPException - In general subclasses should not catch LDAPExceptions that are thrown when using the LDAPInterface unless there are specific exceptions that are expected. The Data Sync Server will handle LDAPExceptions in an appropriate way based on the specific cause of the exception. For example, some errors will result in the SyncOperation being retried, and others will trigger fail over to a different server. Plugins should only throw LDAPException for errors related to communication with the LDAP server. Use the return code to indicate other types of errors, which might require retry.

      • preModify

        public PreStepResult preModify​(LDAPInterface destinationConnection,
                               Entry entryToModify,
                               java.util.List<Modification> modsToApply,
                               SyncOperation operation)
                        throws LDAPException
        This method is called before a destination entry is modified. A connection to the destination server is provided along with the Entry that will be sent to the server. This method is overridden by plugins that need to perform some processing on an entry before it is modified.
        Parameters:
        destinationConnection - A connection to the destination server.
        entryToModify - The entry that will be modified at the destination. A plugin that wishes to modify the entry should be sure to return PreStepResult#SKIP_CURRENT_STEP.
        modsToApply - A modifiable list of the modifications to apply at the server.
        operation - The synchronization operation for this change.
        Returns:
        The result of the plugin processing. Be very careful when returning PreStepResult#RETRY_OPERATION_UNLIMITED as this can stall all in flight operations until this operation completes. This return value should only be used in situations where a remote service (e.g., the LDAP server) is unavailable. In this case, it's preferable to just throw the underlying LDAPException, which the Data Sync Server will handle correctly based on the type of the operation.
        Throws:
        LDAPException - In general subclasses should not catch LDAPExceptions that are thrown when using the LDAPInterface unless there are specific exceptions that are expected. The Data Sync Server will handle LDAPExceptions in an appropriate way based on the specific cause of the exception. For example, some errors will result in the SyncOperation being retried, and others will trigger fail over to a different server. Plugins should only throw LDAPException for errors related to communication with the LDAP server. Use the return code to indicate other types of errors, which might require retry.

      • preDelete

        public PreStepResult preDelete​(LDAPInterface destinationConnection,
                               Entry entryToDelete,
                               SyncOperation operation)
                        throws LDAPException
        This method is called before a destination entry is deleted. A connection to the destination server is provided along with the Entry that will be sent to the server. This method is overridden by plugins that need to perform some processing on an entry before it is deleted. A plugin could choose to mark an entry as disabled instead of deleting it for instance, or move the entry to a different part of the directory hierarchy.
        Parameters:
        destinationConnection - A connection to the destination server.
        entryToDelete - The entry that will be deleted at the destination. A plugin that wishes to delete the entry should be sure to return PreStepResult#SKIP_CURRENT_STEP.
        operation - The synchronization operation for this change.
        Returns:
        The result of the plugin processing. Be very careful when returning PreStepResult#RETRY_OPERATION_UNLIMITED as this can stall all in flight operations until this operation completes. This return value should only be used in situations where a remote service (e.g., the LDAP server) is unavailable. In this case, it's preferable to just throw the underlying LDAPException, which the Data Sync Server will handle correctly based on the type of the operation.
        Throws:
        LDAPException - In general subclasses should not catch LDAPExceptions that are thrown when using the LDAPInterface unless there are specific exceptions that are expected. The Data Sync Server will handle LDAPExceptions in an appropriate way based on the specific cause of the exception. For example, some errors will result in the SyncOperation being retried, and others will trigger fail over to a different server. Plugins should only throw LDAPException for errors related to communication with the LDAP server. Use the return code to indicate other types of errors, which might require retry.

      • transformRequest

        public PreStepResult transformRequest​(LDAPInterface destinationConnection,
                                      UpdatableLDAPRequest request,
                                      SyncOperation operation)
                               throws LDAPException
        This method is called prior to executing any add, modify, delete, or search from the destination but after the respective pre method (e.g preFetch or preModify). A connection to the destination server is provided along with the UpdatableLDAPRequest that will be sent to the server. this method is overridden by plugins that need to modify the LDAP request prior to execution. For example, attaching a Control to the request. Callers of this method can use instanceof to determine which type of LDAP request is being made.
        Parameters:
        destinationConnection - A connection to the destination server.
        request - The LDAP request that will be sent to the destination server.
        operation - The synchronization operation for this change.
        Returns:
        The result of the plugin processing. Be very careful when returning PreStepResult#RETRY_OPERATION_UNLIMITED as this can stall all in flight operations until this operation completes. This return value should only be used in situations where a remote service (e.g., the LDAP server) is unavailable. In this case, it's preferable to just throw the underlying LDAPException, which the Data Sync Server will handle correctly based on the type of the operation.
        Throws:
        LDAPException - In general subclasses should not catch LDAPExceptions that are thrown when using the LDAPInterface unless there are specific exceptions that are expected. The Data Sync Server will handle LDAPExceptions in an appropriate way based on the specific cause of the exception. For example, some errors will result in the SyncOperation being retried, and others will trigger fail over to a different server. Plugins should only throw LDAPException for errors related to communication with the LDAP server. Use the return code to indicate other types of errors, which might require retry.

      • toString

        public final java.lang.String toString()
        Retrieves a string representation of this LDAP sync destination plugin.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this LDAP sync destination plugin.

      • toString

        public abstract void toString​(java.lang.StringBuilder buffer)
        Appends a string representation of this LDAP sync destination plugin to the provided buffer.
        Parameters:
        buffer - The buffer to which the string representation should be appended.

      • 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.