Package com.broadleafcommerce.shipping.service.integrations.shipengine.service

Class ShipEngineApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.core.NestedRuntimeException

org.springframework.web.reactive.function.client.WebClientException

com.broadleafcommerce.shipping.service.integrations.shipengine.service.ShipEngineApiException

All Implemented Interfaces:

Serializable

public class ShipEngineApiException
extends org.springframework.web.reactive.function.client.WebClientException

An exception that happens during communication with the ShipEngine API.

Author:

Cade Rea (cade-rea)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ShipEngineApiException(String msg, Throwable ex, org.springframework.http.HttpStatus status, ShipEngineApiErrorWrapper shipEngineApiErrorWrapper)
ShipEngineApiException(String msg, org.springframework.http.HttpStatus status, ShipEngineApiErrorWrapper shipEngineApiErrorWrapper)
ShipEngineApiException(Throwable ex, org.springframework.http.HttpStatus status, ShipEngineApiErrorWrapper shipEngineApiErrorWrapper)
ShipEngineApiException(org.springframework.http.HttpStatus status, ShipEngineApiErrorWrapper shipEngineApiErrorWrapper)

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Use the errors from the API response as the message.
ShipEngineApiErrorWrapper	getShipEngineApiErrorWrapper()
org.springframework.http.HttpStatus	getStatus()

Methods inherited from class org.springframework.core.NestedRuntimeException

contains, getMostSpecificCause, getRootCause

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

Constructor Detail

ShipEngineApiException

public ShipEngineApiException(String msg,
                              org.springframework.http.HttpStatus status,
                              ShipEngineApiErrorWrapper shipEngineApiErrorWrapper)

ShipEngineApiException

public ShipEngineApiException(org.springframework.http.HttpStatus status,
                              ShipEngineApiErrorWrapper shipEngineApiErrorWrapper)

ShipEngineApiException

public ShipEngineApiException(String msg,
                              Throwable ex,
                              org.springframework.http.HttpStatus status,
                              ShipEngineApiErrorWrapper shipEngineApiErrorWrapper)

ShipEngineApiException

public ShipEngineApiException(Throwable ex,
                              org.springframework.http.HttpStatus status,
                              ShipEngineApiErrorWrapper shipEngineApiErrorWrapper)

Method Detail

getMessage

public String getMessage()

Use the errors from the API response as the message.

Overrides:

getMessage in class org.springframework.core.NestedRuntimeException

Returns:

A joined String of all error messages from the ShipEngineApiErrorWrapper.

getStatus

public org.springframework.http.HttpStatus getStatus()

getShipEngineApiErrorWrapper

public ShipEngineApiErrorWrapper getShipEngineApiErrorWrapper()