com.unboundid.directory.sdk.common.internal
Interface Configurable

All Known Subinterfaces:

ExampleUsageProvider, Reconfigurable<T>

All Known Implementing Classes:

AccessLogger, AccountStatusNotificationHandler, AlertHandler, CertificateMapper, ChangeSubscriptionHandler, CipherStreamProvider, ConnectionCriteria, EnhancedPasswordStorageScheme, ErrorLogger, ExtendedOperationHandler, FileBasedAccessLogger, FileBasedErrorLogger, HTTPOperationLogger, HTTPServletExtension, IdentityMapper, JDBCSyncDestination, JDBCSyncSource, KeyManagerProvider, LDAPHealthCheck, LDAPSyncDestinationPlugin, LDAPSyncSourcePlugin, MonitorProvider, OAuthTokenHandler, OneTimePasswordDeliveryMechanism, PasswordGenerator, PasswordStorageScheme, PasswordValidator, PlacementAlgorithm, Plugin, PolicyInformationProvider, ProxiedExtendedOperationHandler, ProxyTransformation, RequestCriteria, ResultCriteria, SASLMechanismHandler, ScriptedAccessLogger, ScriptedAccountStatusNotificationHandler, ScriptedAlertHandler, ScriptedCertificateMapper, ScriptedChangeSubscriptionHandler, ScriptedErrorLogger, ScriptedFileBasedAccessLogger, ScriptedFileBasedErrorLogger, ScriptedHTTPOperationLogger, ScriptedHTTPServletExtension, ScriptedIdentityMapper, ScriptedJDBCSyncDestination, ScriptedJDBCSyncSource, ScriptedLDAPHealthCheck, ScriptedLDAPSyncDestinationPlugin, ScriptedLDAPSyncSourcePlugin, ScriptedOAuthTokenHandler, ScriptedPasswordGenerator, ScriptedPasswordValidator, ScriptedPlugin, ScriptedProxyTransformation, ScriptedSyncDestination, ScriptedSyncPipePlugin, ScriptedSyncSource, ScriptedTask, ScriptedUncachedAttributeCriteria, ScriptedUncachedEntryCriteria, ScriptedVirtualAttributeProvider, SearchEntryCriteria, SearchReferenceCriteria, StoreAdapter, SyncDestination, SyncPipePlugin, SyncSource, Task, TrustManagerProvider, UncachedAttributeCriteria, UncachedEntryCriteria, VelocityContextProvider, VirtualAttributeProvider

@NotExtensible
@ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface Configurable

This interface is used to mark extensions which may obtain configuration information using an LDAP SDK argument parser.

Method Summary

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.

Method Detail

defineConfigArguments

void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser)
                           throws com.unboundid.util.args.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).

Parameters:

parser - The argument parser to be updated with the configuration arguments which may be used by this extension.

Throws:

com.unboundid.util.args.ArgumentException - If a problem is encountered while updating the provided argument parser.