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

Class ExtendedOperationHandler

java.lang.Object

com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<ExtendedOperationHandlerConfig>, UnboundIDExtension

@Extensible
@DirectoryServerExtension
@DirectoryProxyServerExtension(appliesToLocalContent=true,
                               appliesToRemoteContent=true,
                               notes="Some extended operation handlers may only apply to local content")
@SynchronizationServerExtension(appliesToLocalContent=true,
                                appliesToSynchronizedContent=false)
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class ExtendedOperationHandler
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<ExtendedOperationHandlerConfig>, ExampleUsageProvider

This class defines an API that must be implemented by extensions which are used to process extended operations within the server. Extended operations may be used to perform processing which falls outside of that available by the core set of LDAP operations. Each extended request will include a numeric object identifier (OID) which indicates the type of request to be processed, and may also include a value with additional information about the processing to be performed. Each extended operation handler must specify the OIDs of the types of extended requests that it may be used to process.

Configuring Extended Operation Handlers

In order to configure an extended operation handler created using this API, use a command like:

      dsconfig create-extended-operation-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 extended operation handler instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler, and "{name=value}" represents name-value pairs for any arguments to provide to the extended operation handler. If multiple arguments should be provided to the extended operation handler, then the "--set extension-argument:{name=value}" option should be provided multiple times.

Constructor Summary

Constructors

Constructor	Description
ExtendedOperationHandler()	Creates a new instance of this extended operation handler.

Method Summary

Modifier and Type	Method	Description
ResultCode	applyConfiguration(ExtendedOperationHandlerConfig 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	finalizeExtendedOperationHandler()	Performs any cleanup which may be necessary when this extended operation 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	getExtendedOperationName(java.lang.String oid)	Retrieves the name of the extended operation with the provided OID.
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.
java.util.Set<java.lang.String>	getSupportedControls()	Retrieves the OIDs of any controls supported by this extended operation handler.
abstract java.util.Set<java.lang.String>	getSupportedExtensions()	Retrieves the OIDs of the extended operation types supported by this extended operation handler.
java.util.Set<java.lang.String>	getSupportedFeatures()	Retrieves the OIDs of any features supported by this extended operation handler that should be advertised in the server root DSE.
void	initializeExtendedOperationHandler(DirectoryServerContext serverContext, ExtendedOperationHandlerConfig config, ArgumentParser parser)	Initializes this extended operation handler.
boolean	isConfigurationAcceptable(ExtendedOperationHandlerConfig 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	processExtendedOperation(OperationContext operationContext, ExtendedRequest request, UpdatableExtendedResult result)	Performs any processing appropriate for the provided extended request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedOperationHandler

public ExtendedOperationHandler()

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

initializeExtendedOperationHandler

public void initializeExtendedOperationHandler(DirectoryServerContext serverContext,
                                               ExtendedOperationHandlerConfig config,
                                               ArgumentParser parser)
                                        throws LDAPException

Initializes this extended operation handler.

Parameters:

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

config - The general configuration for this extended operation handler.

parser - The argument parser which has been initialized from the configuration for this extended operation handler.

Throws:

LDAPException - If a problem occurs while initializing this extended operation handler.

isConfigurationAcceptable

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

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

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.

finalizeExtendedOperationHandler

public void finalizeExtendedOperationHandler()

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

getExtendedOperationName

public abstract java.lang.String getExtendedOperationName(java.lang.String oid)

Retrieves the name of the extended operation with the provided OID.

Parameters:

oid - The OID of the extended operation for which to retrieve the corresponding name.

Returns:

The name of the extended operation with the specified OID, or null if the specified OID is not recognized by this extended operation handler.

getSupportedExtensions

public abstract java.util.Set<java.lang.String> getSupportedExtensions()

Retrieves the OIDs of the extended operation types supported by this extended operation handler.

Returns:

The OIDs of the extended operation types supported by this extended operation handler. It must not be null or empty, and the contents of the set returned must not change over the life of this extended operation handler.

getSupportedControls

public java.util.Set<java.lang.String> getSupportedControls()

Retrieves the OIDs of any controls supported by this extended operation handler.

Returns:

The OIDs of any controls supported by this extended operation handler. It may be null or empty if this extended operation handler does not support any controls.

getSupportedFeatures

public java.util.Set<java.lang.String> getSupportedFeatures()

Retrieves the OIDs of any features supported by this extended operation handler that should be advertised in the server root DSE.

Returns:

The OIDs of any features supported by this extended operation handler. It may be null or empty if this extended operation handler does not support any features.

processExtendedOperation

public abstract void processExtendedOperation(OperationContext operationContext,
                                              ExtendedRequest request,
                                              UpdatableExtendedResult result)

Performs any processing appropriate for the provided extended request.

Parameters:

operationContext - The operation context for the extended operation.

request - The extended request to be processed.

result - The extended result to be updated with the result of processing.

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.