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