001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2008 Sun Microsystems, Inc. 015 */ 016package org.forgerock.opendj.server.config.client; 017 018 019 020import org.forgerock.opendj.config.ConfigurationClient; 021import org.forgerock.opendj.config.ManagedObjectDefinition; 022import org.forgerock.opendj.config.PropertyException; 023import org.forgerock.opendj.server.config.server.PasswordStorageSchemeCfg; 024 025 026 027/** 028 * A client-side interface for reading and modifying Password Storage 029 * Scheme settings. 030 * <p> 031 * Password Storage Schemes encode new passwords provided by users so 032 * that they are stored in an encoded manner. This makes it difficult 033 * or impossible for someone to determine the clear-text passwords from 034 * the encoded values. 035 */ 036public interface PasswordStorageSchemeCfgClient extends ConfigurationClient { 037 038 /** 039 * Get the configuration definition associated with this Password Storage Scheme. 040 * 041 * @return Returns the configuration definition associated with this Password Storage Scheme. 042 */ 043 ManagedObjectDefinition<? extends PasswordStorageSchemeCfgClient, ? extends PasswordStorageSchemeCfg> definition(); 044 045 046 047 /** 048 * Gets the "enabled" property. 049 * <p> 050 * Indicates whether the Password Storage Scheme is enabled for use. 051 * 052 * @return Returns the value of the "enabled" property. 053 */ 054 Boolean isEnabled(); 055 056 057 058 /** 059 * Sets the "enabled" property. 060 * <p> 061 * Indicates whether the Password Storage Scheme is enabled for use. 062 * 063 * @param value The value of the "enabled" property. 064 * @throws PropertyException 065 * If the new value is invalid. 066 */ 067 void setEnabled(boolean value) throws PropertyException; 068 069 070 071 /** 072 * Gets the "java-class" property. 073 * <p> 074 * Specifies the fully-qualified name of the Java class that 075 * provides the Password Storage Scheme implementation. 076 * 077 * @return Returns the value of the "java-class" property. 078 */ 079 String getJavaClass(); 080 081 082 083 /** 084 * Sets the "java-class" property. 085 * <p> 086 * Specifies the fully-qualified name of the Java class that 087 * provides the Password Storage Scheme implementation. 088 * 089 * @param value The value of the "java-class" property. 090 * @throws PropertyException 091 * If the new value is invalid. 092 */ 093 void setJavaClass(String value) throws PropertyException; 094 095}