org.opends.server.api
Interface ConfigDeleteListener

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

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

Method Summary

ConfigChangeResult	applyConfigurationDelete(ConfigEntry configEntry) Attempts to apply a new configuration based on the provided deleted entry.
boolean	configDeleteIsAcceptable(ConfigEntry configEntry, MessageBuilder unacceptableReason) Indicates whether it is acceptable to remove the provided configuration entry.

Method Detail

configDeleteIsAcceptable

boolean configDeleteIsAcceptable(ConfigEntry configEntry,
                                 MessageBuilder unacceptableReason)

Indicates whether it is acceptable to remove the provided configuration entry.

Parameters:

configEntry - The configuration entry that will be removed from the configuration.

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

Returns:

true if the proposed entry may be removed from the configuration, or false if not.

applyConfigurationDelete

ConfigChangeResult applyConfigurationDelete(ConfigEntry configEntry)

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

Parameters:

configEntry - The new configuration entry that has been deleted.

Returns:

Information about the result of processing the configuration change.