001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.api;
028    
029    
030    
031    import org.opends.server.config.ConfigEntry;
032    import org.opends.server.types.ConfigChangeResult;
033    import org.opends.messages.MessageBuilder;
034    
035    
036    /**
037     * This interface defines the methods that a Directory Server
038     * component should implement if it wishes to be able to receive
039     * notification of new entries added below a configuration entry.
040     */
041    @org.opends.server.types.PublicAPI(
042         stability=org.opends.server.types.StabilityLevel.VOLATILE,
043         mayInstantiate=false,
044         mayExtend=true,
045         mayInvoke=false)
046    public interface ConfigAddListener
047    {
048      /**
049       * Indicates whether the configuration entry that will result from a
050       * proposed add is acceptable to this add listener.
051       *
052       * @param  configEntry         The configuration entry that will
053       *                             result from the requested add.
054       * @param  unacceptableReason  A buffer to which this method can
055       *                             append a human-readable message
056       *                             explaining why the proposed entry is
057       *                             not acceptable.
058       *
059       * @return  {@code true} if the proposed entry contains an
060       *          acceptable configuration, or {@code false} if it does
061       *          not.
062       */
063      public boolean configAddIsAcceptable(ConfigEntry configEntry,
064                          MessageBuilder unacceptableReason);
065    
066    
067    
068      /**
069       * Attempts to apply a new configuration based on the provided added
070       * entry.
071       *
072       * @param  configEntry  The new configuration entry that contains
073       *                      the configuration to apply.
074       *
075       * @return  Information about the result of processing the
076       *          configuration change.
077       */
078      public ConfigChangeResult applyConfigurationAdd(
079                                     ConfigEntry configEntry);
080    }
081