Source for javax.security.auth.callback.TextInputCallback

   1: /* TextInputCallback.java -- callbacks for user input.
   2:    Copyright (C) 2003, Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.security.auth.callback;
  40: 
  41: import java.io.Serializable;
  42: 
  43: /**
  44:  * Underlying security services instantiate and pass a <code>TextInputCallback</code>
  45:  * to the <code>handle()</code> method of a {@link CallbackHandler} to retrieve
  46:  * generic text information.
  47:  *
  48:  * @see CallbackHandler
  49:  */
  50: public class TextInputCallback implements Callback, Serializable
  51: {
  52: 
  53:   // Constants and variables
  54:   // -------------------------------------------------------------------------
  55: 
  56:   /**
  57:    * @serial
  58:    * @since 1.4
  59:    */
  60:   private String prompt;
  61: 
  62:   /**
  63:    * @serial
  64:    * @since 1.4
  65:    */
  66:   private String defaultText;
  67: 
  68:   /**
  69:    * @serial
  70:    * @since 1.4
  71:    */
  72:   private String inputText;
  73: 
  74:   // Constructor(s)
  75:   // -------------------------------------------------------------------------
  76: 
  77:   /**
  78:    * Construct a <code>TextInputCallback</code> with a prompt.
  79:    *
  80:    * @param prompt the prompt used to request the information.
  81:    * @throws IllegalArgumentException if <code>prompt</code> is <code>null</code>
  82:    * or if <code>prompt</code> has a length of <code>0</code>.
  83:    */
  84:   public TextInputCallback(String prompt) throws IllegalArgumentException
  85:   {
  86:     super();
  87: 
  88:     setPrompt(prompt);
  89:   }
  90: 
  91:   /**
  92:    * Construct a <code>TextInputCallback</code> with a prompt and default
  93:    * input value.
  94:    *
  95:    * @param prompt the prompt used to request the information.
  96:    * @param defaultText the text to be used as the default text displayed with
  97:    * the prompt.
  98:    * @throws IllegalArgumentException if <code>prompt</code> is <code>null</code>,
  99:    * 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: }