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.client; 028 029 030 031 import org.opends.server.admin.ConfigurationClient; 032 import org.opends.server.admin.IllegalPropertyValueException; 033 import org.opends.server.admin.ManagedObjectDefinition; 034 import org.opends.server.admin.std.server.PasswordStorageSchemeCfg; 035 036 037 038 /** 039 * A client-side interface for reading and modifying Password Storage 040 * Scheme settings. 041 * <p> 042 * Password Storage Schemes encode new passwords provided by users so 043 * that they are stored in an encoded manner. This makes it difficult 044 * or impossible for someone to determine the clear-text passwords from 045 * the encoded values. 046 */ 047 public interface PasswordStorageSchemeCfgClient extends ConfigurationClient { 048 049 /** 050 * Get the configuration definition associated with this Password Storage Scheme. 051 * 052 * @return Returns the configuration definition associated with this Password Storage Scheme. 053 */ 054 ManagedObjectDefinition<? extends PasswordStorageSchemeCfgClient, ? extends PasswordStorageSchemeCfg> definition(); 055 056 057 058 /** 059 * Gets the "enabled" property. 060 * <p> 061 * Indicates whether the Password Storage Scheme is enabled for use. 062 * 063 * @return Returns the value of the "enabled" property. 064 */ 065 Boolean isEnabled(); 066 067 068 069 /** 070 * Sets the "enabled" property. 071 * <p> 072 * Indicates whether the Password Storage Scheme is enabled for use. 073 * 074 * @param value The value of the "enabled" property. 075 * @throws IllegalPropertyValueException 076 * If the new value is invalid. 077 */ 078 void setEnabled(boolean value) throws IllegalPropertyValueException; 079 080 081 082 /** 083 * Gets the "java-class" property. 084 * <p> 085 * Specifies the fully-qualified name of the Java class that 086 * provides the Password Storage Scheme implementation. 087 * 088 * @return Returns the value of the "java-class" property. 089 */ 090 String getJavaClass(); 091 092 093 094 /** 095 * Sets the "java-class" property. 096 * <p> 097 * Specifies the fully-qualified name of the Java class that 098 * provides the Password Storage Scheme implementation. 099 * 100 * @param value The value of the "java-class" property. 101 * @throws IllegalPropertyValueException 102 * If the new value is invalid. 103 */ 104 void setJavaClass(String value) throws IllegalPropertyValueException; 105 106 }