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