Module io.helidon.webclient.api

Package io.helidon.webclient.spi

Interface WebClientService

All Superinterfaces:

NamedService, NamedService

All Known Subinterfaces:

WebClientDiscovery

All Known Implementing Classes:

WebClientContextService, WebClientMeter, WebClientMetrics, WebClientSecurity, WebClientTelemetryMetrics, WebClientTelemetryTracing, WebClientTracing

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface WebClientService
extends NamedService

Extension that can modify web client behavior. This is now only designed for HTTP/1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WebClientService.Chain	Chain of services.

Method Summary

Modifier and Type	Method	Description
WebClientServiceResponse	handle(WebClientService.Chain chain, WebClientServiceRequest clientRequest)	Invoke a service, call WebClientService.Chain.proceed(io.helidon.webclient.api.WebClientServiceRequest) to call the next service in the chain.
default String	name()	Name of this implementation, as provided in ConfiguredProvider.create(io.helidon.common.config.Config, String).
default String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

Method Details

name

default String name()

Description copied from interface: NamedService

Name of this implementation, as provided in ConfiguredProvider.create(io.helidon.common.config.Config, String).

Specified by:

name in interface NamedService

Specified by:

name in interface NamedService

Returns:

name of this service

type

default String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Specified by:

type in interface NamedService

Returns:

type of this service

handle

WebClientServiceResponse handle(WebClientService.Chain chain,
 WebClientServiceRequest clientRequest)

Invoke a service, call WebClientService.Chain.proceed(io.helidon.webclient.api.WebClientServiceRequest) to call the next service in the chain.

Parameters:

chain - to invoke next web client service, or the HTTP call if this is the last service

clientRequest - request from the client, or previous services

Returns:

response to be returned to the client