javax.security.auth.callback

Class PasswordCallback

Implemented Interfaces:
Callback, Serializable

public class PasswordCallback
extends Object
implements Callback, Serializable

Underlying security services instantiate and pass a PasswordCallback to the handle() method of a CallbackHandler to retrieve password information.
See Also:
CallbackHandler,, Serialized Form

Constructor Summary

PasswordCallback(String prompt, boolean echoOn)
Construct a PasswordCallback with a prompt and a boolean specifying whether the password should be displayed as it is being typed.

Method Summary

void
clearPassword()
Clear the retrieved password.
char[]
getPassword()
Get the retrieved password.

This method returns a copy of the retrieved password.

String
getPrompt()
Get the prompt.
boolean
isEchoOn()
Return whether the password should be displayed as it is being typed.
void
setPassword(char[] password)
Set the retrieved password.

This method makes a copy of the input password before storing it.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PasswordCallback

public PasswordCallback(String prompt,
                        boolean echoOn)
Construct a PasswordCallback with a prompt and a boolean specifying whether the password should be displayed as it is being typed.
Parameters:
prompt - the prompt used to request the password.
echoOn - true if the password should be displayed as it is being typed.
Throws:
IllegalArgumentException - if prompt is null or if prompt has a length of 0.

Method Details

clearPassword

public void clearPassword()
Clear the retrieved password.

getPassword

public char[] getPassword()
Get the retrieved password.

This method returns a copy of the retrieved password.

Returns:
the retrieved password, which may be null.

getPrompt

public String getPrompt()
Get the prompt.
Returns:
the prompt.

isEchoOn

public boolean isEchoOn()
Return whether the password should be displayed as it is being typed.
Returns:
the whether the password should be displayed as it is being typed.

setPassword

public void setPassword(char[] password)
Set the retrieved password.

This method makes a copy of the input password before storing it.

Parameters:
password - the retrieved password, which may be null.
See Also:
getPassword()

PasswordCallback.java -- callback for passwords. Copyright (C) 2003, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.