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 its associated configuration is 043 * changed. 044 * 045 * @param <T> 046 * The type of configuration that this listener should be 047 * notified about. 048 */ 049 public interface ConfigurationChangeListener<T extends Configuration> { 050 051 /** 052 * Indicates whether the proposed change to the configuration is 053 * acceptable to this change listener. 054 * 055 * @param configuration 056 * The new configuration containing the changes. 057 * @param unacceptableReasons 058 * A list that can be used to hold messages about why the 059 * provided configuration is not acceptable. 060 * @return Returns <code>true</code> if the proposed change is 061 * acceptable, or <code>false</code> if it is not. 062 */ 063 public boolean isConfigurationChangeAcceptable(T configuration, 064 List<Message> unacceptableReasons); 065 066 067 068 /** 069 * Applies the configuration changes to this change listener. 070 * 071 * @param configuration 072 * The new configuration containing the changes. 073 * @return Returns information about the result of changing the 074 * configuration. 075 */ 076 public ConfigChangeResult applyConfigurationChange(T configuration); 077 }