/*
 * 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
 * or http://forgerock.org/license/CDDLv1.0.html.
 * 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.
 *      Portions Copyright 2014-2015 ForgeRock AS
 */
package org.opends.server.api;

import org.forgerock.i18n.LocalizableMessageBuilder;
import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.opends.server.config.ConfigEntry;

/**
 * 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.
 */
@org.opends.server.types.PublicAPI(
     stability=org.opends.server.types.StabilityLevel.VOLATILE,
     mayInstantiate=false,
     mayExtend=true,
     mayInvoke=false)
public interface ConfigAddListener
{
  /**
   * Indicates whether the configuration entry that will result from a
   * proposed add is acceptable to this add listener.
   *
   * @param  configEntry         The configuration entry that will
   *                             result from the requested add.
   * @param  unacceptableReason  A buffer to which this method can
   *                             append a human-readable message
   *                             explaining why the proposed entry is
   *                             not acceptable.
   *
   * @return  {@code true} if the proposed entry contains an
   *          acceptable configuration, or {@code false} if it does
   *          not.
   */
  boolean configAddIsAcceptable(ConfigEntry configEntry,
                      LocalizableMessageBuilder unacceptableReason);

  /**
   * Attempts to apply a new configuration based on the provided added
   * entry.
   *
   * @param  configEntry  The new configuration entry that contains
   *                      the configuration to apply.
   *
   * @return  Information about the result of processing the
   *          configuration change.
   */
  ConfigChangeResult applyConfigurationAdd(ConfigEntry configEntry);
}