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.PasswordPolicyImportPluginCfg;
037
038
039
040 /**
041 * A client-side interface for reading and modifying Password Policy
042 * Import Plugin settings.
043 * <p>
044 * The Password Policy Import Plugin ensures that clear-text passwords
045 * contained in LDIF entries are properly encoded before they are
046 * stored in the appropriate Directory Server backend.
047 */
048 public interface PasswordPolicyImportPluginCfgClient extends PluginCfgClient {
049
050 /**
051 * Get the configuration definition associated with this Password Policy Import Plugin.
052 *
053 * @return Returns the configuration definition associated with this Password Policy Import Plugin.
054 */
055 ManagedObjectDefinition<? extends PasswordPolicyImportPluginCfgClient, ? extends PasswordPolicyImportPluginCfg> definition();
056
057
058
059 /**
060 * Gets the "default-auth-password-storage-scheme" property.
061 * <p>
062 * Specifies the names of password storage schemes that to be used
063 * for encoding passwords contained in attributes with the auth
064 * password syntax for entries that do not include the
065 * ds-pwp-password-policy-dn attribute specifying which password
066 * policy should be used to govern them.
067 *
068 * @return Returns the values of the "default-auth-password-storage-scheme" property.
069 */
070 SortedSet<String> getDefaultAuthPasswordStorageScheme();
071
072
073
074 /**
075 * Sets the "default-auth-password-storage-scheme" property.
076 * <p>
077 * Specifies the names of password storage schemes that to be used
078 * for encoding passwords contained in attributes with the auth
079 * password syntax for entries that do not include the
080 * ds-pwp-password-policy-dn attribute specifying which password
081 * policy should be used to govern them.
082 *
083 * @param values The values of the "default-auth-password-storage-scheme" property.
084 * @throws IllegalPropertyValueException
085 * If one or more of the new values are invalid.
086 */
087 void setDefaultAuthPasswordStorageScheme(Collection<String> values) throws IllegalPropertyValueException;
088
089
090
091 /**
092 * Gets the "default-user-password-storage-scheme" property.
093 * <p>
094 * Specifies the names of the password storage schemes to be used
095 * for encoding passwords contained in attributes with the user
096 * password syntax for entries that do not include the
097 * ds-pwp-password-policy-dn attribute specifying which password
098 * policy is to be used to govern them.
099 *
100 * @return Returns the values of the "default-user-password-storage-scheme" property.
101 */
102 SortedSet<String> getDefaultUserPasswordStorageScheme();
103
104
105
106 /**
107 * Sets the "default-user-password-storage-scheme" property.
108 * <p>
109 * Specifies the names of the password storage schemes to be used
110 * for encoding passwords contained in attributes with the user
111 * password syntax for entries that do not include the
112 * ds-pwp-password-policy-dn attribute specifying which password
113 * policy is to be used to govern them.
114 *
115 * @param values The values of the "default-user-password-storage-scheme" property.
116 * @throws IllegalPropertyValueException
117 * If one or more of the new values are invalid.
118 */
119 void setDefaultUserPasswordStorageScheme(Collection<String> values) throws IllegalPropertyValueException;
120
121
122
123 /**
124 * Gets the "invoke-for-internal-operations" property.
125 * <p>
126 * Indicates whether the plug-in should be invoked for internal
127 * operations.
128 * <p>
129 * Any plug-in that can be invoked for internal operations must
130 * ensure that it does not create any new internal operatons that can
131 * cause the same plug-in to be re-invoked.
132 *
133 * @return Returns the value of the "invoke-for-internal-operations" property.
134 */
135 boolean isInvokeForInternalOperations();
136
137
138
139 /**
140 * Sets the "invoke-for-internal-operations" property.
141 * <p>
142 * Indicates whether the plug-in should be invoked for internal
143 * operations.
144 * <p>
145 * Any plug-in that can be invoked for internal operations must
146 * ensure that it does not create any new internal operatons that can
147 * cause the same plug-in to be re-invoked.
148 *
149 * @param value The value of the "invoke-for-internal-operations" property.
150 * @throws IllegalPropertyValueException
151 * If the new value is invalid.
152 */
153 void setInvokeForInternalOperations(Boolean value) throws IllegalPropertyValueException;
154
155
156
157 /**
158 * Gets the "java-class" property.
159 * <p>
160 * Specifies the fully-qualified name of the Java class that
161 * provides the plug-in implementation.
162 *
163 * @return Returns the value of the "java-class" property.
164 */
165 String getJavaClass();
166
167
168
169 /**
170 * Sets the "java-class" property.
171 * <p>
172 * Specifies the fully-qualified name of the Java class that
173 * provides the plug-in implementation.
174 *
175 * @param value The value of the "java-class" property.
176 * @throws IllegalPropertyValueException
177 * If the new value is invalid.
178 */
179 void setJavaClass(String value) throws IllegalPropertyValueException;
180
181
182
183 /**
184 * Gets the "plugin-type" property.
185 * <p>
186 * Specifies the set of plug-in types for the plug-in, which
187 * specifies the times at which the plug-in is invoked.
188 *
189 * @return Returns the values of the "plugin-type" property.
190 */
191 SortedSet<PluginType> getPluginType();
192
193
194
195 /**
196 * Sets the "plugin-type" property.
197 * <p>
198 * Specifies the set of plug-in types for the plug-in, which
199 * specifies the times at which the plug-in is invoked.
200 *
201 * @param values The values of the "plugin-type" property.
202 * @throws IllegalPropertyValueException
203 * If one or more of the new values are invalid.
204 */
205 void setPluginType(Collection<PluginType> values) throws IllegalPropertyValueException;
206
207 }