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.server; 028 029 030 031 import java.util.SortedSet; 032 import org.opends.server.admin.server.ConfigurationChangeListener; 033 import org.opends.server.admin.std.meta.PluginCfgDefn.PluginType; 034 import org.opends.server.types.DN; 035 036 037 038 /** 039 * A server-side interface for querying Password Policy Import Plugin 040 * settings. 041 * <p> 042 * The Password Policy Import Plugin ensures that clear-text passwords 043 * contained in LDIF entries are properly encoded before they are 044 * stored in the appropriate Directory Server backend. 045 */ 046 public interface PasswordPolicyImportPluginCfg extends PluginCfg { 047 048 /** 049 * Gets the configuration class associated with this Password Policy Import Plugin. 050 * 051 * @return Returns the configuration class associated with this Password Policy Import Plugin. 052 */ 053 Class<? extends PasswordPolicyImportPluginCfg> configurationClass(); 054 055 056 057 /** 058 * Register to be notified when this Password Policy Import Plugin is changed. 059 * 060 * @param listener 061 * The Password Policy Import Plugin configuration change listener. 062 */ 063 void addPasswordPolicyImportChangeListener(ConfigurationChangeListener<PasswordPolicyImportPluginCfg> listener); 064 065 066 067 /** 068 * Deregister an existing Password Policy Import Plugin configuration change listener. 069 * 070 * @param listener 071 * The Password Policy Import Plugin configuration change listener. 072 */ 073 void removePasswordPolicyImportChangeListener(ConfigurationChangeListener<PasswordPolicyImportPluginCfg> listener); 074 075 076 077 /** 078 * Gets the "default-auth-password-storage-scheme" property. 079 * <p> 080 * Specifies the names of password storage schemes that to be used 081 * for encoding passwords contained in attributes with the auth 082 * password syntax for entries that do not include the 083 * ds-pwp-password-policy-dn attribute specifying which password 084 * policy should be used to govern them. 085 * 086 * @return Returns an unmodifiable set containing the values of the "default-auth-password-storage-scheme" property. 087 */ 088 SortedSet<String> getDefaultAuthPasswordStorageScheme(); 089 090 091 092 /** 093 * Gets the "default-auth-password-storage-scheme" property as a set 094 * of DNs. 095 * <p> 096 * Specifies the names of password storage schemes that to be used 097 * for encoding passwords contained in attributes with the auth 098 * password syntax for entries that do not include the 099 * ds-pwp-password-policy-dn attribute specifying which password 100 * policy should be used to govern them. 101 * 102 * @return Returns the DN values of the 103 * "default-auth-password-storage-scheme" property. 104 */ 105 SortedSet<DN> getDefaultAuthPasswordStorageSchemeDNs(); 106 107 108 109 /** 110 * Gets the "default-user-password-storage-scheme" property. 111 * <p> 112 * Specifies the names of the password storage schemes to be used 113 * for encoding passwords contained in attributes with the user 114 * password syntax for entries that do not include the 115 * ds-pwp-password-policy-dn attribute specifying which password 116 * policy is to be used to govern them. 117 * 118 * @return Returns an unmodifiable set containing the values of the "default-user-password-storage-scheme" property. 119 */ 120 SortedSet<String> getDefaultUserPasswordStorageScheme(); 121 122 123 124 /** 125 * Gets the "default-user-password-storage-scheme" property as a set 126 * of DNs. 127 * <p> 128 * Specifies the names of the password storage schemes to be used 129 * for encoding passwords contained in attributes with the user 130 * password syntax for entries that do not include the 131 * ds-pwp-password-policy-dn attribute specifying which password 132 * policy is to be used to govern them. 133 * 134 * @return Returns the DN values of the 135 * "default-user-password-storage-scheme" property. 136 */ 137 SortedSet<DN> getDefaultUserPasswordStorageSchemeDNs(); 138 139 140 141 /** 142 * Gets the "invoke-for-internal-operations" property. 143 * <p> 144 * Indicates whether the plug-in should be invoked for internal 145 * operations. 146 * <p> 147 * Any plug-in that can be invoked for internal operations must 148 * ensure that it does not create any new internal operatons that can 149 * cause the same plug-in to be re-invoked. 150 * 151 * @return Returns the value of the "invoke-for-internal-operations" property. 152 */ 153 boolean isInvokeForInternalOperations(); 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 * Gets the "plugin-type" property. 171 * <p> 172 * Specifies the set of plug-in types for the plug-in, which 173 * specifies the times at which the plug-in is invoked. 174 * 175 * @return Returns an unmodifiable set containing the values of the "plugin-type" property. 176 */ 177 SortedSet<PluginType> getPluginType(); 178 179 }