Package com.netflix.spinnaker.kork.retrofit.exceptions

Class SpinnakerHttpException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.netflix.spinnaker.kork.exceptions.SpinnakerException

com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerServerException

com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerHttpException

All Implemented Interfaces:

com.netflix.spinnaker.kork.exceptions.HasAdditionalAttributes, Serializable

public class SpinnakerHttpException
extends SpinnakerServerException

An exception that exposes the Response of a given HTTP RetrofitError or Response if retrofit 2.x used and a detail message that extracts useful information from the Response or Response. Both Response and Response can't be set together.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SpinnakerHttpException(String message, SpinnakerHttpException cause)	Construct a SpinnakerHttpException with a specified message.
SpinnakerHttpException(retrofit.RetrofitError e)	Construct a SpinnakerHttpException corresponding to a RetrofitError.
SpinnakerHttpException(retrofit2.Response<?> retrofit2Response, retrofit2.Retrofit retrofit)	The constructor handles the HTTP retrofit2 exception, similar to retrofit logic.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.HttpHeaders	getHeaders()
String	getMessage()
String	getReason()
Map<String,Object>	getResponseBody()
int	getResponseCode()
SpinnakerHttpException	newInstance(String message)

Methods inherited from class com.netflix.spinnaker.kork.exceptions.SpinnakerException

getRetryable, getUserMessage, setRetryable

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

Methods inherited from interface com.netflix.spinnaker.kork.exceptions.HasAdditionalAttributes

getAdditionalAttributes

Constructor Details

SpinnakerHttpException

public SpinnakerHttpException(retrofit.RetrofitError e)

Construct a SpinnakerHttpException corresponding to a RetrofitError.

SpinnakerHttpException

public SpinnakerHttpException(retrofit2.Response<?> retrofit2Response,
 retrofit2.Retrofit retrofit)

The constructor handles the HTTP retrofit2 exception, similar to retrofit logic. It is used with ErrorHandlingExecutorCallAdapterFactory.

SpinnakerHttpException

public SpinnakerHttpException(String message,
 SpinnakerHttpException cause)

Construct a SpinnakerHttpException with a specified message. This allows code to catch a SpinnakerHttpException and throw a new one with a custom message, while still allowing SpinnakerRetrofitExceptionHandlers to handle the exception and respond with the appropriate http status code.

Validating only one of Response or Response is set at a time using Preconditions.checkState.

Parameters:

message - the message

cause - the cause. Note that this is required (i.e. can't be null) since in the absence of a cause or a RetrofitError that provides the cause, SpinnakerHttpException is likely not the appropriate exception class to use.

Method Details

getResponseCode

public int getResponseCode()

getHeaders

@Nonnull
public org.springframework.http.HttpHeaders getHeaders()

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

newInstance

public SpinnakerHttpException newInstance(String message)

Overrides:

newInstance in class SpinnakerServerException

getResponseBody

public Map<String,Object> getResponseBody()

getReason

public String getReason()