public class

NameCallback

extends Object
implements Serializable Callback
java.lang.Object
   ↳ javax.security.auth.callback.NameCallback

Class Overview

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

See Also

Summary

Public Constructors
NameCallback(String prompt)
Construct a NameCallback with a prompt.
NameCallback(String prompt, String defaultName)
Construct a NameCallback with a prompt and default name.
Public Methods
String getDefaultName()
Get the default name.
String getName()
Get the retrieved name.
String getPrompt()
Get the prompt.
void setName(String name)
Set the retrieved name.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public NameCallback (String 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.

public NameCallback (String prompt, String 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.

Public Methods

public String getDefaultName ()

Get the default name.

Returns
  • the default name, or null if this NameCallback was not instantiated with a defaultName.

public String getName ()

Get the retrieved name.

Returns
  • the retrieved name (which may be null)
See Also

public String getPrompt ()

Get the prompt.

Returns
  • the prompt.

public void setName (String name)

Set the retrieved name.

Parameters
name the retrieved name (which may be null).
See Also