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  * @since 1.4

    34  * @see javax.security.auth.callback.CallbackHandler

    35  */

    36 public class NameCallback implements Callback, java.io.Serializable {

    37 

    38     private static final long serialVersionUID = 3770938795909392253L;

    39 

    40     /**

    41      * @serial

    42      * @since 1.4

    43      */

    44     private String prompt;

    45     /**

    46      * @serial

    47      * @since 1.4

    48      */

    49     private String defaultName;

    50     /**

    51      * @serial

    52      * @since 1.4

    53      */

    54     private String inputName;

    55 

    56     /**

    57      * Construct a {@code NameCallback} with a prompt.

    58      *

    59      * @param prompt the prompt used to request the name.

    60      *

    61      * @exception IllegalArgumentException if {@code prompt} is null

    62      *                  or if {@code prompt} has a length of 0.

    63      */

    64     public NameCallback(String prompt) {

    65         if (prompt == null || prompt.length() == 0)

    66             throw new IllegalArgumentException();

    67         this.prompt = prompt;

    68     }

    69 

    70     /**

    71      * Construct a {@code NameCallback} with a prompt

    72      * and default name.

    73      *

    74      * @param prompt the prompt used to request the information.

    75      *

    76      * @param defaultName the name to be used as the default name 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 defaultName} is null,

    82      *                  or if {@code defaultName} has a length of 0.

    83      */

    84     public NameCallback(String prompt, String defaultName) {

    85         if (prompt == null || prompt.length() == 0 ||

    86             defaultName == null || defaultName.length() == 0)

    87             throw new IllegalArgumentException();

    88 

    89         this.prompt = prompt;

    90         this.defaultName = defaultName;

    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 name.

   104      *

   105      * @return the default name, or null if this {@code NameCallback}

   106      *          was not instantiated with a {@code defaultName}.

   107      */

   108     public String getDefaultName() {

   109         return defaultName;

   110     }

   111 

   112     /**

   113      * Set the retrieved name.

   114      *

   115      * @param name the retrieved name (which may be null).

   116      *

   117      * @see #getName

   118      */

   119     public void setName(String name) {

   120         this.inputName = name;

   121     }

   122 

   123     /**

   124      * Get the retrieved name.

   125      *

   126      * @return the retrieved name (which may be null)

   127      *

   128      * @see #setName

   129      */

   130     public String getName() {

   131         return inputName;

   132     }

   133 }