@NotExtensible public final class StatusResult extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
StatusResult.Builder
Builder class to build an instance of StatusResult.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o) |
java.lang.String |
getDiagnosticMessage()
Gets the message that will be only be included in the trace log
for diagnostic purposes.
|
java.lang.String |
getError()
Retrieve the error code to return if an error occurred while processing the
authentication request or
null if an error did not occur. |
java.lang.String |
getErrorDetail()
Retrieve the message to return if an error occurred while processing
the authentication request describing the details of the error
or
null if an error did not occur. |
java.lang.String |
getResponseParams()
Retrieve the JSON object specifying the parameters to return that may be
used to initiate the authentication process.
|
int |
hashCode() |
boolean |
isReady()
Indicates whether this authenticator is ready to process authentication
requests.
|
static StatusResult.Builder |
notReady()
Create a new builder for a not ready response.
|
static StatusResult.Builder |
notReady(java.lang.String error,
java.lang.String errorDetail)
Create a new builder for an error response.
|
static StatusResult.Builder |
ready()
Create a new builder for a ready response.
|
java.lang.String |
toString() |
public static StatusResult.Builder ready()
public static StatusResult.Builder notReady()
public static StatusResult.Builder notReady(java.lang.String error, java.lang.String errorDetail)
Since this response is visible to the client in a potentially unauthenticated context, the authenticator should not expose any sensitive user or server information in the error response.
error
- The error code.errorDetail
- The details about the error.public boolean isReady()
true
if this authenticator is ready, or
false
otherwise.public java.lang.String getError()
null
if an error did not occur.public java.lang.String getErrorDetail()
null
if an error did not occur.public java.lang.String getResponseParams()
null
.public java.lang.String getDiagnosticMessage()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object