001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.server;
017
018
019
020import java.util.SortedSet;
021import org.forgerock.opendj.config.server.ConfigurationChangeListener;
022import org.forgerock.opendj.server.config.meta.PluginCfgDefn.PluginType;
023
024
025
026/**
027 * A server-side interface for querying LDAP Attribute Description
028 * List Plugin settings.
029 * <p>
030 * The LDAP Attribute Description List Plugin provides the ability for
031 * clients to include an attribute list in a search request that names
032 * object classes instead of (or in addition to) attributes.
033 */
034public interface LDAPAttributeDescriptionListPluginCfg extends PluginCfg {
035
036  /**
037   * Gets the configuration class associated with this LDAP Attribute Description List Plugin.
038   *
039   * @return Returns the configuration class associated with this LDAP Attribute Description List Plugin.
040   */
041  Class<? extends LDAPAttributeDescriptionListPluginCfg> configurationClass();
042
043
044
045  /**
046   * Register to be notified when this LDAP Attribute Description List Plugin is changed.
047   *
048   * @param listener
049   *          The LDAP Attribute Description List Plugin configuration change listener.
050   */
051  void addLDAPAttributeDescriptionListChangeListener(ConfigurationChangeListener<LDAPAttributeDescriptionListPluginCfg> listener);
052
053
054
055  /**
056   * Deregister an existing LDAP Attribute Description List Plugin configuration change listener.
057   *
058   * @param listener
059   *          The LDAP Attribute Description List Plugin configuration change listener.
060   */
061  void removeLDAPAttributeDescriptionListChangeListener(ConfigurationChangeListener<LDAPAttributeDescriptionListPluginCfg> listener);
062
063
064
065  /**
066   * Gets the "java-class" property.
067   * <p>
068   * Specifies the fully-qualified name of the Java class that
069   * provides the plug-in implementation.
070   *
071   * @return Returns the value of the "java-class" property.
072   */
073  String getJavaClass();
074
075
076
077  /**
078   * Gets the "plugin-type" property.
079   * <p>
080   * Specifies the set of plug-in types for the plug-in, which
081   * specifies the times at which the plug-in is invoked.
082   *
083   * @return Returns an unmodifiable set containing the values of the "plugin-type" property.
084   */
085  SortedSet<PluginType> getPluginType();
086
087}