This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.security.auth.callback
class NameCallback

java.lang.Object extended by javax.security.auth.callback.NameCallback
All Implemented Interfaces:
Serializable, Callback

Most common way to construct:

NameCallback nameCallback = new NameCallback("");

Based on 12 examples


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.


Constructor Summary

          Construct a NameCallback with a prompt.
NameCallback(String prompt, String defaultName)

          Construct a NameCallback with a prompt and default name.
 
Method Summary
 String

          Get the default name.
 String

          Get the retrieved name.
 String

          Get the prompt.
 void

          Set the retrieved name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NameCallback

public NameCallback(String prompt)
Construct a NameCallback with a prompt.

Parameters:
prompt - the prompt used to request the name.

NameCallback

public NameCallback(String prompt,
                    String defaultName)
Construct a NameCallback 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.
Method Detail

getDefaultName

public String getDefaultName()
Get the default name.

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

getName

public String getName()
Get the retrieved name.

Returns:
the retrieved name (which may be null)

getPrompt

public String getPrompt()
Get the prompt.

Returns:
the prompt.

setName

public void setName(String name)
Set the retrieved name.

Parameters:
name - the retrieved name (which may be null).


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.