Package org.forgerock.openam.authentication.callbacks

Class ValidatedUsernameCallback

java.lang.Object

org.forgerock.openam.authentication.callbacks.AbstractValidatedCallback

org.forgerock.openam.authentication.callbacks.ValidatedUsernameCallback

All Implemented Interfaces:

Serializable, Callback

@Supported
public class ValidatedUsernameCallback
extends org.forgerock.openam.authentication.callbacks.AbstractValidatedCallback
implements Serializable

Callback to collect a username and validate it against IDM policy.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ValidatedUsernameCallback.Builder	A builder for constructing ValidatedUsernameCallback.

Method Summary

Modifier and Type	Method	Description
static ValidatedUsernameCallback.Builder	builder()	Get a builder for constructing a new ValidatedUsernameCallback.
String	getPrompt()	Get the prompt.
String	getUsername()	Get the retrieved username.
void	setUsername(String username)	Set the retrieved username.

Methods inherited from class java.lang.Object

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

Method Details

getPrompt

@Supported
public String getPrompt()

Get the prompt.

Returns:

the prompt.

setUsername

@Supported
public void setUsername(String username)

Set the retrieved username.

Parameters:

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

getUsername

@Supported
public String getUsername()

Get the retrieved username.

Returns:

the retrieved username (which may be null)

builder

@Supported
public static ValidatedUsernameCallback.Builder builder()

Get a builder for constructing a new ValidatedUsernameCallback.

Returns:

a new builder