compact1, compact2, compact3
javax.security.auth.callback
Class TextInputCallback
- java.lang.Object
-
- javax.security.auth.callback.TextInputCallback
-
- All Implemented Interfaces:
- Serializable, Callback
- Direct Known Subclasses:
- RealmCallback
public class TextInputCallback extends Object implements Callback, Serializable
Underlying security services instantiate and pass a
TextInputCallback
to thehandle
method of aCallbackHandler
to retrieve generic text information.- See Also:
-
CallbackHandler
, Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description TextInputCallback(String prompt)
Construct aTextInputCallback
with a prompt.TextInputCallback(String prompt, String defaultText)
Construct aTextInputCallback
with a prompt and default input value.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description 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 aTextInputCallback
with a prompt.- Parameters:
-
prompt
- the prompt used to request the information. - Throws:
-
IllegalArgumentException
- ifprompt
is null or ifprompt
has a length of 0.
TextInputCallback
public TextInputCallback(String prompt, String defaultText)
Construct aTextInputCallback
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
- ifprompt
is null, ifprompt
has a length of 0, ifdefaultText
is null or ifdefaultText
has a length of 0.
-
Method Detail
getPrompt
public String getPrompt()
Get the prompt.- Returns:
- the prompt.
getDefaultText
public String getDefaultText()
Get the default text.- Returns:
-
the default text, or null if this
TextInputCallback
was not instantiated withdefaultText
.
setText
public void setText(String text)
Set the retrieved text.- Parameters:
-
text
- the retrieved text, which may be null. - See Also:
-
getText()
getText
public String getText()
Get the retrieved text.- Returns:
- the retrieved text, which may be null.
- See Also:
-
setText(java.lang.String)
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.