com.pingidentity.sdk.api.authn.spec

Class AuthnActionSpec.Builder<ModelType>

java.lang.Object

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

Type Parameters:

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

Enclosing class:

AuthnActionSpec<ModelType>

public static class AuthnActionSpec.Builder<ModelType>
extends Object

A fluent builder for AuthnActionSpec specs.

Since:

9.3

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AuthnActionSpec<ModelType>	build() Build the spec.
AuthnActionSpec.Builder<ModelType>	description(String description) Set the action description, for API documentation.
AuthnActionSpec.Builder<ModelType>	error(AuthnErrorSpec errorSpec) Add an error spec.
AuthnActionSpec.Builder<ModelType>	errorDetail(AuthnErrorDetailSpec errorDetailSpec) Add an error detail spec.
AuthnActionSpec.Builder<ModelType>	errorDetails(Collection<AuthnErrorDetailSpec> details) Add a collection of error detail specs.
AuthnActionSpec.Builder<ModelType>	id(String id) Set the action ID.
AuthnActionSpec.Builder<ModelType>	modelClass(Class<ModelType> cls) Set the model class.
AuthnActionSpec.Builder<ModelType>	template(AuthnActionSpec<?> template, Class<ModelType> overrideModelClass) Initialize the builder with the values from an existing spec, overriding the model class.
AuthnActionSpec.Builder<ModelType>	template(AuthnActionSpec<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 AuthnActionSpec<ModelType> build()

Build the spec.

template

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

Initialize the builder with the values from an existing spec.

template

public AuthnActionSpec.Builder<ModelType> template(AuthnActionSpec<?> 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.

id

public AuthnActionSpec.Builder<ModelType> id(String id)

Set the action ID.

description

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

Set the action description, for API documentation.

modelClass

public AuthnActionSpec.Builder<ModelType> modelClass(Class<ModelType> cls)

Set the model class.

error

public AuthnActionSpec.Builder<ModelType> error(AuthnErrorSpec errorSpec)

Add an error spec.

errorDetail

public AuthnActionSpec.Builder<ModelType> errorDetail(AuthnErrorDetailSpec errorDetailSpec)

Add an error detail spec. The error detail spec must have a parent code specified and a parent error spec with that code must already have been added.

errorDetails

public AuthnActionSpec.Builder<ModelType> errorDetails(Collection<AuthnErrorDetailSpec> details)

Add a collection of error detail specs. See errorDetail(AuthnErrorDetailSpec) for further information.