Package io.servicetalk.http.api

Interface HttpExecutionStrategyInfluencer

All Superinterfaces:

ExecutionStrategyInfluencer<HttpExecutionStrategy>

All Known Subinterfaces:

BlockingHttpService, BlockingStreamingHttpService, HttpService, HttpServiceBase, StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory, StreamingHttpService, StreamingHttpServiceFilterFactory, TimeoutFromRequest

All Known Implementing Classes:

BasicAuthHttpServiceFilter, ContentCodingHttpRequesterFilter, ContentCodingHttpServiceFilter, ContentEncodingHttpRequesterFilter, ContentEncodingHttpServiceFilter, DisableInterruptOnCancelHttpServiceFilter, EnforceSequentialModeRequesterFilter, GrpcExceptionMapperServiceFilter, GrpcLifecycleObserverRequesterFilter, GrpcLifecycleObserverServiceFilter, HostHeaderHttpRequesterFilter, HttpExceptionMapperServiceFilter, HttpLifecycleObserverRequesterFilter, HttpLifecycleObserverServiceFilter, HttpRequestAutoDrainingServiceFilter, IdleTimeoutConnectionFilter, JavaNetSoTimeoutHttpConnectionFilter, OpenTelemetryHttpRequesterFilter, OpenTelemetryHttpRequestFilter, OpenTelemetryHttpServerFilter, OpenTelemetryHttpServiceFilter, PayloadSizeLimitingHttpRequesterFilter, PayloadSizeLimitingHttpServiceFilter, RedirectingHttpRequesterFilter, RequestTargetDecoderHttpServiceFilter, RequestTargetEncoderHttpRequesterFilter, RequestTargetEncoderHttpServiceFilter, RetryingHttpRequesterFilter, StreamingHttpServiceFilter, StreamingHttpServiceToOffloadedStreamingHttpService, TimeoutHttpRequesterFilter, TimeoutHttpServiceFilter, TracingHttpRequesterFilter, TracingHttpServiceFilter, TrafficResilienceHttpClientFilter, TrafficResilienceHttpServiceFilter

public interface HttpExecutionStrategyInfluencer
extends ExecutionStrategyInfluencer<HttpExecutionStrategy>

An entity that wishes to influence HttpExecutionStrategy for an HTTP client or server.

Method Summary

Modifier and Type	Method	Description
static HttpExecutionStrategyInfluencer	defaultStreamingInfluencer()	Deprecated. This method is not useful anymore and will be removed in future releases.
default HttpExecutionStrategy	influenceStrategy(HttpExecutionStrategy strategy)	Deprecated. Implement requiredOffloads() instead.
default HttpExecutionStrategy	requiredOffloads()	Return an ExecutionStrategy that describes the offloads required by the influencer.

Method Details

influenceStrategy

@Deprecated
default HttpExecutionStrategy influenceStrategy(HttpExecutionStrategy strategy)

Deprecated.

Implement requiredOffloads() instead.

Optionally modify the passed HttpExecutionStrategy to a new HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer.

Implementations should not return HttpExecutionStrategies.defaultStrategy() unless it was also provided as input.

Parameters:

strategy - HttpExecutionStrategy to influence.

Returns:

HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer

requiredOffloads

default HttpExecutionStrategy requiredOffloads()

Return an ExecutionStrategy that describes the offloads required by the influencer.

The provided default implementation requests offloading of all operations. Implementations that require no offloading should be careful to return HttpExecutionStrategies.offloadNone() rather than HttpExecutionStrategies.offloadNever(). Implementations should avoid returning HttpExecutionStrategies.defaultStrategy(), instead returning the strategy they require or HttpExecutionStrategies.offloadAll() if offloading for all paths is required (safe default).

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

Returns:

the ExecutionStrategy required by the influencer.

defaultStreamingInfluencer

@Deprecated
static HttpExecutionStrategyInfluencer defaultStreamingInfluencer()

Deprecated.

This method is not useful anymore and will be removed in future releases.

Returns an HttpExecutionStrategyInfluencer to be used for the default streaming programming model.

Returns:

An HttpExecutionStrategyInfluencer to be used for the default streaming programming model.