Skip to content

Most visited

Recently visited

navigation

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:

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

Public constructors

PasswordCallback

Added in API level 1
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
void clearPassword ()

Clear the retrieved password.

getPassword

Added in API level 1
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:

getPrompt

Added in API level 1
String getPrompt ()

Get the prompt.

Returns
String the prompt.

isEchoOn

Added in API level 1
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
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:

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.