Package com.unboundid.directory.sdk.sync.scripting

Class ScriptedLDAPSyncSourcePlugin

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

    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 Groovy-Scripted LDAP Sync Source Plugins

    In order to configure a scripted LDAP sync source plugin based on this API and written in the Groovy scripting language, use a command like: 
          dsconfig create-sync-source-plugin \
           --plugin-name "{plugin-name}" \
           --type groovy-scripted-ldap \
           --set "script-class:{class-name}" \
           --set "script-argument:{name=value}"
    where "{plugin-name}" is the name to use for the LDAP sync source plugin instance, "{class-name}" is the fully-qualified name of the Groovy class written using this API, and "{name=value}" represents name-value pairs for any arguments to provide to the LDAP sync source plugin. If multiple arguments should be provided to the LDAP sync source plugin, then the "--set script-argument:{name=value}" option should be provided multiple times.
    See Also:
    LDAPSyncSourcePlugin

    • Constructor Detail

      • ScriptedLDAPSyncSourcePlugin

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

    • Method Detail

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

      • initializeLDAPSyncSourcePlugin

        public void initializeLDAPSyncSourcePlugin​(SyncServerContext serverContext,
                                           LDAPSyncSourcePluginConfig config,
                                           ArgumentParser parser)
                                    throws LDAPException
        Initializes this LDAP sync source plugin.
        Parameters:
        serverContext - A handle to the server context for the server in which this extension is running.
        config - The general configuration for this LDAP sync source plugin transformation.
        parser - The argument parser which has been initialized from the configuration for this LDAP sync source plugin.
        Throws:
        LDAPException - If a problem occurs while initializing this LDAP sync source plugin.

      • finalizeLDAPSyncSourcePlugin

        public void finalizeLDAPSyncSourcePlugin()
        Performs any cleanup which may be necessary when this LDAP sync source plugin is to be taken out of service.

      • isConfigurationAcceptable

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

      • postFetch

        public PostStepResult postFetch​(LDAPInterface sourceConnection,
                                java.util.concurrent.atomic.AtomicReference<Entry> fetchedEntryRef,
                                SyncOperation operation)
                         throws LDAPException
        This method is called after fetching a source entry. A connection to the source server is provided. 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.
        Parameters:
        sourceConnection - A connection to the source server.
        fetchedEntryRef - A reference to the entry that was fetched. This entry can be edited in place, or the reference can be changed to point to a different entry that the plugin constructs.
        operation - The synchronization operation for this change.
        Returns:
        The result of the plugin processing.
        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.