Class NameCallback

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 the handle method of a CallbackHandler to retrieve name information.

Since:

1.4

See Also:

Constructor Summary

Constructor	Description
`NameCallback(String prompt)`	Construct a `NameCallback` with a prompt.
`NameCallback(String prompt, String defaultName)`	Construct a `NameCallback` with a prompt and default name.

Method Summary

Modifier and Type	Method	Description
`String`	`getDefaultName()`	Get the default name.
`String`	`getName()`	Get the retrieved name.
`String`	`getPrompt()`	Get the prompt.
`void`	`setName(String name)`	Set the retrieved name.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NameCallback

public NameCallback(String prompt)

Construct a NameCallback with a prompt.

Parameters:: prompt - the prompt used to request the name.
Throws:: IllegalArgumentException - if prompt is null or if prompt has a length of 0.

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.
Throws:: IllegalArgumentException - if prompt is null, if prompt has a length of 0, if defaultName is null, or if defaultName has a length of 0.

Method Details

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 a defaultName.

setName

public void setName(String name)

Set the retrieved name.

Parameters:

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

See Also:

getName

public String getName()

Get the retrieved name.

Returns:

the retrieved name (which may be null)

See Also:

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/javax/security/auth/callback/NameCallback.html