org.opends.server.api
Interface ConfigAddListener

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public interface ConfigAddListener

This interface defines the methods that a Directory Server component should implement if it wishes to be able to receive notification of new entries added below a configuration entry.

Method Summary

ConfigChangeResult	applyConfigurationAdd(ConfigEntry configEntry) Attempts to apply a new configuration based on the provided added entry.
boolean	configAddIsAcceptable(ConfigEntry configEntry, MessageBuilder unacceptableReason) Indicates whether the configuration entry that will result from a proposed add is acceptable to this add listener.

Method Detail

configAddIsAcceptable

boolean configAddIsAcceptable(ConfigEntry configEntry,
                              MessageBuilder unacceptableReason)

Indicates whether the configuration entry that will result from a proposed add is acceptable to this add listener.

Parameters:

configEntry - The configuration entry that will result from the requested add.

unacceptableReason - A buffer to which this method can append a human-readable message explaining why the proposed entry is not acceptable.

Returns:

true if the proposed entry contains an acceptable configuration, or false if it does not.

applyConfigurationAdd

ConfigChangeResult applyConfigurationAdd(ConfigEntry configEntry)

Attempts to apply a new configuration based on the provided added entry.

Parameters:

configEntry - The new configuration entry that contains the configuration to apply.

Returns:

Information about the result of processing the configuration change.