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

Class AuthnErrorSpec.Builder

java.lang.Object

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

Enclosing class:

AuthnErrorSpec

public static class AuthnErrorSpec.Builder
extends Object

A fluent builder for AuthnErrorSpec specs.

Since:

9.3

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AuthnErrorSpec	build()	Build the spec.
AuthnErrorSpec.Builder	code(String code)	Set the error code.
AuthnErrorSpec.Builder	httpStatus(int status)	Set the HTTP status code.
AuthnErrorSpec.Builder	message(String message)	Set the developer-facing error message.
AuthnErrorSpec.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 Details

Builder

public Builder()

Method Details

build

public AuthnErrorSpec build()

Build the spec.

httpStatus

public AuthnErrorSpec.Builder httpStatus(int status)

Set the HTTP status code.

code

public AuthnErrorSpec.Builder code(String code)

Set the error code.

message

public AuthnErrorSpec.Builder message(String message)

Set the developer-facing error message.

userMessageKey

public AuthnErrorSpec.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.