ConfigChangeListener.java revision bccd35904bb6c244e7eae5b7ddb28e5c295e856b
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
*/
/**
* 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.
*/
public interface ConfigChangeListener {
/**
* Indicates whether the configuration entry that will result from a
* proposed modification is acceptable to this change listener.
*
* @param configEntry
* The configuration entry that will result from the requested
* update.
* @param unacceptableReason
* A buffer to which this method can append a human-readable
* message explaining why the proposed change is not acceptable.
* @return {@code true} if the proposed entry contains an acceptable
* configuration, or {@code false} if it does not.
*/
public boolean configChangeIsAcceptable(Entry configEntry, LocalizableMessageBuilder unacceptableReason);
/**
* Attempts to apply a new configuration to this Directory Server component
* based on the provided changed entry.
*
* @param configEntry
* The configuration entry that containing the updated
* configuration for this component.
* @return Information about the result of processing the configuration
* change.
*/
}