PasswordCallback

AI-generated Key Takeaways

• PasswordCallback is used by security services to retrieve password information from a CallbackHandler.

• It provides methods to set and get the password, prompt, and echo status.

• The getPassword() method returns a copy of the password for security reasons.

• The clearPassword() method can be used to erase the stored password after use.

• The constructor requires a prompt and a boolean indicating whether the password should be echoed.

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

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

Public Method Summary

void	clearPassword() Clear the retrieved password.
char[]	getPassword() Get 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.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this 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

• setPassword(char[])

public String getPrompt ()

Get the prompt.

Returns

• the prompt.

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.

See Also

• getPassword()