| java.lang.Object | |
| ↳ | javax.security.auth.callback.PasswordCallback |
Class Overview
Underlying security services instantiate and pass a
PasswordCallback to the handle
method of a CallbackHandler to retrieve password information.
See Also
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Construct a
PasswordCallback with a prompt
and a boolean specifying whether the password should be displayed
as it is being typed. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Clear the retrieved password.
| |||||||||||
Get the retrieved password.
| |||||||||||
Get the prompt.
| |||||||||||
Return whether the password
should be displayed as it is being typed.
| |||||||||||
Set the retrieved password.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
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.
|
|---|
Public Methods
public void clearPassword ()
Clear the retrieved password.
public char[] getPassword ()
Get the retrieved password.
This method returns a copy of the retrieved password.
Returns
- the retrieved password, which may be null.
See Also
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.
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. |
|---|