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 java.util.SortedSet; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022 023 024 025/** 026 * A server-side interface for querying Random Password Generator 027 * settings. 028 * <p> 029 * The Random Password Generator creates random passwords based on 030 * fixed-length strings built from one or more character sets. 031 */ 032public interface RandomPasswordGeneratorCfg extends PasswordGeneratorCfg { 033 034 /** 035 * Gets the configuration class associated with this Random Password Generator. 036 * 037 * @return Returns the configuration class associated with this Random Password Generator. 038 */ 039 Class<? extends RandomPasswordGeneratorCfg> configurationClass(); 040 041 042 043 /** 044 * Register to be notified when this Random Password Generator is changed. 045 * 046 * @param listener 047 * The Random Password Generator configuration change listener. 048 */ 049 void addRandomChangeListener(ConfigurationChangeListener<RandomPasswordGeneratorCfg> listener); 050 051 052 053 /** 054 * Deregister an existing Random Password Generator configuration change listener. 055 * 056 * @param listener 057 * The Random Password Generator configuration change listener. 058 */ 059 void removeRandomChangeListener(ConfigurationChangeListener<RandomPasswordGeneratorCfg> listener); 060 061 062 063 /** 064 * Gets the "java-class" property. 065 * <p> 066 * Specifies the fully-qualified name of the Java class that 067 * provides the Random Password Generator implementation. 068 * 069 * @return Returns the value of the "java-class" property. 070 */ 071 String getJavaClass(); 072 073 074 075 /** 076 * Gets the "password-character-set" property. 077 * <p> 078 * Specifies one or more named character sets. 079 * <p> 080 * This is a multi-valued property, with each value defining a 081 * different character set. The format of the character set is the 082 * name of the set followed by a colon and the characters that are in 083 * that set. For example, the value 084 * "alpha:abcdefghijklmnopqrstuvwxyz" defines a character set named 085 * "alpha" containing all of the lower-case ASCII alphabetic 086 * characters. 087 * 088 * @return Returns an unmodifiable set containing the values of the "password-character-set" property. 089 */ 090 SortedSet<String> getPasswordCharacterSet(); 091 092 093 094 /** 095 * Gets the "password-format" property. 096 * <p> 097 * Specifies the format to use for the generated password. 098 * <p> 099 * The value is a comma-delimited list of elements in which each of 100 * those elements is comprised of the name of a character set defined 101 * in the password-character-set property, a colon, and the number of 102 * characters to include from that set. For example, a value of 103 * "alpha:3,numeric:2,alpha:3" generates an 8-character password in 104 * which the first three characters are from the "alpha" set, the 105 * next two are from the "numeric" set, and the final three are from 106 * the "alpha" set. 107 * 108 * @return Returns the value of the "password-format" property. 109 */ 110 String getPasswordFormat(); 111 112}