PasswordCallback

public class PasswordCallback
extends Object implements Callback, Serializable

java.lang.Object
↳	javax.security.auth.callback.PasswordCallback

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

See also:

CallbackHandler

Summary

Public constructors
`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 methods
`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 methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

PasswordCallback

Added in API level 1

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`	`String`: the prompt used to request the password.
`echoOn`	`boolean`: 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

clearPassword

Added in API level 1

public void clearPassword ()

Clear the retrieved password.

getPassword

Added in API level 1

public char[] getPassword ()

Get the retrieved password.

This method returns a copy of the retrieved password.

Returns
`char[]`	the retrieved password, which may be null.

See also:

setPassword(char)

getPrompt

Added in API level 1

public String getPrompt ()

Get the prompt.

Returns
`String`	the prompt.

isEchoOn

Added in API level 1

public boolean isEchoOn ()

Return whether the password should be displayed as it is being typed.

Returns
`boolean`	the whether the password should be displayed as it is being typed.

setPassword

Added in API level 1

public void setPassword (char[] password)

Set the retrieved password.

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

Parameters
`password`	`char`: the retrieved password, which may be null.

See also:

getPassword()