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.meta; 027 028 029 030import org.opends.server.admin.AdministratorAction; 031import org.opends.server.admin.BooleanPropertyDefinition; 032import org.opends.server.admin.ClassPropertyDefinition; 033import org.opends.server.admin.client.AuthorizationException; 034import org.opends.server.admin.client.CommunicationException; 035import org.opends.server.admin.client.ConcurrentModificationException; 036import org.opends.server.admin.client.ManagedObject; 037import org.opends.server.admin.client.MissingMandatoryPropertiesException; 038import org.opends.server.admin.client.OperationRejectedException; 039import org.opends.server.admin.DefaultBehaviorProvider; 040import org.opends.server.admin.DefinedDefaultBehaviorProvider; 041import org.opends.server.admin.ManagedObjectAlreadyExistsException; 042import org.opends.server.admin.ManagedObjectDefinition; 043import org.opends.server.admin.PropertyOption; 044import org.opends.server.admin.PropertyProvider; 045import org.opends.server.admin.server.ConfigurationChangeListener; 046import org.opends.server.admin.server.ServerManagedObject; 047import org.opends.server.admin.std.client.SHA1PasswordStorageSchemeCfgClient; 048import org.opends.server.admin.std.server.PasswordStorageSchemeCfg; 049import org.opends.server.admin.std.server.SHA1PasswordStorageSchemeCfg; 050import org.opends.server.admin.Tag; 051import org.opends.server.types.DN; 052 053 054 055/** 056 * An interface for querying the SHA1 Password Storage Scheme managed 057 * object definition meta information. 058 * <p> 059 * The SHA1 Password Storage Scheme provides a mechanism for encoding 060 * user passwords using an unsalted form of the SHA-1 message digest 061 * algorithm. Because the implementation does not use any kind of 062 * salting mechanism, a given password always has the same encoded 063 * form. 064 */ 065public final class SHA1PasswordStorageSchemeCfgDefn extends ManagedObjectDefinition<SHA1PasswordStorageSchemeCfgClient, SHA1PasswordStorageSchemeCfg> { 066 067 // The singleton configuration definition instance. 068 private static final SHA1PasswordStorageSchemeCfgDefn INSTANCE = new SHA1PasswordStorageSchemeCfgDefn(); 069 070 071 072 // The "java-class" property definition. 073 private static final ClassPropertyDefinition PD_JAVA_CLASS; 074 075 076 077 // Build the "java-class" property definition. 078 static { 079 ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class"); 080 builder.setOption(PropertyOption.MANDATORY); 081 builder.setOption(PropertyOption.ADVANCED); 082 builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "java-class")); 083 DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.extensions.SHA1PasswordStorageScheme"); 084 builder.setDefaultBehaviorProvider(provider); 085 builder.addInstanceOf("org.opends.server.api.PasswordStorageScheme"); 086 PD_JAVA_CLASS = builder.getInstance(); 087 INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS); 088 } 089 090 091 092 // Register the tags associated with this managed object definition. 093 static { 094 INSTANCE.registerTag(Tag.valueOf("user-management")); 095 } 096 097 098 099 /** 100 * Get the SHA1 Password Storage Scheme configuration definition 101 * singleton. 102 * 103 * @return Returns the SHA1 Password Storage Scheme configuration 104 * definition singleton. 105 */ 106 public static SHA1PasswordStorageSchemeCfgDefn getInstance() { 107 return INSTANCE; 108 } 109 110 111 112 /** 113 * Private constructor. 114 */ 115 private SHA1PasswordStorageSchemeCfgDefn() { 116 super("sha1-password-storage-scheme", PasswordStorageSchemeCfgDefn.getInstance()); 117 } 118 119 120 121 /** 122 * {@inheritDoc} 123 */ 124 public SHA1PasswordStorageSchemeCfgClient createClientConfiguration( 125 ManagedObject<? extends SHA1PasswordStorageSchemeCfgClient> impl) { 126 return new SHA1PasswordStorageSchemeCfgClientImpl(impl); 127 } 128 129 130 131 /** 132 * {@inheritDoc} 133 */ 134 public SHA1PasswordStorageSchemeCfg createServerConfiguration( 135 ServerManagedObject<? extends SHA1PasswordStorageSchemeCfg> impl) { 136 return new SHA1PasswordStorageSchemeCfgServerImpl(impl); 137 } 138 139 140 141 /** 142 * {@inheritDoc} 143 */ 144 public Class<SHA1PasswordStorageSchemeCfg> getServerConfigurationClass() { 145 return SHA1PasswordStorageSchemeCfg.class; 146 } 147 148 149 150 /** 151 * Get the "enabled" property definition. 152 * <p> 153 * Indicates whether the SHA1 Password Storage Scheme is enabled for 154 * use. 155 * 156 * @return Returns the "enabled" property definition. 157 */ 158 public BooleanPropertyDefinition getEnabledPropertyDefinition() { 159 return PasswordStorageSchemeCfgDefn.getInstance().getEnabledPropertyDefinition(); 160 } 161 162 163 164 /** 165 * Get the "java-class" property definition. 166 * <p> 167 * Specifies the fully-qualified name of the Java class that 168 * provides the SHA1 Password Storage Scheme implementation. 169 * 170 * @return Returns the "java-class" property definition. 171 */ 172 public ClassPropertyDefinition getJavaClassPropertyDefinition() { 173 return PD_JAVA_CLASS; 174 } 175 176 177 178 /** 179 * Managed object client implementation. 180 */ 181 private static class SHA1PasswordStorageSchemeCfgClientImpl implements 182 SHA1PasswordStorageSchemeCfgClient { 183 184 // Private implementation. 185 private ManagedObject<? extends SHA1PasswordStorageSchemeCfgClient> impl; 186 187 188 189 // Private constructor. 190 private SHA1PasswordStorageSchemeCfgClientImpl( 191 ManagedObject<? extends SHA1PasswordStorageSchemeCfgClient> impl) { 192 this.impl = impl; 193 } 194 195 196 197 /** 198 * {@inheritDoc} 199 */ 200 public Boolean isEnabled() { 201 return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition()); 202 } 203 204 205 206 /** 207 * {@inheritDoc} 208 */ 209 public void setEnabled(boolean value) { 210 impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value); 211 } 212 213 214 215 /** 216 * {@inheritDoc} 217 */ 218 public String getJavaClass() { 219 return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 220 } 221 222 223 224 /** 225 * {@inheritDoc} 226 */ 227 public void setJavaClass(String value) { 228 impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value); 229 } 230 231 232 233 /** 234 * {@inheritDoc} 235 */ 236 public ManagedObjectDefinition<? extends SHA1PasswordStorageSchemeCfgClient, ? extends SHA1PasswordStorageSchemeCfg> definition() { 237 return INSTANCE; 238 } 239 240 241 242 /** 243 * {@inheritDoc} 244 */ 245 public PropertyProvider properties() { 246 return impl; 247 } 248 249 250 251 /** 252 * {@inheritDoc} 253 */ 254 public void commit() throws ManagedObjectAlreadyExistsException, 255 MissingMandatoryPropertiesException, ConcurrentModificationException, 256 OperationRejectedException, AuthorizationException, 257 CommunicationException { 258 impl.commit(); 259 } 260 261 } 262 263 264 265 /** 266 * Managed object server implementation. 267 */ 268 private static class SHA1PasswordStorageSchemeCfgServerImpl implements 269 SHA1PasswordStorageSchemeCfg { 270 271 // Private implementation. 272 private ServerManagedObject<? extends SHA1PasswordStorageSchemeCfg> impl; 273 274 // The value of the "enabled" property. 275 private final boolean pEnabled; 276 277 // The value of the "java-class" property. 278 private final String pJavaClass; 279 280 281 282 // Private constructor. 283 private SHA1PasswordStorageSchemeCfgServerImpl(ServerManagedObject<? extends SHA1PasswordStorageSchemeCfg> impl) { 284 this.impl = impl; 285 this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition()); 286 this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 287 } 288 289 290 291 /** 292 * {@inheritDoc} 293 */ 294 public void addSHA1ChangeListener( 295 ConfigurationChangeListener<SHA1PasswordStorageSchemeCfg> listener) { 296 impl.registerChangeListener(listener); 297 } 298 299 300 301 /** 302 * {@inheritDoc} 303 */ 304 public void removeSHA1ChangeListener( 305 ConfigurationChangeListener<SHA1PasswordStorageSchemeCfg> listener) { 306 impl.deregisterChangeListener(listener); 307 } 308 /** 309 * {@inheritDoc} 310 */ 311 public void addChangeListener( 312 ConfigurationChangeListener<PasswordStorageSchemeCfg> listener) { 313 impl.registerChangeListener(listener); 314 } 315 316 317 318 /** 319 * {@inheritDoc} 320 */ 321 public void removeChangeListener( 322 ConfigurationChangeListener<PasswordStorageSchemeCfg> listener) { 323 impl.deregisterChangeListener(listener); 324 } 325 326 327 328 /** 329 * {@inheritDoc} 330 */ 331 public boolean isEnabled() { 332 return pEnabled; 333 } 334 335 336 337 /** 338 * {@inheritDoc} 339 */ 340 public String getJavaClass() { 341 return pJavaClass; 342 } 343 344 345 346 /** 347 * {@inheritDoc} 348 */ 349 public Class<? extends SHA1PasswordStorageSchemeCfg> configurationClass() { 350 return SHA1PasswordStorageSchemeCfg.class; 351 } 352 353 354 355 /** 356 * {@inheritDoc} 357 */ 358 public DN dn() { 359 return impl.getDN(); 360 } 361 362 } 363}