feign

Class RetryableException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

feign.FeignException

feign.RetryableException

All Implemented Interfaces:

Serializable

public class RetryableException
extends FeignException

This exception is raised when the Response is deemed to be retryable, typically via an ErrorDecoder when the status is 503.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class feign.FeignException

FeignException.BadGateway, FeignException.BadRequest, FeignException.Conflict, FeignException.FeignClientException, FeignException.FeignServerException, FeignException.Forbidden, FeignException.GatewayTimeout, FeignException.Gone, FeignException.InternalServerError, FeignException.MethodNotAllowed, FeignException.NotAcceptable, FeignException.NotFound, FeignException.NotImplemented, FeignException.ServiceUnavailable, FeignException.TooManyRequests, FeignException.Unauthorized, FeignException.UnprocessableEntity, FeignException.UnsupportedMediaType

Constructor Summary

Constructors

Constructor and Description
RetryableException(int status, String message, Request.HttpMethod httpMethod, Date retryAfter, Request request) Deprecated. Use #RetryableException(int, String, HttpMethod, Long, Request) instead. This constructor uses Date for retryAfter, which has been replaced by Long.
RetryableException(int status, String message, Request.HttpMethod httpMethod, Date retryAfter, Request request, byte[] responseBody, Map<String,Collection<String>> responseHeaders) Deprecated. Use #RetryableException(int, String, HttpMethod, Long, Request, byte[], Map) instead. This constructor uses Date for retryAfter, which has been replaced by Long.
RetryableException(int status, String message, Request.HttpMethod httpMethod, Long retryAfter, Request request) Represents a retryable exception when Retry-After information is available.
RetryableException(int status, String message, Request.HttpMethod httpMethod, Long retryAfter, Request request, byte[] responseBody, Map<String,Collection<String>> responseHeaders) Represents a retryable exception with response body and headers.
RetryableException(int status, String message, Request.HttpMethod httpMethod, Request request) Represents a non-retryable exception when Retry-After information is explicitly not provided.
RetryableException(int status, String message, Request.HttpMethod httpMethod, Throwable cause, Date retryAfter, Request request) Deprecated. Use #RetryableException(int, String, HttpMethod, Throwable, Long, Request) instead. This constructor uses Date for retryAfter, which has been replaced by Long.
RetryableException(int status, String message, Request.HttpMethod httpMethod, Throwable cause, Long retryAfter, Request request) Represents a retryable exception when Retry-After information is available.
RetryableException(int status, String message, Request.HttpMethod httpMethod, Throwable cause, Long retryAfter, Request request, String methodKey) Represents a retryable exception with methodKey for identifying the method being retried.
RetryableException(int status, String message, Request.HttpMethod httpMethod, Throwable cause, Request request) Represents a non-retryable exception when Retry-After information is explicitly not provided.

Method Summary

Modifier and Type	Method and Description
Request.HttpMethod	method()
String	methodKey() Returns the method key identifying the Feign method that was being invoked.
Long	retryAfter() Sometimes corresponds to the Util.RETRY_AFTER header present in 503 status.

Methods inherited from class feign.FeignException

content, contentUTF8, errorStatus, errorStatus, hasRequest, request, responseBody, responseHeaders, status

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

RetryableException

public RetryableException(int status,
                          String message,
                          Request.HttpMethod httpMethod,
                          Request request)

Represents a non-retryable exception when Retry-After information is explicitly not provided.

Use this constructor when the server response does not include a Retry-After header or when retries are not expected.

Parameters:

status - the HTTP status code

message - the exception message

httpMethod - the HTTP method (GET, POST, etc.)

request - the original HTTP request

RetryableException

public RetryableException(int status,
                          String message,
                          Request.HttpMethod httpMethod,
                          Throwable cause,
                          Request request)

Represents a non-retryable exception when Retry-After information is explicitly not provided.

Use this constructor when the server response does not include a Retry-After header or when retries are not expected.

Parameters:

status - the HTTP status code

message - the exception message

httpMethod - the HTTP method (GET, POST, etc.)

cause - the underlying cause of the exception

request - the original HTTP request

RetryableException

public RetryableException(int status,
                          String message,
                          Request.HttpMethod httpMethod,
                          Throwable cause,
                          Long retryAfter,
                          Request request)

Represents a retryable exception when Retry-After information is available.

Use this constructor when the server response includes a Retry-After header specifying the delay in milliseconds before retrying.

If retryAfter is null, prefer using #RetryableException(int, String, HttpMethod, Throwable, Request) instead.

Parameters:

status - the HTTP status code

message - the exception message

httpMethod - the HTTP method (GET, POST, etc.)

cause - the underlying cause of the exception

retryAfter - the retry delay in milliseconds retryAfter usually corresponds to the Util.RETRY_AFTER header. If you don't want to retry, use #RetryableException(int, String, HttpMethod, Throwable, Request).

request - the original HTTP request

RetryableException

public RetryableException(int status,
                          String message,
                          Request.HttpMethod httpMethod,
                          Throwable cause,
                          Long retryAfter,
                          Request request,
                          String methodKey)

Represents a retryable exception with methodKey for identifying the method being retried.

Parameters:

status - the HTTP status code

message - the exception message

httpMethod - the HTTP method (GET, POST, etc.)

cause - the underlying cause of the exception

retryAfter - the retry delay in milliseconds

request - the original HTTP request

methodKey - the method key identifying the Feign method

RetryableException

@Deprecated
public RetryableException(int status,
                                      String message,
                                      Request.HttpMethod httpMethod,
                                      Throwable cause,
                                      Date retryAfter,
                                      Request request)

Deprecated. Use #RetryableException(int, String, HttpMethod, Throwable, Long, Request) instead. This constructor uses Date for retryAfter, which has been replaced by Long.

Parameters:

status - the HTTP status code

message - the exception message

httpMethod - the HTTP method (GET, POST, etc.)

cause - the underlying cause of the exception

retryAfter - the retry-after time as a Date

request - the original HTTP request

RetryableException

public RetryableException(int status,
                          String message,
                          Request.HttpMethod httpMethod,
                          Long retryAfter,
                          Request request)

Represents a retryable exception when Retry-After information is available.

Use this constructor when the server response includes a Retry-After header.

Parameters:

status - the HTTP status code

message - the exception message

httpMethod - the HTTP method (GET, POST, etc.)

retryAfter - the retry delay in milliseconds retryAfter usually corresponds to the Util.RETRY_AFTER header. If you don't want to retry, use #RetryableException(int, String, HttpMethod, Request)

request - the original HTTP request

RetryableException

@Deprecated
public RetryableException(int status,
                                      String message,
                                      Request.HttpMethod httpMethod,
                                      Date retryAfter,
                                      Request request)

Deprecated. Use #RetryableException(int, String, HttpMethod, Long, Request) instead. This constructor uses Date for retryAfter, which has been replaced by Long.

Parameters:

status - the HTTP status code

message - the exception message

httpMethod - the HTTP method (GET, POST, etc.)

retryAfter - the retry-after time as a Date

request - the original HTTP request

RetryableException

public RetryableException(int status,
                          String message,
                          Request.HttpMethod httpMethod,
                          Long retryAfter,
                          Request request,
                          byte[] responseBody,
                          Map<String,Collection<String>> responseHeaders)

Represents a retryable exception with response body and headers.

Use this constructor when handling HTTP responses that include Retry-After information.

Parameters:

status - the HTTP status code

message - the exception message

httpMethod - the HTTP method (GET, POST, etc.)

retryAfter - the retry delay in milliseconds retryAfter usually corresponds to the Util.RETRY_AFTER header.

request - the original HTTP request

responseBody - the HTTP response body

responseHeaders - the HTTP response headers

RetryableException

@Deprecated
public RetryableException(int status,
                                      String message,
                                      Request.HttpMethod httpMethod,
                                      Date retryAfter,
                                      Request request,
                                      byte[] responseBody,
                                      Map<String,Collection<String>> responseHeaders)

Deprecated. Use #RetryableException(int, String, HttpMethod, Long, Request, byte[], Map) instead. This constructor uses Date for retryAfter, which has been replaced by Long.

Parameters:

status - the HTTP status code

message - the exception message

httpMethod - the HTTP method (GET, POST, etc.)

retryAfter - the retry-after time as a Date

request - the original HTTP request

responseBody - the HTTP response body

responseHeaders - the HTTP response headers

Method Detail

retryAfter

public Long retryAfter()

Sometimes corresponds to the Util.RETRY_AFTER header present in 503 status. Other times parsed from an application-specific response. Null if unknown.

method

public Request.HttpMethod method()

methodKey

public String methodKey()

Returns the method key identifying the Feign method that was being invoked. This corresponds to the methodKey parameter in ErrorDecoder.decode(java.lang.String, feign.Response).

Returns:

the method key, or null if not set