com.pingidentity.pa.sdk.policy.error

Interface ErrorInfo

All Known Implementing Classes:

AccessException

public interface ErrorInfo

Information about an error that is used to generate an HTTP response.

Method Summary

Modifier and Type	Method and Description
Throwable	getErrorCause() Retrieves the Throwable that caused the error.
LocalizedMessage	getErrorMessage() Retrieves the primary error message to be presented to the end-user in the body of the response, which may be localized for the current locale.
HttpStatus	getErrorStatus() Retrieves the response status, which encapsulates both the status code (e.g.

Method Detail

getErrorStatus

HttpStatus getErrorStatus()

Retrieves the response status, which encapsulates both the status code (e.g. 4xx, 5xx) and reason phrase.

Returns:

the HTTP error response status

getErrorMessage

LocalizedMessage getErrorMessage()

Retrieves the primary error message to be presented to the end-user in the body of the response, which may be localized for the current locale.

Returns:

the error message, or null if not available

getErrorCause

Throwable getErrorCause()

Retrieves the Throwable that caused the error.

Returns:

the cause of the error, or null if the cause is nonexistent or unknown