001 /* NameCallback.java -- callback for user names.
002 Copyright (C) 2003, Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.security.auth.callback;
040
041 import java.io.Serializable;
042
043 /**
044 * Underlying security services instantiate and pass a <code>NameCallback</code>
045 * to the <code>handle()</code> method of a {@link CallbackHandler} to retrieve
046 * name information.
047 *
048 * @see CallbackHandler
049 */
050 public class NameCallback implements Callback, Serializable
051 {
052
053 // Constants and variables
054 // -------------------------------------------------------------------------
055
056 /**
057 * @serial
058 * @since 1.4
059 */
060 private String prompt;
061
062 /**
063 * @serial
064 * @since 1.4
065 */
066 private String defaultName;
067
068 /**
069 * @serial
070 * @since 1.4
071 */
072 private String inputName;
073
074 // Constructor(s)
075 // -------------------------------------------------------------------------
076
077 /**
078 * Construct a <code>NameCallback</code> with a prompt.
079 *
080 * @param prompt the prompt used to request the name.
081 * @throws IllegalArgumentException if <code>prompt</code> is <code>null</code>
082 * or if <code>prompt</code> has a length of <code>0</code>.
083 */
084 public NameCallback(String prompt)
085 {
086 super();
087
088 setPrompt(prompt);
089 }
090
091 /**
092 * Construct a <code>NameCallback</code> with a prompt and default name.
093 *
094 * @param prompt the prompt used to request the information.
095 * @param defaultName the name to be used as the default name displayed with
096 * the prompt.
097 * @throws IllegalArgumentException if <code>prompt</code> is <code>null</code>
098 * or if <code>prompt</code> has a length of <code>0</code>, if
099 * <code>defaultName</code> is <code>null</code>, or if <code>defaultName</code>
100 * has a length of <code>0</code>.
101 */
102 public NameCallback(String prompt, String defaultName)
103 throws IllegalArgumentException
104 {
105 super();
106
107 setPrompt(prompt);
108 setDefaultName(defaultName);
109 }
110
111 // Class methods
112 // -------------------------------------------------------------------------
113
114 // Instance methods
115 // -------------------------------------------------------------------------
116
117 /**
118 * Get the prompt.
119 *
120 * @return the prompt.
121 */
122 public String getPrompt()
123 {
124 return prompt;
125 }
126
127 /**
128 * Get the default name.
129 *
130 * @return the default name, or <code>null</code> if this
131 * <code>NameCallback</code> was not instantiated with a
132 * <code>defaultName</code>.
133 */
134 public String getDefaultName()
135 {
136 return defaultName;
137 }
138
139 /**
140 * Set the retrieved name.
141 *
142 * @param name the retrieved name (which may be <code>null</code>).
143 * @see #getName()
144 */
145 public void setName(String name)
146 {
147 this.inputName = name;
148 }
149
150 /**
151 * Get the retrieved name.
152 *
153 * @return the retrieved name (which may be <code>null</code>)
154 * @see #setName(String)
155 */
156 public String getName()
157 {
158 return inputName;
159 }
160
161 private void setPrompt(String prompt) throws IllegalArgumentException
162 {
163 if ((prompt == null) || (prompt.length() == 0))
164 {
165 throw new IllegalArgumentException("invalid prompt");
166 }
167 this.prompt = prompt;
168 }
169
170 private void setDefaultName(String defaultName) throws IllegalArgumentException
171 {
172 if ((defaultName == null) || (defaultName.length() == 0))
173 {
174 throw new IllegalArgumentException("invalid default name");
175 }
176 this.defaultName = defaultName;
177 }
178 }