io.servicetalk.traffic.resilience.http

Class ClientPeerRejectionPolicy

Object

ClientPeerRejectionPolicy

public final class ClientPeerRejectionPolicy
extends Object

Policy for peer capacity rejections that allows customization of behavior (retries or pass-through). This is meant to be used as a policy on the TrafficResilienceHttpServiceFilter.

See Also:

TrafficResilienceHttpClientFilter.Builder.rejectionPolicy(ClientPeerRejectionPolicy)

Field Summary

Fields

Modifier and Type	Field and Description
static Predicate<HttpResponseMetaData>	DEFAULT_CAPACITY_REJECTION_PREDICATE Default rejection observer for dropped requests from an external sourced.
static ClientPeerRejectionPolicy	DEFAULT_PEER_REJECTION_POLICY Default rejection policy for peer responses.

Method Summary

Modifier and Type	Method and Description
static ClientPeerRejectionPolicy	ofPassthrough(Predicate<HttpResponseMetaData> predicate) Evaluate responses with the given Predicate as capacity related rejections, that will affect the CapacityLimiter in use, but allow the original response from the upstream to pass-through this filter.
static ClientPeerRejectionPolicy	ofRejection(Predicate<HttpResponseMetaData> rejectionPredicate) Evaluate responses with the given Predicate as capacity related rejections, that will affect the CapacityLimiter in use, and translate that to en exception.
static ClientPeerRejectionPolicy	ofRejectionWithRetries(Predicate<HttpResponseMetaData> rejectionPredicate, Function<HttpResponseMetaData,Duration> delayProvider) Evaluate responses with the given Predicate as capacity related rejections, that will affect the CapacityLimiter in use, and translate that to an exception that contains "delay" information useful when retrying it through a retrying filter.

Methods inherited from class Object

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

Field Detail

DEFAULT_CAPACITY_REJECTION_PREDICATE

public static final Predicate<HttpResponseMetaData> DEFAULT_CAPACITY_REJECTION_PREDICATE

Default rejection observer for dropped requests from an external sourced. see. TrafficResilienceHttpClientFilter.Builder.rejectionPolicy(ClientPeerRejectionPolicy).

The default predicate matches the following HTTP response codes:

• HttpResponseStatus.TOO_MANY_REQUESTS
• HttpResponseStatus.BAD_GATEWAY
• HttpResponseStatus.SERVICE_UNAVAILABLE

If a CircuitBreaker is used consider adjusting this predicate to avoid considering HttpResponseStatus.SERVICE_UNAVAILABLE as a capacity issue.

DEFAULT_PEER_REJECTION_POLICY

public static final ClientPeerRejectionPolicy DEFAULT_PEER_REJECTION_POLICY

Default rejection policy for peer responses. The following responses will be considered rejections, and exercise the rejection policy;

• HttpResponseStatus.TOO_MANY_REQUESTS
• HttpResponseStatus.BAD_GATEWAY
• HttpResponseStatus.SERVICE_UNAVAILABLE

The default behavior upon such a case, is to issue a retryable exception with no pre-set offset delay (outside the default backoff policy of configured retry filter).

Method Detail

ofPassthrough

public static ClientPeerRejectionPolicy ofPassthrough(Predicate<HttpResponseMetaData> predicate)

Evaluate responses with the given Predicate as capacity related rejections, that will affect the CapacityLimiter in use, but allow the original response from the upstream to pass-through this filter.

Parameters:

predicate - The Predicate to evaluate responses. Returning true from this Predicate signifies that the response was capacity related rejection from the peer.

Returns:

A ClientPeerRejectionPolicy.

ofRejection

public static ClientPeerRejectionPolicy ofRejection(Predicate<HttpResponseMetaData> rejectionPredicate)

Evaluate responses with the given Predicate as capacity related rejections, that will affect the CapacityLimiter in use, and translate that to en exception.

Parameters:

rejectionPredicate - The Predicate to evaluate responses. Returning true from this Predicate signifies that the response was capacity related rejection from the peer.

Returns:

A ClientPeerRejectionPolicy.

ofRejectionWithRetries

public static ClientPeerRejectionPolicy ofRejectionWithRetries(Predicate<HttpResponseMetaData> rejectionPredicate,
                                                               Function<HttpResponseMetaData,Duration> delayProvider)

Evaluate responses with the given Predicate as capacity related rejections, that will affect the CapacityLimiter in use, and translate that to an exception that contains "delay" information useful when retrying it through a retrying filter.

Parameters:

rejectionPredicate - The Predicate to evaluate responses. Returning true from this Predicate signifies that the response was capacity related rejection from the peer.

delayProvider - A Duration provider for delay purposes when retrying.

Returns:

A ClientPeerRejectionPolicy.