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

Class AuthnErrorDetailSpec.Builder

java.lang.Object

com.pingidentity.sdk.api.authn.spec.AuthnErrorDetailSpec.Builder

Enclosing class:

AuthnErrorDetailSpec

public static class AuthnErrorDetailSpec.Builder
extends Object

A fluent builder for AuthnErrorDetailSpec specs.

Since:

9.3

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AuthnErrorDetailSpec	build()	Build the spec.
AuthnErrorDetailSpec.Builder	code(String code)	Set the error code.
AuthnErrorDetailSpec.Builder	message(String message)	Set the developer-facing error message.
AuthnErrorDetailSpec.Builder	parentCode(String parentCode)	Set the parent error code.
AuthnErrorDetailSpec.Builder	target(String target)	Set the JSON target field.
AuthnErrorDetailSpec.Builder	userMessageKey(String messageKey)	Set the user-facing error message key.

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 AuthnErrorDetailSpec build()

Build the spec.

code

public AuthnErrorDetailSpec.Builder code(String code)

Set the error code.

message

public AuthnErrorDetailSpec.Builder message(String message)

Set the developer-facing error message.

userMessageKey

public AuthnErrorDetailSpec.Builder userMessageKey(String messageKey)

Set the user-facing error message key. A message key should be provided for any error likely to be displayed to the end user, with a corresponding error message specified in authn-api-messages.properties.

target

public AuthnErrorDetailSpec.Builder target(String target)

Set the JSON target field.

parentCode

public AuthnErrorDetailSpec.Builder parentCode(String parentCode)

Set the parent error code.