com.unboundid.directory.sdk.sync.api

Class KafkaSyncDestinationPlugin

java.lang.Object

com.unboundid.directory.sdk.sync.api.KafkaSyncDestinationPlugin

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<KafkaSyncDestinationPluginConfig>, UnboundIDExtension

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

This class defines an API that must be implemented by extensions that perform processing on synchronization operations within a Kafka Sync Destination. These extensions may be used to

• Filter out messages being published to Kafka.
• Modify the format or contents of messages before publishing.
• Modify the message key before publishing.

Configuring Kafka Sync Destination Plugins

In order to configure a Kafka sync destination plugin created using this API, use a command like:

   dsconfig create-sync-destination-plugin \
        --plugin-name "{plugin-name}" \
        --type third-party-kafka \
        --set "extension-class:{class-name}" \
        --set "extension-argument:{name=value}"
 

where "{plugin-name}" is the name to use for the Kafka sync destination plugin instance, "{class-name}" is the fully- qualified name of the Java class that extends com.unboundid.directory.sdk.sync.api.KafkaSyncDestinationPlugin, and "{name=value}" represents name-value pairs for any arguments to provide to the Kafka sync destination plugin. If multiple arguments should be provided to the plugin, then the "extension-argument" option should be provided multiple times.

Constructor Summary

Constructors

Constructor and Description
KafkaSyncDestinationPlugin() Creates a new instance of this Kafka sync destination plugin.

Method Summary

Modifier and Type	Method and Description
ResultCode	applyConfiguration(KafkaSyncDestinationPluginConfig 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.
void	finalizeKafkaSyncDestinationPlugin() Performs any cleanup that may be necessary when this Kafka sync destination plugin is 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	initializeKafkaSyncDestinationPlugin(SyncServerContext serverContext, KafkaSyncDestinationPluginConfig config, ArgumentParser parser) Initialized this Kafka sync destination plugin.
boolean	isConfigurationAcceptable(KafkaSyncDestinationPluginConfig 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.
PreStepResult	prePublish(KafkaMessage message, SyncOperation operation) Provides the ability to alter or suppress Kafka messages.
java.lang.String	toString() Retrieves a string representation of this Kafka sync destination plugin.
abstract void	toString(java.lang.StringBuilder buffer) Appends a string representation of this Kafka sync destination plugin to the provided buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

KafkaSyncDestinationPlugin

public KafkaSyncDestinationPlugin()

Creates a new instance of this Kafka sync destination plugin. All sync destination implementations must include a default constructor, but any initialization should generally be done in the initializeKafkaSyncDestinationPlugin method.

Method Detail

getExtensionName

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

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.

initializeKafkaSyncDestinationPlugin

public void initializeKafkaSyncDestinationPlugin(SyncServerContext serverContext,
                                                 KafkaSyncDestinationPluginConfig config,
                                                 ArgumentParser parser)

Initialized this Kafka 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 plugin.

parser - The argument parser which has been initialized from the configuration for this Kafka sync destination plugin.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(KafkaSyncDestinationPluginConfig 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<KafkaSyncDestinationPluginConfig>

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(KafkaSyncDestinationPluginConfig 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<KafkaSyncDestinationPluginConfig>

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.

finalizeKafkaSyncDestinationPlugin

public void finalizeKafkaSyncDestinationPlugin()

Performs any cleanup that may be necessary when this Kafka sync destination plugin is taken out of service. This can happen when it is deleted from the configuration and at server shutdown.

prePublish

public PreStepResult prePublish(KafkaMessage message,
                                SyncOperation operation)

Provides the ability to alter or suppress Kafka messages. This method is called before a message is published to the configured Kafka Topic.

Parameters:

message - The message to be published to the Kafka Topic.

operation - The synchronization operation for this change.

Returns:

The result of the plugin processing.

toString

public final java.lang.String toString()

Retrieves a string representation of this Kafka sync destination plugin.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this Kafka sync destination plugin.

toString

public abstract void toString(java.lang.StringBuilder buffer)

Appends a string representation of this Kafka 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.