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 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin.server;
028    
029    
030    
031    import org.opends.messages.Message;
032    
033    import java.util.List;
034    
035    import org.opends.server.admin.Configuration;
036    import org.opends.server.types.ConfigChangeResult;
037    
038    
039    
040    /**
041     * This interface defines the methods that a Directory Server
042     * configurable component should implement if it wishes to be able to
043     * receive notifications when an existing server managed object is
044     * deleted.
045     *
046     * @param <T>
047     *          The type of server managed object that this listener
048     *          should be notified about.
049     */
050    public interface ServerManagedObjectDeleteListener<T extends Configuration> {
051    
052      /**
053       * Indicates whether the proposed deletion of an existing server
054       * managed object is acceptable to this delete listener.
055       *
056       * @param mo
057       *          The server managed object that will be deleted.
058       * @param unacceptableReasons
059       *          A list that can be used to hold messages about why the
060       *          provided server managed object is not acceptable.
061       * @return Returns <code>true</code> if the proposed deletion is
062       *         acceptable, or <code>false</code> if it is not.
063       */
064      public boolean isConfigurationDeleteAcceptable(
065          ServerManagedObject<? extends T> mo, List<Message> unacceptableReasons);
066    
067    
068    
069      /**
070       * Deletes an existing server managed object from this delete
071       * listener.
072       *
073       * @param mo
074       *          The existing server managed object that will be deleted.
075       * @return Returns information about the result of deleting the
076       *         server managed object.
077       */
078      public ConfigChangeResult applyConfigurationDelete(
079          ServerManagedObject<? extends T> mo);
080    }