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