001/* TextInputCallback.java -- callbacks for user input. 002 Copyright (C) 2003, Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package javax.security.auth.callback; 040 041import java.io.Serializable; 042 043/** 044 * Underlying security services instantiate and pass a <code>TextInputCallback</code> 045 * to the <code>handle()</code> method of a {@link CallbackHandler} to retrieve 046 * generic text information. 047 * 048 * @see CallbackHandler 049 */ 050public class TextInputCallback implements Callback, Serializable 051{ 052 053 // Constants and variables 054 // ------------------------------------------------------------------------- 055 056 /** 057 * @serial 058 * @since 1.4 059 */ 060 private String prompt; 061 062 /** 063 * @serial 064 * @since 1.4 065 */ 066 private String defaultText; 067 068 /** 069 * @serial 070 * @since 1.4 071 */ 072 private String inputText; 073 074 // Constructor(s) 075 // ------------------------------------------------------------------------- 076 077 /** 078 * Construct a <code>TextInputCallback</code> with a prompt. 079 * 080 * @param prompt the prompt used to request the information. 081 * @throws IllegalArgumentException if <code>prompt</code> is <code>null</code> 082 * or if <code>prompt</code> has a length of <code>0</code>. 083 */ 084 public TextInputCallback(String prompt) throws IllegalArgumentException 085 { 086 super(); 087 088 setPrompt(prompt); 089 } 090 091 /** 092 * Construct a <code>TextInputCallback</code> with a prompt and default 093 * input value. 094 * 095 * @param prompt the prompt used to request the information. 096 * @param defaultText the text to be used as the default text displayed with 097 * the prompt. 098 * @throws IllegalArgumentException if <code>prompt</code> is <code>null</code>, 099 * if <code>prompt</code> has a length of <code>0</code>, if 100 * <code>defaultText</code> is <code>null</code> or if <code>defaultText</code> 101 * has a length of <code>0</code>. 102 */ 103 public TextInputCallback(String prompt, String defaultText) 104 throws IllegalArgumentException 105 { 106 super(); 107 108 setPrompt(prompt); 109 setDefaultText(defaultText); 110 } 111 112 // Class methods 113 // ------------------------------------------------------------------------- 114 115 // Instance methods 116 // ------------------------------------------------------------------------- 117 118 /** 119 * Get the prompt. 120 * 121 * @return the prompt. 122 */ 123 public String getPrompt() 124 { 125 return prompt; 126 } 127 128 /** 129 * Get the default text. 130 * 131 * @return the default text, or <code>null</code> if this 132 * <code>TextInputCallback</code> was not instantiated with 133 * <code>defaultText</code>. 134 */ 135 public String getDefaultText() 136 { 137 return defaultText; 138 } 139 140 /** 141 * Set the retrieved text. 142 * 143 * @param text the retrieved text, which may be <code>null</code>. 144 */ 145 public void setText(String text) 146 { 147 this.inputText = text; 148 } 149 150 /** 151 * Get the retrieved text. 152 * 153 * @return the retrieved text, which may be <code>null</code>. 154 */ 155 public String getText() 156 { 157 return inputText; 158 } 159 160 private void setPrompt(String prompt) throws IllegalArgumentException 161 { 162 if ((prompt == null) || (prompt.length() == 0)) 163 { 164 throw new IllegalArgumentException("invalid prompt"); 165 } 166 this.prompt = prompt; 167 } 168 169 private void setDefaultText(String defaultText) throws IllegalArgumentException 170 { 171 if ((defaultText == null) || (defaultText.length() == 0)) 172 { 173 throw new IllegalArgumentException("invalid default text"); 174 } 175 this.defaultText = defaultText; 176 } 177}