com.unboundid.directory.sdk.common.internal

Interface ExampleUsageProvider

All Superinterfaces:

Configurable

All Known Implementing Classes:

AccessLogger, AccessTokenValidator, AccountStatusNotificationHandler, Advice, AlertHandler, CertificateMapper, ChangeDetector, ChangeSubscriptionHandler, CipherStreamProvider, ConnectionCriteria, EnhancedPasswordStorageScheme, ErrorLogger, ExtendedOperationHandler, FileBasedAccessLogger, FileBasedErrorLogger, HTTPOperationLogger, HTTPServletExtension, IdentityMapper, JDBCSyncDestination, JDBCSyncSource, KafkaSyncDestinationPlugin, KeyManagerProvider, LDAPHealthCheck, LDAPSyncDestinationPlugin, LDAPSyncSourcePlugin, LogFileRotationListener, MonitorProvider, NotificationManager, OAuthTokenHandler, OneTimePasswordDeliveryMechanism, PassphraseProvider, PassThroughAuthenticationHandler, PasswordGenerator, PasswordStorageScheme, PasswordValidator, PlacementAlgorithm, Plugin, ProxiedExtendedOperationHandler, ProxyTransformation, RecurringTask, RequestCriteria, ResultCriteria, SASLMechanismHandler, SCIMSubResourceTypeHandler, SearchEntryCriteria, SearchReferenceCriteria, ServerAffinityProvider, StoreAdapter, StoreAdapterPlugin, SyncDestination, SyncPipePlugin, SyncSource, Task, TokenResourceLookupMethod, TrustManagerProvider, UncachedAttributeCriteria, UncachedEntryCriteria, VelocityContextProvider, 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

Modifier and Type	Method and Description
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.