javax.security.auth.callback

Class TextInputCallback

public class TextInputCallback extends Object implements Callback, Serializable

Underlying security services instantiate and pass a TextInputCallback to the handle() method of a {@link CallbackHandler} to retrieve generic text information.

See Also: CallbackHandler

Constructor Summary
	TextInputCallback(String prompt) Construct a `TextInputCallback` with a prompt.
	TextInputCallback(String prompt, String defaultText) Construct a `TextInputCallback` with a prompt and default input value.

Method Summary
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.

Constructor Detail

TextInputCallback

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.

TextInputCallback

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.

Method Detail

getDefaultText

public String getDefaultText()

Get the default text.

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

getPrompt

public String getPrompt()

Get the prompt.

Returns: the prompt.

getText

public String getText()

Get the retrieved text.

Returns: the retrieved text, which may be null.

setText

public void setText(String text)

Set the retrieved text.

Parameters: text the retrieved text, which may be null.