Android APIs
public class

PasswordCallback

extends Object
implements Callback Serializable
java.lang.Object
   ↳ javax.security.auth.callback.PasswordCallback

Class Overview

Used in conjunction with a CallbackHandler to retrieve a password when needed.

Summary

Public Constructors
PasswordCallback(String prompt, boolean echoOn)
Creates a new PasswordCallback instance.
Public Methods
void clearPassword()
Clears the password stored in this PasswordCallback.
char[] getPassword()
Returns the password.
String getPrompt()
Returns the prompt that was specified when creating this PasswordCallback
boolean isEchoOn()
Queries whether this PasswordCallback expects user input to be echoed, which is specified during the creation of the object.
void setPassword(char[] password)
Sets the password.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PasswordCallback (String prompt, boolean echoOn)

Added in API level 1

Creates a new PasswordCallback instance.

Parameters
prompt the message that should be displayed to the user
echoOn determines whether the user input should be echoed

Public Methods

public void clearPassword ()

Added in API level 1

Clears the password stored in this PasswordCallback.

public char[] getPassword ()

Added in API level 1

Returns the password. The security service that needs the password usually calls this method once the CallbackHandler has finished its work.

Returns
char[] the password. A copy of the internal password is created and returned, so subsequent changes to the internal password do not affect the result.

public String getPrompt ()

Added in API level 1

Returns the prompt that was specified when creating this PasswordCallback

Returns
String the prompt

public boolean isEchoOn ()

Added in API level 1

Queries whether this PasswordCallback expects user input to be echoed, which is specified during the creation of the object.

Returns
boolean true if (and only if) user input should be echoed

public void setPassword (char[] password)

Added in API level 1

Sets the password. The CallbackHandler that performs the actual provisioning or input of the password needs to call this method to hand back the password to the security service that requested it.

Parameters
password the password. A copy of this is stored, so subsequent changes to the input array do not affect the PasswordCallback.