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.std.server; 028 029 030 031 import org.opends.server.admin.Configuration; 032 import org.opends.server.admin.server.ConfigurationChangeListener; 033 034 035 036 /** 037 * A server-side interface for querying SASL Mechanism Handler 038 * settings. 039 * <p> 040 * The SASL mechanism handler configuration entry is the parent for 041 * all SASL mechanism handlers defined in the OpenDS Directory Server. 042 */ 043 public interface SASLMechanismHandlerCfg extends Configuration { 044 045 /** 046 * Gets the configuration class associated with this SASL Mechanism Handler. 047 * 048 * @return Returns the configuration class associated with this SASL Mechanism Handler. 049 */ 050 Class<? extends SASLMechanismHandlerCfg> configurationClass(); 051 052 053 054 /** 055 * Register to be notified when this SASL Mechanism Handler is changed. 056 * 057 * @param listener 058 * The SASL Mechanism Handler configuration change listener. 059 */ 060 void addChangeListener(ConfigurationChangeListener<SASLMechanismHandlerCfg> listener); 061 062 063 064 /** 065 * Deregister an existing SASL Mechanism Handler configuration change listener. 066 * 067 * @param listener 068 * The SASL Mechanism Handler configuration change listener. 069 */ 070 void removeChangeListener(ConfigurationChangeListener<SASLMechanismHandlerCfg> listener); 071 072 073 074 /** 075 * Gets the "enabled" property. 076 * <p> 077 * Indicates whether the SASL mechanism handler is enabled for use. 078 * 079 * @return Returns the value of the "enabled" property. 080 */ 081 boolean isEnabled(); 082 083 084 085 /** 086 * Gets the "java-class" property. 087 * <p> 088 * Specifies the fully-qualified name of the Java class that 089 * provides the SASL mechanism handler implementation. 090 * 091 * @return Returns the value of the "java-class" property. 092 */ 093 String getJavaClass(); 094 095 }