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

Class ChangeSubscriptionHandler

java.lang.Object

com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<ChangeSubscriptionHandlerConfig>, UnboundIDExtension

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

This class defines an API that must be implemented by extensions which receive notification of changes of interest processed within the server. The server may be configured with one or more change subscriptions, which use criteria to identify the types of changes that should be made available to change subscription handlers. Each change subscription handler may be configured either to be notified only for changes matching a specific set of change subscriptions, or for changes matching the criteria for any subscription defined in the server. This is handled automatically by the server, so individual change subscription handler implementations do not need to attempt to perform that filtering on their own. However, they may perform additional processing if desired to further narrow the set of changes to be processed.

Configuring Change Subscription Handlers

In order to configure a change subscription handler created using this API, use a command like:

      dsconfig create-change-subscription-handler \
           --handler-name "{handler-name}" \
           --type third-party \
           --set enabled:true \
           --set "extension-class:{class-name}" \
           --set "extension-argument:{name=value}"
 

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

See Also:

ScriptedChangeSubscriptionHandler

Constructor Summary

Constructors

Constructor	Description
ChangeSubscriptionHandler()	Creates a new instance of this change subscription handler.

Method Summary

Modifier and Type	Method	Description
abstract void	addOperationProcessed(CompletedOperationContext operationContext, java.math.BigInteger sequenceNumber, java.util.Set<ChangeSubscription> changeSubscriptions, AddRequest addRequest, AddResult addResult, Entry entry)	Performs any processing necessary for an add operation matching the subscription criteria.
ResultCode	applyConfiguration(ChangeSubscriptionHandlerConfig 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	deleteOperationProcessed(CompletedOperationContext operationContext, java.math.BigInteger sequenceNumber, java.util.Set<ChangeSubscription> changeSubscriptions, DeleteRequest deleteRequest, DeleteResult deleteResult, Entry entry)	Performs any processing necessary for a delete operation matching the subscription criteria.
void	finalizeChangeSubscriptionHandler()	Performs any cleanup which may be necessary when this change subscription handler 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	initializeChangeSubscriptionHandler(DirectoryServerContext serverContext, ChangeSubscriptionHandlerConfig config, ArgumentParser parser)	Initializes this change subscription handler.
boolean	isConfigurationAcceptable(ChangeSubscriptionHandlerConfig 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.
abstract void	modifyDNOperationProcessed(CompletedOperationContext operationContext, java.math.BigInteger sequenceNumber, java.util.Set<ChangeSubscription> changeSubscriptions, ModifyDNRequest modifyDNRequest, ModifyDNResult modifyDNResult, Entry oldEntry, Entry newEntry)	Performs any processing necessary for a modify DN operation matching the subscription criteria.
abstract void	modifyOperationProcessed(CompletedOperationContext operationContext, java.math.BigInteger sequenceNumber, java.util.Set<ChangeSubscription> changeSubscriptions, ModifyRequest modifyRequest, ModifyResult modifyResult, Entry oldEntry, Entry newEntry)	Performs any processing necessary for a modify operation matching the subscription criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeSubscriptionHandler

public ChangeSubscriptionHandler()

Creates a new instance of this change subscription handler. All change subscription handler implementations must include a default constructor, but any initialization should generally be done in the initializeChangeSubscriptionHandler 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.

initializeChangeSubscriptionHandler

public void initializeChangeSubscriptionHandler(DirectoryServerContext serverContext,
                                                ChangeSubscriptionHandlerConfig config,
                                                ArgumentParser parser)
                                         throws LDAPException

Initializes this change subscription handler.

Parameters:

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

config - The general configuration for this change subscription handler.

parser - The argument parser which has been initialized from the configuration for this change subscription handler.

Throws:

LDAPException - If a problem occurs while initializing this change subscription handler.

isConfigurationAcceptable

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

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

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.

finalizeChangeSubscriptionHandler

public void finalizeChangeSubscriptionHandler()

Performs any cleanup which may be necessary when this change subscription handler is to be taken out of service.

addOperationProcessed

public abstract void addOperationProcessed(CompletedOperationContext operationContext,
                                           java.math.BigInteger sequenceNumber,
                                           java.util.Set<ChangeSubscription> changeSubscriptions,
                                           AddRequest addRequest,
                                           AddResult addResult,
                                           Entry entry)

Performs any processing necessary for an add operation matching the subscription criteria.

Parameters:

operationContext - The context for the add operation.

sequenceNumber - The sequence number for the change subscription notification.

changeSubscriptions - The set of change subscriptions whose criteria matched the add operation.

addRequest - Information about the request for the add operation that was processed.

addResult - Information about the result for the add operation that was processed.

entry - The entry that was added to the server.

deleteOperationProcessed

public abstract void deleteOperationProcessed(CompletedOperationContext operationContext,
                                              java.math.BigInteger sequenceNumber,
                                              java.util.Set<ChangeSubscription> changeSubscriptions,
                                              DeleteRequest deleteRequest,
                                              DeleteResult deleteResult,
                                              Entry entry)

Performs any processing necessary for a delete operation matching the subscription criteria.

Parameters:

operationContext - The context for the delete operation.

sequenceNumber - The sequence number for the change subscription notification.

changeSubscriptions - The set of change subscriptions whose criteria matched the delete operation.

deleteRequest - Information about the request for the delete operation that was processed.

deleteResult - Information about the result for the delete operation that was processed.

entry - The entry that was removed from the server.

modifyOperationProcessed

public abstract void modifyOperationProcessed(CompletedOperationContext operationContext,
                                              java.math.BigInteger sequenceNumber,
                                              java.util.Set<ChangeSubscription> changeSubscriptions,
                                              ModifyRequest modifyRequest,
                                              ModifyResult modifyResult,
                                              Entry oldEntry,
                                              Entry newEntry)

Performs any processing necessary for a modify operation matching the subscription criteria.

Parameters:

operationContext - The context for the modify operation.

sequenceNumber - The sequence number for the change subscription notification.

changeSubscriptions - The set of change subscriptions whose criteria matched the modify operation.

modifyRequest - Information about the request for the modify operation that was processed.

modifyResult - Information about the result for the modify operation that was processed.

oldEntry - The entry as it appeared before the changes were applied.

newEntry - The entry as it appeared immediately after the changes were applied.

modifyDNOperationProcessed

public abstract void modifyDNOperationProcessed(CompletedOperationContext operationContext,
                                                java.math.BigInteger sequenceNumber,
                                                java.util.Set<ChangeSubscription> changeSubscriptions,
                                                ModifyDNRequest modifyDNRequest,
                                                ModifyDNResult modifyDNResult,
                                                Entry oldEntry,
                                                Entry newEntry)

Performs any processing necessary for a modify DN operation matching the subscription criteria.

Parameters:

operationContext - The context for the modify DN operation.

sequenceNumber - The sequence number for the change subscription notification.

changeSubscriptions - The set of change subscriptions whose criteria matched the modify DN operation.

modifyDNRequest - Information about the request for the modify DN operation that was processed.

modifyDNResult - Information about the result for the modify DN operation that was processed.

oldEntry - The entry as it appeared before being renamed.

newEntry - The entry as it appeared immediately after being renamed.

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.