org.opends.server.api
Interface ConfigChangeListener

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
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

ConfigChangeResult	applyConfigurationChange(ConfigEntry configEntry) Attempts to apply a new configuration to this Directory Server component based on the provided changed entry.
boolean	configChangeIsAcceptable(ConfigEntry configEntry, MessageBuilder unacceptableReason) Indicates whether the configuration entry that will result from a proposed modification is acceptable to this change listener.

Method Detail

configChangeIsAcceptable

boolean configChangeIsAcceptable(ConfigEntry configEntry,
                                 MessageBuilder 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(ConfigEntry 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.