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

Class AuthnErrorSpec

java.lang.Object

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

public class AuthnErrorSpec
extends Object

A class which acts as a template for AuthnError instances. This allows common definitions for authentication errors to be shared across plugins. Once created, objects of this class are immutable. Objects of this class are not normally returned in API responses. Instead, you create an AuthnError instance using the makeInstance() or makeInstanceBuilder() methods.

Since:

9.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthnErrorSpec.Builder	A fluent builder for AuthnErrorSpec specs.

Constructor Summary

Constructors

Constructor	Description
AuthnErrorSpec(int httpStatus, String code, String message)	Create a spec with the specified parameters.

Method Summary

Modifier and Type	Method	Description
String	getCode()	Get the error code.
int	getHttpStatus()	Get the HTTP status for this error.
String	getMessage()	Get the developer-facing error message.
String	getUserMessageKey()	Get the user-facing error message key.
AuthnError	makeInstance()	Get an instance of AuthnError based on the parameters in this spec.
AuthnError.Builder	makeInstanceBuilder()	Get an AuthnError builder initialized with the parameters from this spec.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthnErrorSpec

public AuthnErrorSpec(int httpStatus,
 String code,
 String message)

Create a spec with the specified parameters.

Parameters:

httpStatus - The HTTP status code for the error.

code - The error code.

message - The error message.

Method Details

makeInstanceBuilder

public AuthnError.Builder makeInstanceBuilder()

Get an AuthnError builder initialized with the parameters from this spec.

makeInstance

public AuthnError makeInstance()

Get an instance of AuthnError based on the parameters in this spec.

getHttpStatus

public int getHttpStatus()

Get the HTTP status for this error.

getCode

public String getCode()

Get the error code.

getMessage

public String getMessage()

Get the developer-facing error message.

getUserMessageKey

public String getUserMessageKey()

Get 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.