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>PasswordCallback</code> to the <code>handle</code>
031 * method of a <code>CallbackHandler</code> to retrieve password information.
032 *
033 * @version 1.25, 05/05/07
034 * @see javax.security.auth.callback.CallbackHandler
035 */
036 public class PasswordCallback implements Callback, java.io.Serializable {
037
038 private static final long serialVersionUID = 2267422647454909926L;
039
040 /**
041 * @serial
042 * @since 1.4
043 */
044 private String prompt;
045 /**
046 * @serial
047 * @since 1.4
048 */
049 private boolean echoOn;
050 /**
051 * @serial
052 * @since 1.4
053 */
054 private char[] inputPassword;
055
056 /**
057 * Construct a <code>PasswordCallback</code> with a prompt
058 * and a boolean specifying whether the password should be displayed
059 * as it is being typed.
060 *
061 * <p>
062 *
063 * @param prompt the prompt used to request the password. <p>
064 *
065 * @param echoOn true if the password should be displayed
066 * as it is being typed.
067 *
068 * @exception IllegalArgumentException if <code>prompt</code> is null or
069 * if <code>prompt</code> has a length of 0.
070 */
071 public PasswordCallback(String prompt, boolean echoOn) {
072 if (prompt == null || prompt.length() == 0)
073 throw new IllegalArgumentException();
074
075 this .prompt = prompt;
076 this .echoOn = echoOn;
077 }
078
079 /**
080 * Get the prompt.
081 *
082 * <p>
083 *
084 * @return the prompt.
085 */
086 public String getPrompt() {
087 return prompt;
088 }
089
090 /**
091 * Return whether the password
092 * should be displayed as it is being typed.
093 *
094 * <p>
095 *
096 * @return the whether the password
097 * should be displayed as it is being typed.
098 */
099 public boolean isEchoOn() {
100 return echoOn;
101 }
102
103 /**
104 * Set the retrieved password.
105 *
106 * <p> This method makes a copy of the input <i>password</i>
107 * before storing it.
108 *
109 * <p>
110 *
111 * @param password the retrieved password, which may be null.
112 *
113 * @see #getPassword
114 */
115 public void setPassword(char[] password) {
116 this .inputPassword = (password == null ? null
117 : (char[]) password.clone());
118 }
119
120 /**
121 * Get the retrieved password.
122 *
123 * <p> This method returns a copy of the retrieved password.
124 *
125 * <p>
126 *
127 * @return the retrieved password, which may be null.
128 *
129 * @see #setPassword
130 */
131 public char[] getPassword() {
132 return (inputPassword == null ? null : (char[]) inputPassword
133 .clone());
134 }
135
136 /**
137 * Clear the retrieved password.
138 */
139 public void clearPassword() {
140 if (inputPassword != null) {
141 for (int i = 0; i < inputPassword.length; i++)
142 inputPassword[i] = ' ';
143 }
144 }
145 }
|