ErrorResponse (HERE OAuth Client 0.4.27 API)

java.lang.Object
- com.here.account.oauth2.ErrorResponse

```
public class ErrorResponse
extends Object
```
The POJO representation of an OAuth2.0 HERE authorization server error response. See also the OAuth2.0 Error Response section.

Author:

kmccrack

Constructor Summary

Constructors
Constructor and Description
`ErrorResponse()`
`ErrorResponse(String error, String errorDescription, String errorId, Integer httpStatus, Integer errorCode, String message)`
`ErrorResponse(String error, String errorDescription, String errorId, Integer httpStatus, Integer errorCode, String message, String title, Integer status, String code, String cause, String action, String correlationId)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAction()` The action for this error response.
`String`	`getCause()` The cause for this error response.
`String`	`getCode()` The error code for this error response.
`String`	`getCorrelationId()` The unique request correlation id, useful for support questions, or tracking purposes.
`String`	`getError()` The error value.
`Integer`	`getErrorCode()` The errorCode.
`String`	`getErrorDescription()` The error_description value.
`String`	`getErrorId()` The errorId.
`Integer`	`getHttpStatus()` The httpStatus.
`String`	`getMessage()` The message.
`Integer`	`getStatus()` The HTTP status code for this error response.
`String`	`getTitle()` The title for this error response.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ErrorResponse
```
public ErrorResponse()
```
  - ErrorResponse
```
public ErrorResponse(String error,
                     String errorDescription,
                     String errorId,
                     Integer httpStatus,
                     Integer errorCode,
                     String message)
```
  - ErrorResponse
```
public ErrorResponse(String error,
                     String errorDescription,
                     String errorId,
                     Integer httpStatus,
                     Integer errorCode,
                     String message,
                     String title,
                     Integer status,
                     String code,
                     String cause,
                     String action,
                     String correlationId)
```
- Method Detail
  - getError
```
public String getError()
```
    The error value. From OAuth2.0 Error Response section, the following parameter: error REQUIRED. A single ASCII [USASCII] error code from the following: invalid_request The request is missing a required parameter, includes an unsupported parameter value (other than grant type), repeats a parameter, includes multiple credentials, utilizes more than one mechanism for authenticating the client, or is otherwise malformed. invalid_client Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method). The authorization server MAY return an HTTP 401 (Unauthorized) status code to indicate which HTTP authentication schemes are supported. If the client attempted to authenticate via the "Authorization" request header field, the authorization server MUST respond with an HTTP 401 (Unauthorized) status code and include the "WWW-Authenticate" response header field matching the authentication scheme used by the client. invalid_grant The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client. unauthorized_client The authenticated client is not authorized to use this authorization grant type. unsupported_grant_type The authorization grant type is not supported by the authorization server. invalid_scope The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner. Values for the "error" parameter MUST NOT include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
    
    Returns:
    
    the error
  - getErrorDescription
```
public String getErrorDescription()
```
    The error_description value. From OAuth2.0 Error Response section, the following parameter: error_description OPTIONAL. Human-readable ASCII [USASCII] text providing additional information, used to assist the client developer in understanding the error that occurred. Values for the "error_description" parameter MUST NOT include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
    
    Returns:
    
    the error description
  - getHttpStatus
```
public Integer getHttpStatus()
```
    The httpStatus. The numeric HTTP status code. See also the HTTP Response Status Codes section.
    This property is a HERE extension to RFC6749 providing additional data.
    
    Returns:
    
    the httpStatus
  - getErrorId
```
public String getErrorId()
```
    The errorId. A unique error identifier, useful for support questions, or tracking purposes.
    This property is a HERE extension to RFC6749 providing additional data.
    
    Returns:
    
    the errorId
  - getErrorCode
```
public Integer getErrorCode()
```
    The errorCode. A more detailed categorized code for the error, specific to the HERE authorization server semantics.
    This property is a HERE extension to RFC6749 providing additional data.
    
    Returns:
    
    the errorCode
  - getMessage
```
public String getMessage()
```
    The message. A potentially-human-readable message describing the error. No machine or automated code should process or interpret this value.
    This property is a HERE extension to RFC6749 providing additional data.
    
    Returns:
    
    the message
  - getTitle
```
public String getTitle()
```
    The title for this error response.
    This property is a HERE extension to RFC6749 providing additional data.
    
    Returns:
    
    the title
  - getStatus
```
public Integer getStatus()
```
    The HTTP status code for this error response.
    This property is a HERE extension to RFC6749 providing additional data.
    
    Returns:
    
    the status
  - getCode
```
public String getCode()
```
    The error code for this error response.
    This property is a HERE extension to RFC6749 providing additional data.
    
    Returns:
    
    the error code
  - getCause
```
public String getCause()
```
    The cause for this error response.
    This property is a HERE extension to RFC6749 providing additional data.
    
    Returns:
    
    the cause for this error response
  - getAction
```
public String getAction()
```
    The action for this error response. Actionable instructions for the user.
    This property is a HERE extension to RFC6749 providing additional data.
    
    Returns:
    
    the action for this error response
  - getCorrelationId
```
public String getCorrelationId()
```
    The unique request correlation id, useful for support questions, or tracking purposes.
    This property is a HERE extension to RFC6749 providing additional data.
    
    Returns:
    
    the correlationId
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ErrorResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ErrorResponse

ErrorResponse

ErrorResponse

Method Detail

getError

getErrorDescription

getHttpStatus

getErrorId

getErrorCode

getMessage

getTitle

getStatus

getCode

getCause

getAction

getCorrelationId

equals

hashCode

toString