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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.client;
027
028
029
030import java.util.Collection;
031import java.util.SortedSet;
032import org.opends.server.admin.ManagedObjectDefinition;
033import org.opends.server.admin.PropertyException;
034import org.opends.server.admin.std.meta.PluginCfgDefn.PluginType;
035import org.opends.server.admin.std.meta.SambaPasswordPluginCfgDefn.PwdSyncPolicy;
036import org.opends.server.admin.std.server.SambaPasswordPluginCfg;
037import org.opends.server.types.DN;
038
039
040
041/**
042 * A client-side interface for reading and modifying Samba Password
043 * Plugin settings.
044 * <p>
045 * Samba Password Synchronization Plugin.
046 */
047public interface SambaPasswordPluginCfgClient extends PluginCfgClient {
048
049  /**
050   * Get the configuration definition associated with this Samba Password Plugin.
051   *
052   * @return Returns the configuration definition associated with this Samba Password Plugin.
053   */
054  ManagedObjectDefinition<? extends SambaPasswordPluginCfgClient, ? extends SambaPasswordPluginCfg> definition();
055
056
057
058  /**
059   * Gets the "java-class" property.
060   * <p>
061   * Specifies the fully-qualified name of the Java class that
062   * provides the plug-in implementation.
063   *
064   * @return Returns the value of the "java-class" property.
065   */
066  String getJavaClass();
067
068
069
070  /**
071   * Sets the "java-class" property.
072   * <p>
073   * Specifies the fully-qualified name of the Java class that
074   * provides the plug-in implementation.
075   *
076   * @param value The value of the "java-class" property.
077   * @throws PropertyException
078   *           If the new value is invalid.
079   */
080  void setJavaClass(String value) throws PropertyException;
081
082
083
084  /**
085   * Gets the "plugin-type" property.
086   * <p>
087   * Specifies the set of plug-in types for the plug-in, which
088   * specifies the times at which the plug-in is invoked.
089   *
090   * @return Returns the values of the "plugin-type" property.
091   */
092  SortedSet<PluginType> getPluginType();
093
094
095
096  /**
097   * Sets the "plugin-type" property.
098   * <p>
099   * Specifies the set of plug-in types for the plug-in, which
100   * specifies the times at which the plug-in is invoked.
101   *
102   * @param values The values of the "plugin-type" property.
103   * @throws PropertyException
104   *           If one or more of the new values are invalid.
105   */
106  void setPluginType(Collection<PluginType> values) throws PropertyException;
107
108
109
110  /**
111   * Gets the "pwd-sync-policy" property.
112   * <p>
113   * Specifies which Samba passwords should be kept synchronized.
114   *
115   * @return Returns the values of the "pwd-sync-policy" property.
116   */
117  SortedSet<PwdSyncPolicy> getPwdSyncPolicy();
118
119
120
121  /**
122   * Sets the "pwd-sync-policy" property.
123   * <p>
124   * Specifies which Samba passwords should be kept synchronized.
125   *
126   * @param values The values of the "pwd-sync-policy" property.
127   * @throws PropertyException
128   *           If one or more of the new values are invalid.
129   */
130  void setPwdSyncPolicy(Collection<PwdSyncPolicy> values) throws PropertyException;
131
132
133
134  /**
135   * Gets the "samba-administrator-dn" property.
136   * <p>
137   * Specifies the distinguished name of the user which Samba uses to
138   * perform Password Modify extended operations against this directory
139   * server in order to synchronize the userPassword attribute after
140   * the LanMan or NT passwords have been updated.
141   * <p>
142   * The user must have the 'password-reset' privilege and should not
143   * be a root user. This user name can be used in order to identify
144   * Samba connections and avoid double re-synchronization of the same
145   * password. If this property is left undefined, then no password
146   * updates will be skipped.
147   *
148   * @return Returns the value of the "samba-administrator-dn" property.
149   */
150  DN getSambaAdministratorDN();
151
152
153
154  /**
155   * Sets the "samba-administrator-dn" property.
156   * <p>
157   * Specifies the distinguished name of the user which Samba uses to
158   * perform Password Modify extended operations against this directory
159   * server in order to synchronize the userPassword attribute after
160   * the LanMan or NT passwords have been updated.
161   * <p>
162   * The user must have the 'password-reset' privilege and should not
163   * be a root user. This user name can be used in order to identify
164   * Samba connections and avoid double re-synchronization of the same
165   * password. If this property is left undefined, then no password
166   * updates will be skipped.
167   *
168   * @param value The value of the "samba-administrator-dn" property.
169   * @throws PropertyException
170   *           If the new value is invalid.
171   */
172  void setSambaAdministratorDN(DN value) throws PropertyException;
173
174}