Package com.pingidentity.sdk.api.authn.spec

Class AuthnStateSpec.Builder<ModelType>

java.lang.Object

com.pingidentity.sdk.api.authn.spec.AuthnStateSpec.Builder<ModelType>

Type Parameters:

ModelType - The model type for the state (or Void if no model is associated with the state).

Enclosing class:

AuthnStateSpec<ModelType>

public static class AuthnStateSpec.Builder<ModelType>
extends Object

A fluent builder for AuthnStateSpec specs.

Since:

9.3

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AuthnStateSpec.Builder<ModelType>	action(AuthnActionSpec<?> action)	Add an action.
AuthnStateSpec<ModelType>	build()	Build the spec.
AuthnStateSpec.Builder<ModelType>	clearActions()	Clear the actions associated with the builder.
AuthnStateSpec.Builder<ModelType>	description(String description)	Set the description.
AuthnStateSpec.Builder<ModelType>	modelClass(Class<?> modelClass)	Set the model class.
void	removeAction(String id)	Remove a specific action from the builder, based on the action ID.
AuthnStateSpec.Builder<ModelType>	status(String status)	Set the status.
AuthnStateSpec.Builder<ModelType>	template(AuthnStateSpec<?> template, Class<ModelType> overrideModelClass)	Initialize the builder with the values from an existing spec, overriding the model class.
AuthnStateSpec.Builder<ModelType>	template(AuthnStateSpec<ModelType> template)	Initialize the builder with the values from an existing spec.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public AuthnStateSpec<ModelType> build()

Build the spec.

template

public AuthnStateSpec.Builder<ModelType> template(AuthnStateSpec<ModelType> template)

Initialize the builder with the values from an existing spec.

template

public AuthnStateSpec.Builder<ModelType> template(AuthnStateSpec<?> template,
                                                  Class<ModelType> overrideModelClass)

Initialize the builder with the values from an existing spec, overriding the model class.

Parameters:

template - An existing spec to use to initialize the builder.

overrideModelClass - A model class to override the one provided by the template.

Returns:

The resulting builder.

status

public AuthnStateSpec.Builder<ModelType> status(String status)

Set the status.

description

public AuthnStateSpec.Builder<ModelType> description(String description)

Set the description.

modelClass

public AuthnStateSpec.Builder<ModelType> modelClass(Class<?> modelClass)

Set the model class.

action

public AuthnStateSpec.Builder<ModelType> action(AuthnActionSpec<?> action)

Add an action.

clearActions

public AuthnStateSpec.Builder<ModelType> clearActions()

Clear the actions associated with the builder.

removeAction

public void removeAction(String id)

Remove a specific action from the builder, based on the action ID.