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.PasswordGeneratorCfg; 035 036 037 038 /** 039 * A client-side interface for reading and modifying Password 040 * Generator settings. 041 * <p> 042 * Password Generators are used by the password modify extended 043 * operation to construct a new password for the user. 044 */ 045 public interface PasswordGeneratorCfgClient extends ConfigurationClient { 046 047 /** 048 * Get the configuration definition associated with this Password Generator. 049 * 050 * @return Returns the configuration definition associated with this Password Generator. 051 */ 052 ManagedObjectDefinition<? extends PasswordGeneratorCfgClient, ? extends PasswordGeneratorCfg> definition(); 053 054 055 056 /** 057 * Gets the "enabled" property. 058 * <p> 059 * Indicates whether the Password Generator is enabled for use. 060 * 061 * @return Returns the value of the "enabled" property. 062 */ 063 Boolean isEnabled(); 064 065 066 067 /** 068 * Sets the "enabled" property. 069 * <p> 070 * Indicates whether the Password Generator is enabled for use. 071 * 072 * @param value The value of the "enabled" property. 073 * @throws IllegalPropertyValueException 074 * If the new value is invalid. 075 */ 076 void setEnabled(boolean value) throws IllegalPropertyValueException; 077 078 079 080 /** 081 * Gets the "java-class" property. 082 * <p> 083 * Specifies the fully-qualified name of the Java class that 084 * provides the Password Generator implementation. 085 * 086 * @return Returns the value of the "java-class" property. 087 */ 088 String getJavaClass(); 089 090 091 092 /** 093 * Sets the "java-class" property. 094 * <p> 095 * Specifies the fully-qualified name of the Java class that 096 * provides the Password Generator implementation. 097 * 098 * @param value The value of the "java-class" property. 099 * @throws IllegalPropertyValueException 100 * If the new value is invalid. 101 */ 102 void setJavaClass(String value) throws IllegalPropertyValueException; 103 104 }