Package org.forgerock.opendj.config.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, AdminDataTrustManagerProvider, AdministrationConnector, AlertHandlerConfigManager, Argon2PasswordStorageScheme, AttributeCleanupPlugin, AttributeValuePasswordValidator, BackendConfigManager, BackendImpl, BcryptPasswordStorageScheme, CertificateMapper, CertificateMapperConfigManager, ChangeNumberControlPlugin, CharacterSetPasswordValidator, ConnectionHandlerConfigManager, ConsoleErrorLogPublisher, CoreConfigManager, CoreSchemaProvider, CRAMMD5SASLMechanismHandler, CryptoManager, CryptPasswordStorageScheme, DictionaryPasswordValidator, DigestMD5SASLMechanismHandler, EntityTagPlugin, EntityTagVirtualAttributeProvider, EntryCacheConfigManager, EntryCacheConfigManager.EntryCacheDispatcher, EntryContainer, EntryUUIDPlugin, ErrorLogAccountStatusNotificationHandler, ErrorLogger, ExactMatchIdentityMapper, ExtendedOperationConfigManager, ExternalSASLMechanismHandler, FIFOEntryCache, FileBasedKeyManagerProvider, FileBasedTrustManagerProvider, FileNumberRetentionPolicy, FingerprintCertificateMapper, FixedTimeRotationPolicy, FractionalLDIFImportPlugin, FreeDiskSpaceRetentionPolicy, GraphiteMonitorReporterPlugin, GSSAPISASLMechanismHandler, HTTPAccessLogger, HTTPConnectionHandler, HttpEndpointConfigManager, IdentityMapperConfigManager, JEBackend, JEStorage, JMXAlertHandler, JmxConnectionHandler, JsonEqualityMatchingRuleProvider, JsonOrderingMatchingRuleProvider, JsonQueryEqualityMatchingRuleProvider, KeyManagerProviderConfigManager, LastModPlugin, LDAPADListPlugin, LDAPConnectionHandler, LDAPKeyManagerProvider, LDAPReplicationDomain, LDAPTrustManagerProvider, LDIFBackend, LDIFConnectionHandler, LengthBasedPasswordValidator, LogRetentionPolicyConfigManager, LogRotationPolicyConfigManager, MemberVirtualAttributeProvider, MonitorBackend, MultimasterReplication, NameAndJsonQueryEqualityMatchingRuleProvider, PasswordGeneratorConfigManager, PasswordModifyExtendedOperation, PasswordPolicyImportPlugin, PasswordStorageSchemeConfigManager, PasswordValidatorConfigManager, PBKDF2HmacSHA256PasswordStorageScheme, PBKDF2HmacSHA512PasswordStorageScheme, PBKDF2PasswordStorageScheme, PemKeyManagerProvider, PemTrustManagerProvider, PKCS11KeyManagerProvider, Pkcs11TrustManagerProvider, PlainSASLMechanismHandler, PluginConfigManager, ProxyBackend, RandomPasswordGenerator, ReferentialIntegrityPlugin, RegularExpressionIdentityMapper, RepeatedCharactersPasswordValidator, ReplicationServer, ReplicationServiceDiscoveryMechanism, RootContainer, RootDSEBackend, SambaPasswordPlugin, SASLConfigManager, SchemaBackend, ScramSha256PasswordStorageScheme, ScramSha256SASLMechanismHandler, ScramSha512PasswordStorageScheme, ScramSha512SASLMechanismHandler, SevenBitCleanPlugin, SimilarityBasedPasswordValidator, SizeBasedRetentionPolicy, SizeBasedRotationPolicy, SMTPAccountStatusNotificationHandler, SMTPAlertHandler, SoftReferenceEntryCache, StaticServiceDiscoveryMechanism, SubjectAttributeToUserAttributeCertificateMapper, SubjectDNToUserAttributeCertificateMapper, SubjectEqualsDNCertificateMapper, SynchronizationProviderConfigManager, TaskBackend, TextAccessLogPublisher, TextAuditLogPublisher, TextErrorLogPublisher, TextHTTPAccessLogPublisher, TimeLimitRotationPolicy, TraditionalWorkQueue, TrustManagerProviderConfigManager, UniqueAttributePlugin, UniqueCharactersPasswordValidator, UserDefinedVirtualAttributeProvider, UserTemplateVirtualAttributeProvider, 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 Details

    • 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

      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.