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.ldap.DN;
025import org.forgerock.opendj.ldap.schema.AttributeType;
026import org.forgerock.opendj.server.config.meta.PluginCfgDefn.PluginType;
027import org.forgerock.opendj.server.config.server.UniqueAttributePluginCfg;
028
029
030
031/**
032 * A client-side interface for reading and modifying Unique Attribute
033 * Plugin settings.
034 * <p>
035 * The Unique Attribute Plugin enforces constraints on the value of an
036 * attribute within a portion of the directory.
037 */
038public interface UniqueAttributePluginCfgClient extends PluginCfgClient {
039
040  /**
041   * Get the configuration definition associated with this Unique Attribute Plugin.
042   *
043   * @return Returns the configuration definition associated with this Unique Attribute Plugin.
044   */
045  ManagedObjectDefinition<? extends UniqueAttributePluginCfgClient, ? extends UniqueAttributePluginCfg> definition();
046
047
048
049  /**
050   * Gets the "base-dn" property.
051   * <p>
052   * Specifies a base DN within which the attribute must be unique.
053   *
054   * @return Returns the values of the "base-dn" property.
055   */
056  SortedSet<DN> getBaseDN();
057
058
059
060  /**
061   * Sets the "base-dn" property.
062   * <p>
063   * Specifies a base DN within which the attribute must be unique.
064   *
065   * @param values The values of the "base-dn" property.
066   * @throws PropertyException
067   *           If one or more of the new values are invalid.
068   */
069  void setBaseDN(Collection<DN> values) throws PropertyException;
070
071
072
073  /**
074   * Gets the "java-class" property.
075   * <p>
076   * Specifies the fully-qualified name of the Java class that
077   * provides the plug-in implementation.
078   *
079   * @return Returns the value of the "java-class" property.
080   */
081  String getJavaClass();
082
083
084
085  /**
086   * Sets the "java-class" property.
087   * <p>
088   * Specifies the fully-qualified name of the Java class that
089   * provides the plug-in implementation.
090   *
091   * @param value The value of the "java-class" property.
092   * @throws PropertyException
093   *           If the new value is invalid.
094   */
095  void setJavaClass(String value) throws PropertyException;
096
097
098
099  /**
100   * Gets the "plugin-type" property.
101   * <p>
102   * Specifies the set of plug-in types for the plug-in, which
103   * specifies the times at which the plug-in is invoked.
104   *
105   * @return Returns the values of the "plugin-type" property.
106   */
107  SortedSet<PluginType> getPluginType();
108
109
110
111  /**
112   * Sets the "plugin-type" property.
113   * <p>
114   * Specifies the set of plug-in types for the plug-in, which
115   * specifies the times at which the plug-in is invoked.
116   *
117   * @param values The values of the "plugin-type" property.
118   * @throws PropertyException
119   *           If one or more of the new values are invalid.
120   */
121  void setPluginType(Collection<PluginType> values) throws PropertyException;
122
123
124
125  /**
126   * Gets the "type" property.
127   * <p>
128   * Specifies the type of attributes to check for value uniqueness.
129   *
130   * @return Returns the values of the "type" property.
131   */
132  SortedSet<AttributeType> getType();
133
134
135
136  /**
137   * Sets the "type" property.
138   * <p>
139   * Specifies the type of attributes to check for value uniqueness.
140   *
141   * @param values The values of the "type" property.
142   * @throws PropertyException
143   *           If one or more of the new values are invalid.
144   */
145  void setType(Collection<AttributeType> values) throws PropertyException;
146
147}