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

Class SyncPipePlugin

  • All Implemented Interfaces:
    Configurable, ExampleUsageProvider, Reconfigurable<SyncPipePluginConfig>, UnboundIDExtension
    @Extensible
@SynchronizationServerExtension(appliesToLocalContent=false,
                                appliesToSynchronizedContent=true)
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class SyncPipePlugin
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<SyncPipePluginConfig>, ExampleUsageProvider
    This class defines an API that must be implemented by extensions that perform processing on synchronization operations within the Sync Pipe. These extensions may be used to
    • Filter out certain changes from being synchronized.
    • Add and remove attributes that should be synchronized with the destination independent of whether they changed at the source or not.
    • Manipulate the changes that are synchronized to ignore certain modified attributes or change the representation of modified attributes.
    • Skip certain steps in Sync Pipe processing, e.g. attribute and DN mapping.
    Most plugins will need to override the postMapping method but not the preMapping method. These extensions do not have access to the Sync Source or Sync Destination.

    Configuring Sync Pipe Plugins

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

    • Constructor Summary

      Constructors 
      Constructor Description
      SyncPipePlugin()
      Creates a new instance of this sync pipe plugin.

    • Constructor Detail

      • SyncPipePlugin

        public SyncPipePlugin()
        Creates a new instance of this sync pipe plugin. All sync pipe plugin implementations must include a default constructor, but any initialization should generally be done in the initializeSyncPipePlugin 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.

      • initializeSyncPipePlugin

        public void initializeSyncPipePlugin​(SyncServerContext serverContext,
                                     SyncPipePluginConfig config,
                                     ArgumentParser parser)
                              throws LDAPException
        Initializes this sync pipe 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 sync pipe plugin.
        Throws:
        LDAPException - If a problem occurs while initializing this sync pipe plugin.

      • isConfigurationAcceptable

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

      • finalizeSyncPipePlugin

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

      • toString

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

      • toString

        public abstract void toString​(java.lang.StringBuilder buffer)
        Appends a string representation of this sync pipe 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.