FileDocCategorySizeDatePackage
NameCallback.javaAPI DocJava SE 5 API3000Fri Aug 26 14:57:48 BST 2005javax.security.auth.callback

NameCallback

public class NameCallback extends Object implements Callback, Serializable

Underlying security services instantiate and pass a NameCallback to the handle method of a CallbackHandler to retrieve name information.

version
1.14, 12/19/03
see
javax.security.auth.callback.CallbackHandler

Fields Summary
private static final long
serialVersionUID
private String
prompt
private String
defaultName
private String
inputName
Constructors Summary
public NameCallback(String prompt)
Construct a NameCallback with a prompt.

param
prompt the prompt used to request the name.
exception
IllegalArgumentException if prompt is null or if prompt has a length of 0.


                          			            
       
	if (prompt == null || prompt.length() == 0)
	    throw new IllegalArgumentException();
	this.prompt = prompt;
public NameCallback(String prompt, String defaultName)
Construct a NameCallback with a prompt and default name.

param
prompt the prompt used to request the information.

param
defaultName the name to be used as the default name displayed with the prompt.
exception
IllegalArgumentException if prompt is null, if prompt has a length of 0, if defaultName is null, or if defaultName has a length of 0.

	if (prompt == null || prompt.length() == 0 ||
	    defaultName == null || defaultName.length() == 0)
	    throw new IllegalArgumentException();

	this.prompt = prompt;
	this.defaultName = defaultName;
Methods Summary
public java.lang.StringgetDefaultName()
Get the default name.

return
the default name, or null if this NameCallback was not instantiated with a defaultName.

	return defaultName;
public java.lang.StringgetName()
Get the retrieved name.

return
the retrieved name (which may be null)
see
#setName

	return inputName;
public java.lang.StringgetPrompt()
Get the prompt.

return
the prompt.

	return prompt;
public voidsetName(java.lang.String name)
Set the retrieved name.

param
name the retrieved name (which may be null).
see
#getName

	this.inputName = name;