public class

TextInputCallback

extends Object
implements Serializable Callback
java.lang.Object
   ↳ javax.security.auth.callback.TextInputCallback
Known Direct Subclasses

Class Overview

Underlying security services instantiate and pass a TextInputCallback to the handle method of a CallbackHandler to retrieve generic text information.

See Also

Summary

Public Constructors
TextInputCallback(String prompt)
Construct a TextInputCallback with a prompt.
TextInputCallback(String prompt, String defaultText)
Construct a TextInputCallback with a prompt and default input value.
Public Methods
String getDefaultText()
Get the default text.
String getPrompt()
Get the prompt.
String getText()
Get the retrieved text.
void setText(String text)
Set the retrieved text.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public TextInputCallback (String prompt)

Construct a TextInputCallback with a prompt.

Parameters
prompt the prompt used to request the information.
Throws
IllegalArgumentException if prompt is null or if prompt has a length of 0.

public TextInputCallback (String prompt, String defaultText)

Construct a TextInputCallback with a prompt and default input value.

Parameters
prompt the prompt used to request the information.

defaultText the text to be used as the default text displayed with the prompt.
Throws
IllegalArgumentException if prompt is null, if prompt has a length of 0, if defaultText is null or if defaultText has a length of 0.

Public Methods

public String getDefaultText ()

Get the default text.

Returns
  • the default text, or null if this TextInputCallback was not instantiated with defaultText.

public String getPrompt ()

Get the prompt.

Returns
  • the prompt.

public String getText ()

Get the retrieved text.

Returns
  • the retrieved text, which may be null.
See Also

public void setText (String text)

Set the retrieved text.

Parameters
text the retrieved text, which may be null.
See Also