public class AuthnErrorDetailSpec extends Object
AuthnErrorDetail
instances.
This allows common definitions for authentication error details 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
AuthnErrorDetail
instance using the makeInstance()
or makeInstanceBuilder()
methods.Modifier and Type | Class and Description |
---|---|
static class |
AuthnErrorDetailSpec.Builder
A fluent builder for
AuthnErrorDetailSpec specs. |
Constructor and Description |
---|
AuthnErrorDetailSpec(String parentCode,
String code,
String message)
Create a spec with the specified parameters.
|
Modifier and Type | Method and Description |
---|---|
String |
getCode()
Get the error code.
|
String |
getMessage()
Get the developer-facing error message.
|
String |
getParentCode()
Get the parent error code.
|
String |
getTarget()
If the error applies to a specific field in an incoming API request, this identifies the name of the JSON field.
|
String |
getUserMessageKey()
Get the user-facing error message key.
|
AuthnErrorDetail |
makeInstance()
Get an instance of
AuthnErrorDetail based on the parameters
in this spec. |
AuthnErrorDetail.Builder |
makeInstanceBuilder()
Get an
AuthnErrorDetail builder initialized with the parameters
from this spec. |
public AuthnErrorDetail.Builder makeInstanceBuilder()
AuthnErrorDetail
builder initialized with the parameters
from this spec.public AuthnErrorDetail makeInstance()
AuthnErrorDetail
based on the parameters
in this spec.public String getParentCode()
public String getCode()
public String getMessage()
public String getUserMessageKey()
public String getTarget()
Copyright 2019 Ping Identity Corp. All rights reserved.