PasswordCallback (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • javax.security.auth.callback.PasswordCallback

• All Implemented Interfaces:
  [Serializable](../../../../java/io/Serializable.html "interface in java.io"), [Callback](../../../../javax/security/auth/callback/Callback.html "interface in javax.security.auth.callback")

public class PasswordCallback
extends Object
implements Callback, Serializable
Underlying security services instantiate and pass aPasswordCallback to the handle method of a CallbackHandler to retrieve password information.
Since:
1.4
See Also:
CallbackHandler, Serialized Form

• • Constructor Summary

  Constructors

  Constructor	Description
  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.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  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.

     * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../../java/lang/Object.html#clone--), [equals](../../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../../java/lang/Object.html#finalize--), [getClass](../../../../java/lang/Object.html#getClass--), [hashCode](../../../../java/lang/Object.html#hashCode--), [notify](../../../../java/lang/Object.html#notify--), [notifyAll](../../../../java/lang/Object.html#notifyAll--), [toString](../../../../java/lang/Object.html#toString--), [wait](../../../../java/lang/Object.html#wait--), [wait](../../../../java/lang/Object.html#wait-long-), [wait](../../../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### PasswordCallback  
     public PasswordCallback​([String](../../../../java/lang/String.html "class in java.lang") 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` \- the prompt used to request the password.  
     `echoOn` \- true if the password should be displayed as it is being typed.  
     Throws:  
     `[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `prompt` is null or if `prompt` has a length of 0.  

  • Method Detail

    * #### getPrompt  
    public [String](../../../../java/lang/String.html "class in java.lang") 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()](../../../../javax/security/auth/callback/PasswordCallback.html#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\[\])](../../../../javax/security/auth/callback/PasswordCallback.html#setPassword-char:A-)  
    * #### clearPassword  
    public void clearPassword​()  
    Clear the retrieved password.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.