javax.security.auth.callback

Class PasswordCallback

  1. java.lang.Object
  2. extended byjavax.security.auth.callback.PasswordCallback
All implemented interfaces:
java.io.Serializable, Callback

  1. public class PasswordCallback
  2. extends java.lang.Object
  3. implements Callback, java.io.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

Constructor and Description
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

Modifier and Type Method and Description
  1. void
clearPassword()
Clear the retrieved password.
  1. char[]
getPassword()
Get the retrieved password.
  1. java.lang.String
getPrompt()
Get the prompt.
  1. boolean
isEchoOn()
Return whether the password should be displayed as it is being typed.
  1. 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

  1. public PasswordCallback(java.lang.String prompt,
  2. 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

  1. public java.lang.String getPrompt( )
Get the prompt.

Returns:
the prompt.

isEchoOn

  1. 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

  1. 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

  1. 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:

clearPassword

  1. public void clearPassword()
Clear the retrieved password.