Module io.helidon.webclient.context

Package io.helidon.webclient.context

Class WebClientContextService

java.lang.Object

io.helidon.webclient.context.WebClientContextService

All Implemented Interfaces:

RuntimeType.Api<WebClientContextConfig>, NamedService, NamedService, WebClientService

public class WebClientContextService
extends Object
implements WebClientService, RuntimeType.Api<WebClientContextConfig>

Client service for context propagation.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.webclient.spi.WebClientService

WebClientService.Chain

Method Summary

Modifier and Type	Method	Description
static WebClientContextConfig.Builder	builder()	Fluent API builder to set up an instance.
static WebClientContextService	create(Config config)	Deprecated, for removal: This API element is subject to removal in a future version. use create(io.helidon.config.Config) instead
static WebClientContextService	create(Config config)	Create a new instance from configuration.
static WebClientContextService	create(WebClientContextConfig config)	Create a new instance from its configuration.
static WebClientContextService	create(Consumer<WebClientContextConfig.Builder> builderConsumer)	Create a new instance customizing its configuration.
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.
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(io.helidon.common.config.Config, String).
WebClientContextConfig	prototype()	The prototype as it was received when creating this runtime object instance.
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

Methods inherited from class java.lang.Object

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

Method Details

builder

public static WebClientContextConfig.Builder builder()

Fluent API builder to set up an instance.

Returns:

a new builder

create

@Deprecated(since="4.4.0",
            forRemoval=true)
public static WebClientContextService create(Config config)

Deprecated, for removal: This API element is subject to removal in a future version.

use create(io.helidon.config.Config) instead

Create a new instance from configuration.

Parameters:

config - configuration

Returns:

a new service

create

public static WebClientContextService create(Config config)

Create a new instance from configuration.

Parameters:

config - configuration

Returns:

a new service

create

public static WebClientContextService create(WebClientContextConfig config)

Create a new instance from its configuration.

Parameters:

config - configuration

Returns:

a new service

create

public static WebClientContextService create(Consumer<WebClientContextConfig.Builder> builderConsumer)

Create a new instance customizing its configuration.

Parameters:

builderConsumer - consumer of configuration

Returns:

a new service

name

public 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

Specified by:

name in interface WebClientService

Returns:

name of this service

type

public 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

Specified by:

type in interface WebClientService

Returns:

type of this service

prototype

public WebClientContextConfig prototype()

Description copied from interface: RuntimeType.Api

The prototype as it was received when creating this runtime object instance.

Specified by:

prototype in interface RuntimeType.Api<WebClientContextConfig>

Returns:

prototype object used to create this instance

handle

public WebClientServiceResponse handle(WebClientService.Chain chain,
 WebClientServiceRequest clientRequest)

Description copied from interface: WebClientService

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

Specified by:

handle in interface WebClientService

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