001 /*
002 * Copyright 1999-2003 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.security.auth.callback;
027
028 /**
029 * <p> Underlying security services instantiate and pass a
030 * <code>NameCallback</code> to the <code>handle</code>
031 * method of a <code>CallbackHandler</code> to retrieve name information.
032 *
033 * @version 1.21, 05/05/07
034 * @see javax.security.auth.callback.CallbackHandler
035 */
036 public class NameCallback implements Callback, java.io.Serializable {
037
038 private static final long serialVersionUID = 3770938795909392253L;
039
040 /**
041 * @serial
042 * @since 1.4
043 */
044 private String prompt;
045 /**
046 * @serial
047 * @since 1.4
048 */
049 private String defaultName;
050 /**
051 * @serial
052 * @since 1.4
053 */
054 private String inputName;
055
056 /**
057 * Construct a <code>NameCallback</code> with a prompt.
058 *
059 * <p>
060 *
061 * @param prompt the prompt used to request the name.
062 *
063 * @exception IllegalArgumentException if <code>prompt</code> is null
064 * or if <code>prompt</code> has a length of 0.
065 */
066 public NameCallback(String prompt) {
067 if (prompt == null || prompt.length() == 0)
068 throw new IllegalArgumentException();
069 this .prompt = prompt;
070 }
071
072 /**
073 * Construct a <code>NameCallback</code> with a prompt
074 * and default name.
075 *
076 * <p>
077 *
078 * @param prompt the prompt used to request the information. <p>
079 *
080 * @param defaultName the name to be used as the default name displayed
081 * with the prompt.
082 *
083 * @exception IllegalArgumentException if <code>prompt</code> is null,
084 * if <code>prompt</code> has a length of 0,
085 * if <code>defaultName</code> is null,
086 * or if <code>defaultName</code> has a length of 0.
087 */
088 public NameCallback(String prompt, String defaultName) {
089 if (prompt == null || prompt.length() == 0
090 || defaultName == null || defaultName.length() == 0)
091 throw new IllegalArgumentException();
092
093 this .prompt = prompt;
094 this .defaultName = defaultName;
095 }
096
097 /**
098 * Get the prompt.
099 *
100 * <p>
101 *
102 * @return the prompt.
103 */
104 public String getPrompt() {
105 return prompt;
106 }
107
108 /**
109 * Get the default name.
110 *
111 * <p>
112 *
113 * @return the default name, or null if this <code>NameCallback</code>
114 * was not instantiated with a <code>defaultName</code>.
115 */
116 public String getDefaultName() {
117 return defaultName;
118 }
119
120 /**
121 * Set the retrieved name.
122 *
123 * <p>
124 *
125 * @param name the retrieved name (which may be null).
126 *
127 * @see #getName
128 */
129 public void setName(String name) {
130 this .inputName = name;
131 }
132
133 /**
134 * Get the retrieved name.
135 *
136 * <p>
137 *
138 * @return the retrieved name (which may be null)
139 *
140 * @see #setName
141 */
142 public String getName() {
143 return inputName;
144 }
145 }
|