org.opends.server.admin.server

Interface ConfigurationChangeListener<T extends Configuration>

Type Parameters:

T - The type of configuration that this listener should be notified about.

All Known Implementing Classes:

AbstractLogger, AccessControlConfigManager, AccessLogger, AccountStatusNotificationHandlerConfigManager, AdministrationConnector, AlertHandlerConfigManager, AttributeCleanupPlugin, AttributeSyntaxConfigManager, AttributeTypeSyntax, AttributeValuePasswordValidator, BackendConfigManager, BackendImpl, BackupBackend, BcryptPasswordStorageScheme, CertificateMapperConfigManager, CertificateSyntax, ChangeNumberControlPlugin, CharacterSetPasswordValidator, CollationMatchingRuleFactory, ConnectionHandlerConfigManager, CoreConfigManager, CountryStringSyntax, CRAMMD5SASLMechanismHandler, CryptoManagerImpl, CryptPasswordStorageScheme, DebugLogger, DefaultEntryCache, DictionaryPasswordValidator, DigestMD5SASLMechanismHandler, DirectoryStringSyntax, EntityTagVirtualAttributeProvider, EntryCacheConfigManager, EntryContainer, EntryUUIDPlugin, ErrorLogAccountStatusNotificationHandler, ErrorLogger, ExactMatchIdentityMapper, ExtendedOperationConfigManager, ExternalChangelogDomain, ExternalSASLMechanismHandler, FIFOEntryCache, FileBasedKeyManagerProvider, FileBasedTrustManagerProvider, FileNumberRetentionPolicy, FingerprintCertificateMapper, FixedTimeRotationPolicy, FractionalLDIFImportPlugin, FreeDiskSpaceRetentionPolicy, GroupManager, GSSAPISASLMechanismHandler, HTTPAccessLogger, HTTPConnectionHandler, IdentityMapperConfigManager, JEBackend, JEStorage, JMXAlertHandler, JmxConnectionHandler, JPEGSyntax, KeyManagerProviderConfigManager, LastModPlugin, LDAPADListPlugin, LDAPConnectionHandler, LDAPReplicationDomain, LDIFBackend, LDIFConnectionHandler, LengthBasedPasswordValidator, LogRetentionPolicyConfigManager, LogRotationPolicyConfigManager, MatchingRuleConfigManager, MemberVirtualAttributeProvider, MonitorBackend, MonitorConfigManager, MultimasterReplication, ParallelWorkQueue, PasswordGeneratorConfigManager, PasswordModifyExtendedOperation, PasswordPolicyImportPlugin, PasswordStorageSchemeConfigManager, PasswordValidatorConfigManager, PBKDF2PasswordStorageScheme, PDBBackend, PDBStorage, PKCS11KeyManagerProvider, PlainSASLMechanismHandler, PluginConfigManager, ProfilerPlugin, RandomPasswordGenerator, ReferentialIntegrityPlugin, RegularExpressionIdentityMapper, RepeatedCharactersPasswordValidator, ReplicationServer, RootContainer, RootDNConfigManager, RootDSEBackend, RootPrivilegeChangeListener, SambaPasswordPlugin, SASLConfigManager, SchemaBackend, SevenBitCleanPlugin, SimilarityBasedPasswordValidator, SizeBasedRetentionPolicy, SizeBasedRotationPolicy, SMTPAccountStatusNotificationHandler, SMTPAlertHandler, SoftReferenceEntryCache, SubjectAttributeToUserAttributeCertificateMapper, SubjectDNToUserAttributeCertificateMapper, SynchronizationProviderConfigManager, TaskBackend, TelephoneNumberSyntax, TextAccessLogPublisher, TextAuditLogPublisher, TextDebugLogPublisher, TextErrorLogPublisher, TextHTTPAccessLogPublisher, TimeLimitRotationPolicy, TraceSettings, TraditionalWorkQueue, TrustManagerProviderConfigManager, TrustStoreBackend, UniqueAttributePlugin, UniqueCharactersPasswordValidator, UserDefinedVirtualAttributeProvider, VirtualAttributeConfigManager, WorkQueueConfigManager

public interface ConfigurationChangeListener<T extends Configuration>

This interface defines the methods that a Directory Server configurable component should implement if it wishes to be able to receive notifications when a its associated configuration is changed.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(T configuration) Applies the configuration changes to this change listener.
boolean	isConfigurationChangeAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.

Method Detail

isConfigurationChangeAcceptable

boolean isConfigurationChangeAcceptable(T configuration,
                                      List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Parameters:

configuration - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(T configuration)

Applies the configuration changes to this change listener.

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.