Package org.forgerock.opendj.config.server.spi

Interface ConfigChangeListener

  • public interface ConfigChangeListener
    This interface defines the methods that a Directory Server component should implement if it wishes to be able to receive notification of changes to a configuration entry.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ConfigChangeResult applyConfigurationChange​(org.forgerock.opendj.ldap.Entry configEntry)
      Attempts to apply a new configuration to this Directory Server component based on the provided changed entry.
      boolean configChangeIsAcceptable​(org.forgerock.opendj.ldap.Entry configEntry, org.forgerock.i18n.LocalizableMessageBuilder unacceptableReason)
      Indicates whether the configuration entry that will result from a proposed modification is acceptable to this change listener.

    • Method Detail

      • configChangeIsAcceptable

        boolean configChangeIsAcceptable​(org.forgerock.opendj.ldap.Entry configEntry,
                                 org.forgerock.i18n.LocalizableMessageBuilder unacceptableReason)
        Indicates whether the configuration entry that will result from a proposed modification is acceptable to this change listener.
        Parameters:
        configEntry - The configuration entry that will result from the requested update.
        unacceptableReason - A buffer to which this method can append a human-readable message explaining why the proposed change is not acceptable.
        Returns:
        true if the proposed entry contains an acceptable configuration, or false if it does not.

      • applyConfigurationChange

        ConfigChangeResult applyConfigurationChange​(org.forgerock.opendj.ldap.Entry configEntry)
        Attempts to apply a new configuration to this Directory Server component based on the provided changed entry.
        Parameters:
        configEntry - The configuration entry that containing the updated configuration for this component.
        Returns:
        Information about the result of processing the configuration change.