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.server; 017 018 019 020import java.util.SortedSet; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022import org.forgerock.opendj.ldap.DN; 023import org.forgerock.opendj.server.config.meta.PluginCfgDefn.PluginType; 024import org.forgerock.opendj.server.config.meta.SambaPasswordPluginCfgDefn.PwdSyncPolicy; 025 026 027 028/** 029 * A server-side interface for querying Samba Password Plugin 030 * settings. 031 * <p> 032 * Samba Password Synchronization Plugin. 033 */ 034public interface SambaPasswordPluginCfg extends PluginCfg { 035 036 /** 037 * Gets the configuration class associated with this Samba Password Plugin. 038 * 039 * @return Returns the configuration class associated with this Samba Password Plugin. 040 */ 041 Class<? extends SambaPasswordPluginCfg> configurationClass(); 042 043 044 045 /** 046 * Register to be notified when this Samba Password Plugin is changed. 047 * 048 * @param listener 049 * The Samba Password Plugin configuration change listener. 050 */ 051 void addSambaPasswordChangeListener(ConfigurationChangeListener<SambaPasswordPluginCfg> listener); 052 053 054 055 /** 056 * Deregister an existing Samba Password Plugin configuration change listener. 057 * 058 * @param listener 059 * The Samba Password Plugin configuration change listener. 060 */ 061 void removeSambaPasswordChangeListener(ConfigurationChangeListener<SambaPasswordPluginCfg> listener); 062 063 064 065 /** 066 * Gets the "java-class" property. 067 * <p> 068 * Specifies the fully-qualified name of the Java class that 069 * provides the plug-in implementation. 070 * 071 * @return Returns the value of the "java-class" property. 072 */ 073 String getJavaClass(); 074 075 076 077 /** 078 * Gets the "plugin-type" property. 079 * <p> 080 * Specifies the set of plug-in types for the plug-in, which 081 * specifies the times at which the plug-in is invoked. 082 * 083 * @return Returns an unmodifiable set containing the values of the "plugin-type" property. 084 */ 085 SortedSet<PluginType> getPluginType(); 086 087 088 089 /** 090 * Gets the "pwd-sync-policy" property. 091 * <p> 092 * Specifies which Samba passwords should be kept synchronized. 093 * 094 * @return Returns an unmodifiable set containing the values of the "pwd-sync-policy" property. 095 */ 096 SortedSet<PwdSyncPolicy> getPwdSyncPolicy(); 097 098 099 100 /** 101 * Gets the "samba-administrator-dn" property. 102 * <p> 103 * Specifies the distinguished name of the user which Samba uses to 104 * perform Password Modify extended operations against this directory 105 * server in order to synchronize the userPassword attribute after 106 * the LanMan or NT passwords have been updated. 107 * <p> 108 * The user must have the 'password-reset' privilege and should not 109 * be a root user. This user name can be used in order to identify 110 * Samba connections and avoid double re-synchronization of the same 111 * password. If this property is left undefined, then no password 112 * updates will be skipped. 113 * 114 * @return Returns the value of the "samba-administrator-dn" property. 115 */ 116 DN getSambaAdministratorDN(); 117 118}