javax.security.auth.callback: public class: PasswordCallback

javax.security.auth.callback
public class: PasswordCallback [javadoc | source]

java.lang.Object
   javax.security.auth.callback.PasswordCallback

All Implemented Interfaces:
Callback, java$io$Serializable

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

Also see:

javax.security.auth.callback.CallbackHandler

Constructor:

Constructor:
public PasswordCallback(String prompt, boolean echoOn) { if (prompt == null \|\| prompt.length() == 0) throw new IllegalArgumentException(); this.prompt = prompt; this.echoOn = 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` - if `prompt` is null or if `prompt` has a length of 0. exception: `IllegalArgumentException` - if `prompt` is null or if `prompt` has a length of 0.

 public PasswordCallback(String prompt,
    boolean echoOn) {
        if (prompt == null || prompt.length() == 0)
            throw new IllegalArgumentException();
        this.prompt = prompt;
        this.echoOn = echoOn;
}

PasswordCallback

Parameters:

prompt - the prompt used to request the password.

echoOn - 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.

exception: IllegalArgumentException - if prompt is null or if prompt has a length of 0.

Method from javax.security.auth.callback.PasswordCallback Summary:
clearPassword, getPassword, getPrompt, isEchoOn, setPassword

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.security.auth.callback.PasswordCallback Detail:
public void clearPassword() { if (inputPassword != null) { for (int i = 0; i < inputPassword.length; i++) inputPassword[i] = ' '; } } Clear the retrieved password.
public char[] getPassword() { return (inputPassword == null ? null : inputPassword.clone()); } Get the retrieved password. This method returns a copy of the retrieved password.
public String getPrompt() { return prompt; } Get the prompt.
public boolean isEchoOn() { return echoOn; } Return whether the password should be displayed as it is being typed.
public void setPassword(char[] password) { this.inputPassword = (password == null ? null : password.clone()); } Set the retrieved password. This method makes a copy of the input password before storing it.

Method from javax.security.auth.callback.PasswordCallback Detail:

 public  void clearPassword() {
        if (inputPassword != null) {
            for (int i = 0; i <  inputPassword.length; i++)
                inputPassword[i] = ' ';
        }
}

Clear the retrieved password.

 public char[] getPassword() {
        return (inputPassword == null ? null : inputPassword.clone());
}

This method returns a copy of the retrieved password.

 public String getPrompt() {
        return prompt;
}

 public boolean isEchoOn() {
        return echoOn;
}

 public  void setPassword(char[] password) {
        this.inputPassword = (password == null ? null : password.clone());
}

This method makes a copy of the input password before storing it.