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.server.config.meta.PluginCfgDefn.PluginType; 026import org.forgerock.opendj.server.config.meta.SambaPasswordPluginCfgDefn.PwdSyncPolicy; 027import org.forgerock.opendj.server.config.server.SambaPasswordPluginCfg; 028 029 030 031/** 032 * A client-side interface for reading and modifying Samba Password 033 * Plugin settings. 034 * <p> 035 * Samba Password Synchronization Plugin. 036 */ 037public interface SambaPasswordPluginCfgClient extends PluginCfgClient { 038 039 /** 040 * Get the configuration definition associated with this Samba Password Plugin. 041 * 042 * @return Returns the configuration definition associated with this Samba Password Plugin. 043 */ 044 ManagedObjectDefinition<? extends SambaPasswordPluginCfgClient, ? extends SambaPasswordPluginCfg> 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 099 100 /** 101 * Gets the "pwd-sync-policy" property. 102 * <p> 103 * Specifies which Samba passwords should be kept synchronized. 104 * 105 * @return Returns the values of the "pwd-sync-policy" property. 106 */ 107 SortedSet<PwdSyncPolicy> getPwdSyncPolicy(); 108 109 110 111 /** 112 * Sets the "pwd-sync-policy" property. 113 * <p> 114 * Specifies which Samba passwords should be kept synchronized. 115 * 116 * @param values The values of the "pwd-sync-policy" property. 117 * @throws PropertyException 118 * If one or more of the new values are invalid. 119 */ 120 void setPwdSyncPolicy(Collection<PwdSyncPolicy> values) throws PropertyException; 121 122 123 124 /** 125 * Gets the "samba-administrator-dn" property. 126 * <p> 127 * Specifies the distinguished name of the user which Samba uses to 128 * perform Password Modify extended operations against this directory 129 * server in order to synchronize the userPassword attribute after 130 * the LanMan or NT passwords have been updated. 131 * <p> 132 * The user must have the 'password-reset' privilege and should not 133 * be a root user. This user name can be used in order to identify 134 * Samba connections and avoid double re-synchronization of the same 135 * password. If this property is left undefined, then no password 136 * updates will be skipped. 137 * 138 * @return Returns the value of the "samba-administrator-dn" property. 139 */ 140 DN getSambaAdministratorDN(); 141 142 143 144 /** 145 * Sets the "samba-administrator-dn" property. 146 * <p> 147 * Specifies the distinguished name of the user which Samba uses to 148 * perform Password Modify extended operations against this directory 149 * server in order to synchronize the userPassword attribute after 150 * the LanMan or NT passwords have been updated. 151 * <p> 152 * The user must have the 'password-reset' privilege and should not 153 * be a root user. This user name can be used in order to identify 154 * Samba connections and avoid double re-synchronization of the same 155 * password. If this property is left undefined, then no password 156 * updates will be skipped. 157 * 158 * @param value The value of the "samba-administrator-dn" property. 159 * @throws PropertyException 160 * If the new value is invalid. 161 */ 162 void setSambaAdministratorDN(DN value) throws PropertyException; 163 164}