1/* 2 * Copyright (c) 1999, 2015, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26package javax.security.auth.callback; 27 28/** 29 * <p> Underlying security services instantiate and pass a 30 * {@code TextInputCallback} to the {@code handle} 31 * method of a {@code CallbackHandler} to retrieve generic text 32 * information. 33 * 34 * @since 1.4 35 * @see javax.security.auth.callback.CallbackHandler 36 */ 37public class TextInputCallback implements Callback, java.io.Serializable { 38 39 private static final long serialVersionUID = -8064222478852811804L; 40 41 /** 42 * @serial 43 * @since 1.4 44 */ 45 private String prompt; 46 /** 47 * @serial 48 * @since 1.4 49 */ 50 private String defaultText; 51 /** 52 * @serial 53 * @since 1.4 54 */ 55 private String inputText; 56 57 /** 58 * Construct a {@code TextInputCallback} with a prompt. 59 * 60 * @param prompt the prompt used to request the information. 61 * 62 * @exception IllegalArgumentException if {@code prompt} is null 63 * or if {@code prompt} has a length of 0. 64 */ 65 public TextInputCallback(String prompt) { 66 if (prompt == null || prompt.length() == 0) 67 throw new IllegalArgumentException(); 68 this.prompt = prompt; 69 } 70 71 /** 72 * Construct a {@code TextInputCallback} with a prompt 73 * and default input value. 74 * 75 * @param prompt the prompt used to request the information. 76 * 77 * @param defaultText the text to be used as the default text displayed 78 * with the prompt. 79 * 80 * @exception IllegalArgumentException if {@code prompt} is null, 81 * if {@code prompt} has a length of 0, 82 * if {@code defaultText} is null 83 * or if {@code defaultText} has a length of 0. 84 */ 85 public TextInputCallback(String prompt, String defaultText) { 86 if (prompt == null || prompt.length() == 0 || 87 defaultText == null || defaultText.length() == 0) 88 throw new IllegalArgumentException(); 89 90 this.prompt = prompt; 91 this.defaultText = defaultText; 92 } 93 94 /** 95 * Get the prompt. 96 * 97 * @return the prompt. 98 */ 99 public String getPrompt() { 100 return prompt; 101 } 102 103 /** 104 * Get the default text. 105 * 106 * @return the default text, or null if this {@code TextInputCallback} 107 * was not instantiated with {@code defaultText}. 108 */ 109 public String getDefaultText() { 110 return defaultText; 111 } 112 113 /** 114 * Set the retrieved text. 115 * 116 * @param text the retrieved text, which may be null. 117 * 118 * @see #getText 119 */ 120 public void setText(String text) { 121 this.inputText = text; 122 } 123 124 /** 125 * Get the retrieved text. 126 * 127 * @return the retrieved text, which may be null. 128 * 129 * @see #setText 130 */ 131 public String getText() { 132 return inputText; 133 } 134} 135