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

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

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

All Implemented Interfaces:
Callback, java$io$Serializable

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

Also see:

javax.security.auth.callback.CallbackHandler

Constructor:

Constructor:
public NameCallback(String prompt) { if (prompt == null \|\| prompt.length() == 0) throw new IllegalArgumentException(); this.prompt = prompt; } Construct a `NameCallback` with a prompt. Parameters: `prompt` - the prompt used to request the name. 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 NameCallback(String prompt, String defaultName) { if (prompt == null \|\| prompt.length() == 0 \|\| defaultName == null \|\| defaultName.length() == 0) throw new IllegalArgumentException(); this.prompt = prompt; this.defaultName = defaultName; } Construct a `NameCallback` with a prompt and default name. Parameters: `prompt` - the prompt used to request the information. `defaultName` - the name to be used as the default name displayed with the prompt. Throws: `IllegalArgumentException` - if `prompt` is null, if `prompt` has a length of 0, if `defaultName` is null, or if `defaultName` has a length of 0. exception: `IllegalArgumentException` - if `prompt` is null, if `prompt` has a length of 0, if `defaultName` is null, or if `defaultName` has a length of 0.

 public NameCallback(String prompt) {
        if (prompt == null || prompt.length() == 0)
            throw new IllegalArgumentException();
        this.prompt = prompt;
}

NameCallback

Parameters:

prompt - the prompt used to request the name.

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 NameCallback(String prompt,
    String defaultName) {
        if (prompt == null || prompt.length() == 0 ||
            defaultName == null || defaultName.length() == 0)
            throw new IllegalArgumentException();
        this.prompt = prompt;
        this.defaultName = defaultName;
}

NameCallback

Parameters:

prompt - the prompt used to request the information.

defaultName - the name to be used as the default name displayed with the prompt.

Throws:

IllegalArgumentException - if prompt is null, if prompt has a length of 0, if defaultName is null, or if defaultName has a length of 0.

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

Method from javax.security.auth.callback.NameCallback Summary:
getDefaultName, getName, getPrompt, setName

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

Method from javax.security.auth.callback.NameCallback Detail:
public String getDefaultName() { return defaultName; } Get the default name.
public String getName() { return inputName; } Get the retrieved name.
public String getPrompt() { return prompt; } Get the prompt.
public void setName(String name) { this.inputName = name; } Set the retrieved name.

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

 public String getDefaultName() {
        return defaultName;
}

 public String getName() {
        return inputName;
}

 public String getPrompt() {
        return prompt;
}

 public  void setName(String name) {
        this.inputName = name;
}