Package org.forgerock.openam.authentication.callbacks

Class StringAttributeInputCallback.StringAttributeInputCallbackBuilder

java.lang.Object

org.forgerock.openam.authentication.callbacks.StringAttributeInputCallback.StringAttributeInputCallbackBuilder

Enclosing class:

StringAttributeInputCallback

@Supported
public static class StringAttributeInputCallback.StringAttributeInputCallbackBuilder
extends Object

Builder object for a StringAttributeInputCallback.

Method Summary

Modifier and Type	Method	Description
StringAttributeInputCallback	build()	Finalize the construction process and return the newly constructed callback.
StringAttributeInputCallback.StringAttributeInputCallbackBuilder	withName(String name)	Set the name of the attribute.
StringAttributeInputCallback.StringAttributeInputCallbackBuilder	withPolicies(JsonValue policies)	Set the list of policies for this attribute.
StringAttributeInputCallback.StringAttributeInputCallbackBuilder	withPrompt(String prompt)	Set the prompt of the attribute.
StringAttributeInputCallback.StringAttributeInputCallbackBuilder	withRequired(boolean required)	Set whether the attribute is required.
StringAttributeInputCallback.StringAttributeInputCallbackBuilder	withValidateOnly(boolean validateOnly)	Set whether the tree should not advance when validation succeeds.
StringAttributeInputCallback.StringAttributeInputCallbackBuilder	withValue(String value)	Set the existing value of the attribute.

Methods inherited from class java.lang.Object

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

Method Details

withName

@Supported
public StringAttributeInputCallback.StringAttributeInputCallbackBuilder withName(String name)

Set the name of the attribute.

Parameters:

name - the name of the attribute

Returns:

this builder

withPrompt

@Supported
public StringAttributeInputCallback.StringAttributeInputCallbackBuilder withPrompt(String prompt)

Set the prompt of the attribute.

Parameters:

prompt - the prompt of the attribute

Returns:

this builder

withValue

@Supported
public StringAttributeInputCallback.StringAttributeInputCallbackBuilder withValue(String value)

Set the existing value of the attribute.

Parameters:

value - the existing value of the attribute

Returns:

this builder

withRequired

@Supported
public StringAttributeInputCallback.StringAttributeInputCallbackBuilder withRequired(boolean required)

Set whether the attribute is required.

Parameters:

required - whether the attribute is required

Returns:

this builder

withPolicies

@Supported
public StringAttributeInputCallback.StringAttributeInputCallbackBuilder withPolicies(JsonValue policies)

Set the list of policies for this attribute.

Parameters:

policies - the list of policies that apply to this attribute

Returns:

this builder

withValidateOnly

@Supported
public StringAttributeInputCallback.StringAttributeInputCallbackBuilder withValidateOnly(boolean validateOnly)

Set whether the tree should not advance when validation succeeds.

Parameters:

validateOnly - set to true iff successful validation should not result in advancing the tree

Returns:

this builder

build

@Supported
public StringAttributeInputCallback build()

Finalize the construction process and return the newly constructed callback.

Returns:

the constructed callback