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