public class AuthnErrorSpec extends Object
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.Modifier and Type | Class and Description |
---|---|
static class |
AuthnErrorSpec.Builder
A fluent builder for
AuthnErrorSpec specs. |
Constructor and Description |
---|
AuthnErrorSpec(int httpStatus,
String code,
String message)
Create a spec with the specified parameters.
|
Modifier and Type | Method and 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. |
public AuthnError.Builder makeInstanceBuilder()
AuthnError
builder initialized with the parameters
from this spec.public AuthnError makeInstance()
AuthnError
based on the parameters
in this spec.public int getHttpStatus()
public String getCode()
public String getMessage()
public String getUserMessageKey()
Copyright 2019 Ping Identity Corp. All rights reserved.