- 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
NameCallbackto thehandlemethod of aCallbackHandlerto retrieve name information.- Since:
- 1.4
- See Also:
CallbackHandler, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description NameCallback(String prompt)Construct aNameCallbackwith a prompt.NameCallback(String prompt, String defaultName)Construct aNameCallbackwith a prompt and default name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetDefaultName()Get the default name.StringgetName()Get the retrieved name.StringgetPrompt()Get the prompt.voidsetName(String name)Set the retrieved name.
-
-
-
Constructor Detail
-
NameCallback
public NameCallback(String prompt)
Construct aNameCallbackwith a prompt.- Parameters:
prompt- the prompt used to request the name.- Throws:
IllegalArgumentException- ifpromptis null or ifprompthas a length of 0.
-
NameCallback
public NameCallback(String prompt, String defaultName)
Construct aNameCallbackwith 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- ifpromptis null, ifprompthas a length of 0, ifdefaultNameis null, or ifdefaultNamehas 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
NameCallbackwas 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)
-
-