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

All Superinterfaces:

Configurable

All Known Implementing Classes:

AccessLogger, AccountStatusNotificationHandler, AlertHandler, CertificateMapper, ChangeSubscriptionHandler, CipherStreamProvider, EnhancedPasswordStorageScheme, ErrorLogger, ExtendedOperationHandler, FileBasedAccessLogger, FileBasedErrorLogger, HTTPOperationLogger, HTTPServletExtension, IdentityMapper, JDBCSyncDestination, JDBCSyncSource, KeyManagerProvider, LDAPHealthCheck, LDAPSyncDestinationPlugin, LDAPSyncSourcePlugin, MonitorProvider, OAuthTokenHandler, PasswordGenerator, PasswordStorageScheme, PasswordValidator, PlacementAlgorithm, Plugin, PolicyInformationProvider, ProxyTransformation, SASLMechanismHandler, SyncDestination, SyncPipePlugin, SyncSource, Task, TokenStore, TrustManagerProvider, UncachedAttributeCriteria, UncachedEntryCriteria, VirtualAttributeProvider

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

This interface is used to mark extensions which may provide examples that demonstrate how they are intended to be used.

Method Summary

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.

Methods inherited from interface com.unboundid.directory.sdk.common.internal.Configurable

defineConfigArguments

Method Detail

getExamplesArgumentSets

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.

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.