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 if entries below a configuration entry are removed. 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 ConfigDeleteListener 047 { 048 /** 049 * Indicates whether it is acceptable to remove the provided 050 * configuration entry. 051 * 052 * @param configEntry The configuration entry that will be 053 * removed from the configuration. 054 * @param unacceptableReason A buffer to which this method can 055 * append a human-readable message 056 * explaining why the proposed delete is 057 * not acceptable. 058 * 059 * @return {@code true} if the proposed entry may be removed from 060 * the configuration, or {@code false} if not. 061 */ 062 public boolean configDeleteIsAcceptable(ConfigEntry configEntry, 063 MessageBuilder unacceptableReason); 064 065 066 067 /** 068 * Attempts to apply a new configuration based on the provided 069 * deleted entry. 070 * 071 * @param configEntry The new configuration entry that has been 072 * deleted. 073 * 074 * @return Information about the result of processing the 075 * configuration change. 076 */ 077 public ConfigChangeResult applyConfigurationDelete( 078 ConfigEntry configEntry); 079 } 080