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 
  26 package 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  * @see javax.security.auth.callback.CallbackHandler
  35  */
  36 public class TextInputCallback implements Callback, java.io.Serializable {
  37 
  38     private static final long serialVersionUID = -8064222478852811804L;
  39 
  40     /**
  41      * @serial
  42      * @since 1.4
  43      */
  44     private String prompt;
  45     /**
  46      * @serial
  47      * @since 1.4
  48      */
  49     private String defaultText;
  50     /**
  51      * @serial
  52      * @since 1.4
  53      */
  54     private String inputText;
  55 
  56     /**
  57      * Construct a {@code TextInputCallback} with a prompt.
  58      *
  59      * @param prompt the prompt used to request the information.
  60      *
  61      * @exception IllegalArgumentException if {@code prompt} is null
  62      *                  or if {@code prompt} has a length of 0.
  63      */
  64     public TextInputCallback(String prompt) {
  65         if (prompt == null || prompt.length() == 0)
  66             throw new IllegalArgumentException();
  67         this.prompt = prompt;
  68     }
  69 
  70     /**
  71      * Construct a {@code TextInputCallback} with a prompt
  72      * and default input value.
  73      *
  74      * @param prompt the prompt used to request the information.
  75      *
  76      * @param defaultText the text to be used as the default text displayed
  77      *                  with the prompt.
  78      *
  79      * @exception IllegalArgumentException if {@code prompt} is null,
  80      *                  if {@code prompt} has a length of 0,
  81      *                  if {@code defaultText} is null
  82      *                  or if {@code defaultText} has a length of 0.
  83      */
  84     public TextInputCallback(String prompt, String defaultText) {
  85         if (prompt == null || prompt.length() == 0 ||
  86             defaultText == null || defaultText.length() == 0)
  87             throw new IllegalArgumentException();
  88 
  89         this.prompt = prompt;
  90         this.defaultText = defaultText;
  91     }
  92 
  93     /**
  94      * Get the prompt.
  95      *
  96      * @return the prompt.
  97      */
  98     public String getPrompt() {
  99         return prompt;
 100     }
 101 
 102     /**
 103      * Get the default text.
 104      *
 105      * @return the default text, or null if this {@code TextInputCallback}
 106      *          was not instantiated with {@code defaultText}.
 107      */
 108     public String getDefaultText() {
 109         return defaultText;
 110     }
 111 
 112     /**
 113      * Set the retrieved text.
 114      *
 115      * @param text the retrieved text, which may be null.
 116      *
 117      * @see #getText
 118      */
 119     public void setText(String text) {
 120         this.inputText = text;
 121     }
 122 
 123     /**
 124      * Get the retrieved text.
 125      *
 126      * @return the retrieved text, which may be null.
 127      *
 128      * @see #setText
 129      */
 130     public String getText() {
 131         return inputText;
 132     }
 133 }