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.server; 017 018 019 020import org.forgerock.opendj.config.Configuration; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022 023 024 025/** 026 * A server-side interface for querying Password Storage Scheme 027 * settings. 028 * <p> 029 * Password Storage Schemes encode new passwords provided by users so 030 * that they are stored in an encoded manner. This makes it difficult 031 * or impossible for someone to determine the clear-text passwords from 032 * the encoded values. 033 */ 034public interface PasswordStorageSchemeCfg extends Configuration { 035 036 /** 037 * Gets the configuration class associated with this Password Storage Scheme. 038 * 039 * @return Returns the configuration class associated with this Password Storage Scheme. 040 */ 041 Class<? extends PasswordStorageSchemeCfg> configurationClass(); 042 043 044 045 /** 046 * Register to be notified when this Password Storage Scheme is changed. 047 * 048 * @param listener 049 * The Password Storage Scheme configuration change listener. 050 */ 051 void addChangeListener(ConfigurationChangeListener<PasswordStorageSchemeCfg> listener); 052 053 054 055 /** 056 * Deregister an existing Password Storage Scheme configuration change listener. 057 * 058 * @param listener 059 * The Password Storage Scheme configuration change listener. 060 */ 061 void removeChangeListener(ConfigurationChangeListener<PasswordStorageSchemeCfg> listener); 062 063 064 065 /** 066 * Gets the "enabled" property. 067 * <p> 068 * Indicates whether the Password Storage Scheme is enabled for use. 069 * 070 * @return Returns the value of the "enabled" property. 071 */ 072 boolean isEnabled(); 073 074 075 076 /** 077 * Gets the "java-class" property. 078 * <p> 079 * Specifies the fully-qualified name of the Java class that 080 * provides the Password Storage Scheme implementation. 081 * 082 * @return Returns the value of the "java-class" property. 083 */ 084 String getJavaClass(); 085 086}