io.github.mainstringargs.abstracts.rest.exception

Class AbstractAPIRequestException

java.lang.Object

java.lang.Throwable

java.lang.Exception

io.github.mainstringargs.abstracts.rest.exception.AbstractAPIRequestException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AlpacaAPIRequestException, PolygonAPIRequestException

public abstract class AbstractAPIRequestException
extends java.lang.Exception

The type Abstract API request exception.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	apiName The Api name.
protected int	apiResponseCode The Api response code.
protected java.lang.String	apiResponseMessage The Api response message.
protected static java.lang.String	CODE_KEY The constant CODE_KEY.
protected com.mashape.unirest.http.HttpResponse<java.io.InputStream>	httpResponse The Http response.
protected static java.lang.String	MESSAGE_KEY The constant MESSAGE_KEY.
protected int	requestStatusCode The Request code.
protected java.lang.String	requestStatusText The Request status text.

Constructor Summary

Constructors

Constructor and Description
AbstractAPIRequestException(java.lang.String apiName, com.mashape.unirest.http.HttpResponse<java.io.InputStream> httpResponse) Instantiates a new Abstract api request exception.

Method Summary

Modifier and Type	Method and Description
int	getAPIResponseCode() Gets api response code.
java.lang.String	getAPIResponseMessage() Gets api response message.
java.lang.String	getMessage()
int	getRequestStatusCode() Gets request status code.
java.lang.String	getRequestStatusText() Gets request status text.
protected abstract void	parseAPIExceptionMessage() Parse the API exception message to populate the following fields:
protected void	parseStandardAPIExceptionResponse() Parse a standard API exception response.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CODE_KEY

protected static final java.lang.String CODE_KEY

The constant CODE_KEY.

See Also:

Constant Field Values

MESSAGE_KEY

protected static final java.lang.String MESSAGE_KEY

The constant MESSAGE_KEY.

See Also:

Constant Field Values

apiName

protected final java.lang.String apiName

The Api name.

httpResponse

protected com.mashape.unirest.http.HttpResponse<java.io.InputStream> httpResponse

The Http response.

requestStatusCode

protected int requestStatusCode

The Request code.

requestStatusText

protected java.lang.String requestStatusText

The Request status text.

apiResponseCode

protected int apiResponseCode

The Api response code.

apiResponseMessage

protected java.lang.String apiResponseMessage

The Api response message.

Constructor Detail

AbstractAPIRequestException

public AbstractAPIRequestException(java.lang.String apiName,
                                   com.mashape.unirest.http.HttpResponse<java.io.InputStream> httpResponse)

Instantiates a new Abstract api request exception.

Parameters:

apiName - the api name

httpResponse - the http response

Method Detail

parseAPIExceptionMessage

protected abstract void parseAPIExceptionMessage()

Parse the API exception message to populate the following fields:

requestStatusCode, requestStatusText, apiResponseCode, apiResponseMessage

parseStandardAPIExceptionResponse

protected void parseStandardAPIExceptionResponse()

Parse a standard API exception response.

The following format is parsed:

  {
     "code": 40010001,
     "message": "Error message"
  }
 

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getRequestStatusCode

public int getRequestStatusCode()

Gets request status code.

Returns:

the request status code

getRequestStatusText

public java.lang.String getRequestStatusText()

Gets request status text.

Returns:

the request status text

getAPIResponseCode

public int getAPIResponseCode()

Gets api response code.

Returns:

the api response code

getAPIResponseMessage

public java.lang.String getAPIResponseMessage()

Gets api response message.

Returns:

the api response message