- 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
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.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/security/auth/callback/PasswordCallback.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
