compact1, compact2, compact3
javax.security.auth.callback
Class PasswordCallback
- java.lang.Object
-
- javax.security.auth.callback.PasswordCallback
-
- All Implemented Interfaces:
- Serializable, Callback
public class PasswordCallback extends Object implements Callback, Serializable
Underlying security services instantiate and pass a
PasswordCallbackto thehandlemethod of aCallbackHandlerto retrieve password information.- See Also:
-
CallbackHandler, Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description PasswordCallback(String prompt, boolean echoOn)Construct aPasswordCallbackwith a prompt and a boolean specifying whether the password should be displayed as it is being typed.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description voidclearPassword()Clear the retrieved password.char[]getPassword()Get the retrieved password.StringgetPrompt()Get the prompt.booleanisEchoOn()Return whether the password should be displayed as it is being typed.voidsetPassword(char[] password)Set the retrieved password.
-
-
-
Constructor Detail
PasswordCallback
public PasswordCallback(String prompt, boolean echoOn)
Construct aPasswordCallbackwith 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- ifpromptis null or ifprompthas a length of 0.
-
Method Detail
getPrompt
public String getPrompt()
Get the prompt.- Returns:
- the prompt.
isEchoOn
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
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()
getPassword
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[])
clearPassword
public void clearPassword()
Clear the retrieved password.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
