javax.security.auth.callback
Class PasswordCallback

java.lang.Object
  |
  +--javax.security.auth.callback.PasswordCallback
All Implemented Interfaces:
Callback

public class PasswordCallback
extends java.lang.Object
implements Callback

Underlying security services instantiate and pass a PasswordCallback to the invokeCallback method of a CallbackHandler to retrieve password information.

See Also:
CallbackHandler

Constructor Summary
PasswordCallback(java.lang.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.
 java.lang.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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PasswordCallback

public PasswordCallback(java.lang.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:
java.lang.IllegalArgumentException - if prompt is null or if prompt has a length of 0.
Method Detail

getPrompt

public java.lang.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.

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.

clearPassword

public void clearPassword()
Clear the retrieved password.