/* * @(#)PasswordCallback.java 1.18 03/12/19 * * Copyright 2004 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.security.auth.callback; /** *
Underlying security services instantiate and pass a
* PasswordCallback
to the handle
* method of a CallbackHandler
to retrieve password information.
*
* @version 1.18, 12/19/03
* @see javax.security.auth.callback.CallbackHandler
*/
public class PasswordCallback implements Callback, java.io.Serializable {
private static final long serialVersionUID = 2267422647454909926L;
/**
* @serial
* @since 1.4
*/
private String prompt;
/**
* @serial
* @since 1.4
*/
private boolean echoOn;
/**
* @serial
* @since 1.4
*/
private char[] inputPassword;
/**
* Construct a PasswordCallback
with a prompt
* and a boolean specifying whether the password should be displayed
* as it is being typed.
*
*
* * @param prompt the prompt used to request the password.
*
* @param echoOn true if the password should be displayed
* as it is being typed.
*
* @exception IllegalArgumentException if prompt
is null or
* if prompt
has a length of 0.
*/
public PasswordCallback(String prompt, boolean echoOn) {
if (prompt == null || prompt.length() == 0)
throw new IllegalArgumentException();
this.prompt = prompt;
this.echoOn = echoOn;
}
/**
* Get the prompt.
*
*
* * @return the prompt. */ public String getPrompt() { return prompt; } /** * Return whether the password * should be displayed as it is being typed. * *
* * @return the whether the password * should be displayed as it is being typed. */ public boolean isEchoOn() { return echoOn; } /** * Set the retrieved password. * *
This method makes a copy of the input password * before storing it. * *
* * @param password the retrieved password, which may be null. * * @see #getPassword */ public void setPassword(char[] password) { this.inputPassword = (password == null ? null : (char[])password.clone()); } /** * Get the retrieved password. * *
This method returns a copy of the retrieved password. * *
* * @return the retrieved password, which may be null. * * @see #setPassword */ public char[] getPassword() { return (inputPassword == null? null : (char[])inputPassword.clone()); } /** * Clear the retrieved password. */ public void clearPassword() { if (inputPassword != null) { for (int i = 0; i < inputPassword.length; i++) inputPassword[i] = ' '; } } }