Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.security.auth.callback
Class PasswordCallback

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.security.auth.callback.PasswordCallback
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Callback sample code for javax.security.auth.callback.Callback definition code for javax.security.auth.callback.Callback 
public class PasswordCallback
extends Object sample code for java.lang.Object definition code for java.lang.Object 
implements Callback sample code for javax.security.auth.callback.Callback definition code for javax.security.auth.callback.Callback , Serializable sample code for java.io.Serializable definition code for java.io.Serializable

Underlying security services instantiate and pass a PasswordCallback to the handle method of a CallbackHandler to retrieve password information.

See Also:
CallbackHandler sample code for javax.security.auth.callback.CallbackHandler definition code for javax.security.auth.callback.CallbackHandler , Serialized Form

Constructor Summary
PasswordCallback sample code for javax.security.auth.callback.PasswordCallback.PasswordCallback(java.lang.String, boolean) definition code for javax.security.auth.callback.PasswordCallback.PasswordCallback(java.lang.String, boolean) (String sample code for java.lang.String definition code for java.lang.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
 void clearPassword sample code for javax.security.auth.callback.PasswordCallback.clearPassword() definition code for javax.security.auth.callback.PasswordCallback.clearPassword() ()
          Clear the retrieved password.
 char[] getPassword sample code for javax.security.auth.callback.PasswordCallback.getPassword() definition code for javax.security.auth.callback.PasswordCallback.getPassword() ()
          Get the retrieved password.
 String sample code for java.lang.String definition code for java.lang.String getPrompt sample code for javax.security.auth.callback.PasswordCallback.getPrompt() definition code for javax.security.auth.callback.PasswordCallback.getPrompt() ()
          Get the prompt.
 boolean isEchoOn sample code for javax.security.auth.callback.PasswordCallback.isEchoOn() definition code for javax.security.auth.callback.PasswordCallback.isEchoOn() ()
          Return whether the password should be displayed as it is being typed.
 void setPassword sample code for javax.security.auth.callback.PasswordCallback.setPassword(char[]) definition code for javax.security.auth.callback.PasswordCallback.setPassword(char[]) (char[] password)
          Set the retrieved password.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

PasswordCallback sample code for javax.security.auth.callback.PasswordCallback(java.lang.String, boolean) definition code for javax.security.auth.callback.PasswordCallback(java.lang.String, boolean) 

public PasswordCallback(String sample code for java.lang.String definition code for java.lang.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 - the prompt used to request the password.

echoOn - true if the password should be displayed as it is being typed.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if prompt is null or if prompt has a length of 0.
Method Detail

getPrompt sample code for javax.security.auth.callback.PasswordCallback.getPrompt() definition code for javax.security.auth.callback.PasswordCallback.getPrompt() 

public String sample code for java.lang.String definition code for java.lang.String  getPrompt()
Get the prompt.

Returns:
the prompt.

isEchoOn sample code for javax.security.auth.callback.PasswordCallback.isEchoOn() definition code for javax.security.auth.callback.PasswordCallback.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 sample code for javax.security.auth.callback.PasswordCallback.setPassword(char[]) definition code for javax.security.auth.callback.PasswordCallback.setPassword(char[]) 

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() sample code for javax.security.auth.callback.PasswordCallback.getPassword() definition code for javax.security.auth.callback.PasswordCallback.getPassword()

getPassword sample code for javax.security.auth.callback.PasswordCallback.getPassword() definition code for javax.security.auth.callback.PasswordCallback.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[]) sample code for javax.security.auth.callback.PasswordCallback.setPassword(char[]) definition code for javax.security.auth.callback.PasswordCallback.setPassword(char[])

clearPassword sample code for javax.security.auth.callback.PasswordCallback.clearPassword() definition code for javax.security.auth.callback.PasswordCallback.clearPassword() 

public void clearPassword()
Clear the retrieved password.

Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD