|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.ds.api.ExtendedOperationHandler
@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
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.
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 | |
---|---|
ExtendedOperationHandler()
Creates a new instance of this extended operation handler. |
Method Summary | |
---|---|
com.unboundid.ldap.sdk.ResultCode |
applyConfiguration(ExtendedOperationHandlerConfig config,
com.unboundid.util.args.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(com.unboundid.util.args.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,
com.unboundid.util.args.ArgumentParser parser)
Initializes this extended operation handler. |
boolean |
isConfigurationAcceptable(ExtendedOperationHandlerConfig config,
com.unboundid.util.args.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 |
---|
public ExtendedOperationHandler()
initializeExtendedOperationHandler
method.
Method Detail |
---|
public abstract java.lang.String getExtensionName()
getExtensionName
in interface UnboundIDExtension
public abstract java.lang.String[] getExtensionDescription()
getExtensionDescription
in interface UnboundIDExtension
null
or an empty array if no description should be available.public void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.util.args.ArgumentException
defineConfigArguments
in interface Configurable
parser
- The argument parser to be updated with the configuration
arguments which may be used by this extension.
com.unboundid.util.args.ArgumentException
- If a problem is encountered while updating the
provided argument parser.public void initializeExtendedOperationHandler(DirectoryServerContext serverContext, ExtendedOperationHandlerConfig config, com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.ldap.sdk.LDAPException
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.
com.unboundid.ldap.sdk.LDAPException
- If a problem occurs while initializing this
extended operation handler.public boolean isConfigurationAcceptable(ExtendedOperationHandlerConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)
isConfigurationAcceptable
in interface Reconfigurable<ExtendedOperationHandlerConfig>
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.
true
if the configuration in the provided argument parser
appears to be acceptable, or false
if not.public com.unboundid.ldap.sdk.ResultCode applyConfiguration(ExtendedOperationHandlerConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)
applyConfiguration
in interface Reconfigurable<ExtendedOperationHandlerConfig>
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.
SUCCESS
should be
used to indicate that all processing completed successfully. Any
other result will indicate that a problem occurred during
processing.public void finalizeExtendedOperationHandler()
public abstract java.lang.String getExtendedOperationName(java.lang.String oid)
oid
- The OID of the extended operation for which to retrieve the
corresponding name.
null
if the specified OID is not recognized by this
extended operation handler.public abstract java.util.Set<java.lang.String> getSupportedExtensions()
null
or
empty, and the contents of the set returned must not change over
the life of this extended operation handler.public java.util.Set<java.lang.String> getSupportedControls()
null
or empty if this extended
operation handler does not support any controls.public java.util.Set<java.lang.String> getSupportedFeatures()
null
or empty if this extended
operation handler does not support any features.public abstract void processExtendedOperation(OperationContext operationContext, ExtendedRequest request, UpdatableExtendedResult result)
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.public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()
getExamplesArgumentSets
in interface ExampleUsageProvider
null
or empty if there should
not be any example argument sets.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |