com.palantir.conjure.java.api.errors

Class QosException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.palantir.conjure.java.api.errors.QosException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

QosException.RetryOther, QosException.Throttle, QosException.Unavailable

public abstract class QosException
extends java.lang.RuntimeException

An exception raised by a service to indicate a potential Quality-of-Service problem, specifically requesting that the client making the request should retry the request again now/later/never, possibly against a different node of this service. Typically, this exception gets translated into appropriate error codes of the underlying transport layer, e.g., HTTP status codes 429, 503, etc. in the case of HTTP transport.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QosException.RetryOther See retryOther(java.net.URL).
static class	QosException.Throttle See throttle().
static class	QosException.Unavailable See unavailable().
static interface	QosException.Visitor<T>

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(QosException.Visitor<T> visitor)
static QosException.RetryOther	retryOther(java.net.URL redirectTo) Returns a QosException.RetryOther exception indicating that the calling client should retry against the given node of this service.
static QosException.RetryOther	retryOther(java.net.URL redirectTo, java.lang.Throwable cause) Like retryOther(URL), but includes a cause.
static QosException.Throttle	throttle() Returns a QosException.Throttle exception indicating that the calling client should throttle its requests.
static QosException.Throttle	throttle(java.time.Duration duration) Like throttle(), but additionally requests that the client wait for at least the given duration before retrying the request.
static QosException.Throttle	throttle(java.time.Duration duration, java.lang.Throwable cause) Like throttle(Duration), but includes a cause.
static QosException.Throttle	throttle(java.lang.Throwable cause) Like throttle(), but includes a cause.
static QosException.Unavailable	unavailable() An exception indicating that (this node of) this service is currently unavailable and the client may try again at a later time, possibly against a different node of this service.
static QosException.Unavailable	unavailable(java.lang.Throwable cause) Like unavailable(), but includes a cause.

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

Method Detail

accept

public abstract <T> T accept(QosException.Visitor<T> visitor)

throttle

public static QosException.Throttle throttle()

Returns a QosException.Throttle exception indicating that the calling client should throttle its requests. The client may retry against an arbitrary node of this service.

throttle

public static QosException.Throttle throttle(java.lang.Throwable cause)

Like throttle(), but includes a cause.

throttle

public static QosException.Throttle throttle(java.time.Duration duration)

Like throttle(), but additionally requests that the client wait for at least the given duration before retrying the request.

throttle

public static QosException.Throttle throttle(java.time.Duration duration,
                                             java.lang.Throwable cause)

Like throttle(Duration), but includes a cause.

retryOther

public static QosException.RetryOther retryOther(java.net.URL redirectTo)

Returns a QosException.RetryOther exception indicating that the calling client should retry against the given node of this service.

retryOther

public static QosException.RetryOther retryOther(java.net.URL redirectTo,
                                                 java.lang.Throwable cause)

Like retryOther(URL), but includes a cause.

unavailable

public static QosException.Unavailable unavailable()

An exception indicating that (this node of) this service is currently unavailable and the client may try again at a later time, possibly against a different node of this service.

unavailable

public static QosException.Unavailable unavailable(java.lang.Throwable cause)

Like unavailable(), but includes a cause.