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