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.client;
028    
029    
030    
031    import java.util.Collection;
032    import java.util.SortedSet;
033    import org.opends.server.admin.IllegalPropertyValueException;
034    import org.opends.server.admin.ManagedObjectDefinition;
035    import org.opends.server.admin.std.meta.PluginCfgDefn.PluginType;
036    import org.opends.server.admin.std.server.LDAPAttributeDescriptionListPluginCfg;
037    
038    
039    
040    /**
041     * A client-side interface for reading and modifying LDAP Attribute
042     * Description List Plugin settings.
043     * <p>
044     * The LDAP Attribute Description List Plugin provides the ability for
045     * clients to include an attribute list in a search request that names
046     * object classes instead of (or in addition to) attributes.
047     */
048    public interface LDAPAttributeDescriptionListPluginCfgClient extends PluginCfgClient {
049    
050      /**
051       * Get the configuration definition associated with this LDAP Attribute Description List Plugin.
052       *
053       * @return Returns the configuration definition associated with this LDAP Attribute Description List Plugin.
054       */
055      ManagedObjectDefinition<? extends LDAPAttributeDescriptionListPluginCfgClient, ? extends LDAPAttributeDescriptionListPluginCfg> definition();
056    
057    
058    
059      /**
060       * Gets the "java-class" property.
061       * <p>
062       * Specifies the fully-qualified name of the Java class that
063       * provides the plug-in implementation.
064       *
065       * @return Returns the value of the "java-class" property.
066       */
067      String getJavaClass();
068    
069    
070    
071      /**
072       * Sets the "java-class" property.
073       * <p>
074       * Specifies the fully-qualified name of the Java class that
075       * provides the plug-in implementation.
076       *
077       * @param value The value of the "java-class" property.
078       * @throws IllegalPropertyValueException
079       *           If the new value is invalid.
080       */
081      void setJavaClass(String value) throws IllegalPropertyValueException;
082    
083    
084    
085      /**
086       * Gets the "plugin-type" property.
087       * <p>
088       * Specifies the set of plug-in types for the plug-in, which
089       * specifies the times at which the plug-in is invoked.
090       *
091       * @return Returns the values of the "plugin-type" property.
092       */
093      SortedSet<PluginType> getPluginType();
094    
095    
096    
097      /**
098       * Sets the "plugin-type" property.
099       * <p>
100       * Specifies the set of plug-in types for the plug-in, which
101       * specifies the times at which the plug-in is invoked.
102       *
103       * @param values The values of the "plugin-type" property.
104       * @throws IllegalPropertyValueException
105       *           If one or more of the new values are invalid.
106       */
107      void setPluginType(Collection<PluginType> values) throws IllegalPropertyValueException;
108    
109    }