Package io.servicetalk.traffic.resilience.http

Class ServiceRejectionPolicy

java.lang.Object

io.servicetalk.traffic.resilience.http.ServiceRejectionPolicy

public final class ServiceRejectionPolicy
extends Object

Rejection Policy to rule the behavior of service rejections due to capacity or open circuit. This is meant to be used as a policy on the TrafficResilienceHttpServiceFilter.

See Also:

• TrafficResilienceHttpServiceFilter.Builder.rejectionPolicy(ServiceRejectionPolicy)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ServiceRejectionPolicy.Builder	A ServiceRejectionPolicy builder to support a custom policy.

Field Summary

Fields

Modifier and Type	Field	Description
static final ServiceRejectionPolicy	DEFAULT_REJECTION_POLICY	Default response rejection policy.
static final CharSequence	RETRY_AFTER_MILLIS	Custom retry-after header that supports milliseconds resolution, rather than seconds.

Method Summary

Modifier and Type	Method	Description
static Consumer<HttpResponseMetaData>	retryAfterHint(int seconds)	A hard-coded delay in seconds to be supplied as a Retry-After HTTP header in a HttpResponseMetaData.
static BiConsumer<HttpResponseMetaData,StateContext>	retryAfterHintOfBreaker()	A delay in seconds to be supplied as a Retry-After HTTP header in a HttpResponseMetaData based on the CircuitBreaker that matched the HttpRequestMetaData.
static BiConsumer<HttpResponseMetaData,CircuitBreaker>	retryAfterMillisHint(Duration duration)	A hard-coded delay in milliseconds to be supplied as a Retry-After-Millis HTTP header in a HttpResponseMetaData.
static BiFunction<HttpRequestMetaData,StreamingHttpResponseFactory,Single<StreamingHttpResponse>>	serviceUnavailable()	Pre-defined response that signals HttpResponseStatus.SERVICE_UNAVAILABLE to the peer.
static BiFunction<HttpRequestMetaData,StreamingHttpResponseFactory,Single<StreamingHttpResponse>>	tooManyRequests()	Pre-defined response that signals HttpResponseStatus.TOO_MANY_REQUESTS to the peer.

Methods inherited from class java.lang.Object

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

Field Details

RETRY_AFTER_MILLIS

public static final CharSequence RETRY_AFTER_MILLIS

Custom retry-after header that supports milliseconds resolution, rather than seconds.

DEFAULT_REJECTION_POLICY

public static final ServiceRejectionPolicy DEFAULT_REJECTION_POLICY

Default response rejection policy.

• When a request is rejected due to capacity, the service will respond tooManyRequests().
• When a request is rejected due to capacity, the service will NOT include a retry-after header.
• When a request is rejected due to breaker, the service will respond serviceUnavailable().
• When a request is rejected due to breaker, the service will respond with Retry-After header hinting the duration the breaker will remain open.

Method Details

retryAfterHint

public static Consumer<HttpResponseMetaData> retryAfterHint(int seconds)

A hard-coded delay in seconds to be supplied as a Retry-After HTTP header in a HttpResponseMetaData.

Parameters:

seconds - The value (in seconds) to be used in the Retry-After header.

Returns:

A HttpResponseMetaData consumer, that enhances the headers with a fixed Retry-After figure in seconds.

retryAfterHintOfBreaker

public static BiConsumer<HttpResponseMetaData,StateContext> retryAfterHintOfBreaker()

A delay in seconds to be supplied as a Retry-After HTTP header in a HttpResponseMetaData based on the CircuitBreaker that matched the HttpRequestMetaData.

Returns:

A HttpResponseMetaData consumer, that enhances the headers with a Retry-After figure in seconds based on the duration the matching CircuitBreaker will remain open, or a fallback period.

retryAfterMillisHint

public static BiConsumer<HttpResponseMetaData,CircuitBreaker> retryAfterMillisHint(Duration duration)

A hard-coded delay in milliseconds to be supplied as a Retry-After-Millis HTTP header in a HttpResponseMetaData. Being a custom Http header, it will require special handling on the peer side.

Parameters:

duration - The duration to be used in the Retry-After-Millis header.

Returns:

A HttpResponseMetaData consumer, that enhances the headers with a fixed Retry-After-Millis figure in milliseconds.

tooManyRequests

public static BiFunction<HttpRequestMetaData,StreamingHttpResponseFactory,Single<StreamingHttpResponse>> tooManyRequests()

Pre-defined response that signals HttpResponseStatus.TOO_MANY_REQUESTS to the peer.

Returns:

A BiFunction that regardless the input, it will always return a too-many-requests response.

serviceUnavailable

public static BiFunction<HttpRequestMetaData,StreamingHttpResponseFactory,Single<StreamingHttpResponse>> serviceUnavailable()

Pre-defined response that signals HttpResponseStatus.SERVICE_UNAVAILABLE to the peer.

Returns:

A BiFunction that regardless the input, it will always return a service-unavailable response.