com.unboundid.directory.sdk.common.internal

Interface Reconfigurable<T>

Type Parameters:

T - The type of configuration associated with this extension.

All Superinterfaces:

Configurable

All Known Implementing Classes:

AccessLogger, AccountStatusNotificationHandler, AlertHandler, CertificateMapper, ChangeDetector, ChangeSubscriptionHandler, CipherStreamProvider, ConnectionCriteria, EnhancedPasswordStorageScheme, ErrorLogger, ExtendedOperationHandler, FileBasedAccessLogger, FileBasedErrorLogger, HTTPOperationLogger, HTTPServletExtension, IdentityMapper, KafkaSyncDestinationPlugin, KeyManagerProvider, LDAPHealthCheck, LDAPSyncDestinationPlugin, LDAPSyncSourcePlugin, LogFileRotationListener, MonitorProvider, NotificationManager, OAuthTokenHandler, OneTimePasswordDeliveryMechanism, PassphraseProvider, PassThroughAuthenticationHandler, PasswordGenerator, PasswordStorageScheme, PasswordValidator, PlacementAlgorithm, Plugin, ProxiedExtendedOperationHandler, ProxyTransformation, RecurringTask, RequestCriteria, ResultCriteria, SASLMechanismHandler, SCIM2AttributeMapping, SCIMSubResourceTypeHandler, ScriptedAccessLogger, ScriptedAccountStatusNotificationHandler, ScriptedAlertHandler, ScriptedCertificateMapper, ScriptedChangeSubscriptionHandler, ScriptedErrorLogger, ScriptedFileBasedAccessLogger, ScriptedFileBasedErrorLogger, ScriptedHTTPOperationLogger, ScriptedHTTPServletExtension, ScriptedIdentityMapper, ScriptedLDAPHealthCheck, ScriptedLDAPSyncDestinationPlugin, ScriptedLDAPSyncSourcePlugin, ScriptedOAuthTokenHandler, ScriptedPasswordGenerator, ScriptedPasswordValidator, ScriptedPlugin, ScriptedProxyTransformation, ScriptedSyncPipePlugin, ScriptedUncachedAttributeCriteria, ScriptedUncachedEntryCriteria, ScriptedVirtualAttributeProvider, SearchEntryCriteria, SearchReferenceCriteria, ServerAffinityProvider, SyncPipePlugin, TokenResourceLookupMethod, TrustManagerProvider, UncachedAttributeCriteria, UncachedEntryCriteria, VelocityContextProvider, VirtualAttributeProvider

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface Reconfigurable<T>
extends Configurable

This interface is used to mark extensions which may be notified of changes to their configuration. They will be given the chance to validate those changes before they are accepted by the server, and to be notified when configuration changes are accepted so that they may be reflected in the behavior of the extension.

Method Summary

Modifier and Type	Method and Description
ResultCode	applyConfiguration(T 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.
boolean	isConfigurationAcceptable(T 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.

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

defineConfigArguments

Method Detail

isConfigurationAcceptable

boolean isConfigurationAcceptable(T 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.

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

ResultCode applyConfiguration(T 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.

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.