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