- java.lang.Object
-
- javax.security.auth.callback.NameCallback
-
- All Implemented Interfaces:
- Serializable, Callback
public class NameCallback extends Object implements Callback, Serializable
Underlying security services instantiate and pass a
NameCallback
to thehandle
method of aCallbackHandler
to retrieve name information.- See Also:
CallbackHandler
, Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description NameCallback(String prompt)
Construct aNameCallback
with a prompt.NameCallback(String prompt, String defaultName)
Construct aNameCallback
with a prompt and default name.
-
-
-
Constructor Detail
-
NameCallback
public NameCallback(String prompt)
Construct aNameCallback
with a prompt.- Parameters:
prompt
- the prompt used to request the name.- Throws:
IllegalArgumentException
- ifprompt
is null or ifprompt
has a length of 0.
-
NameCallback
public NameCallback(String prompt, String defaultName)
Construct aNameCallback
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
- ifprompt
is null, ifprompt
has a length of 0, ifdefaultName
is null, or ifdefaultName
has a length of 0.
-
-
Method Detail
-
getPrompt
public String getPrompt()
Get the prompt.- Returns:
- the prompt.
-
getDefaultName
public String getDefaultName()
Get the default name.- Returns:
- the default name, or null if this
NameCallback
was not instantiated with adefaultName
.
-
setName
public void setName(String name)
Set the retrieved name.- Parameters:
name
- the retrieved name (which may be null).- See Also:
getName()
-
getName
public String getName()
Get the retrieved name.- Returns:
- the retrieved name (which may be null)
- See Also:
setName(java.lang.String)
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/security/auth/callback/NameCallback.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.