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