Module io.helidon.webclient

Package io.helidon.webclient

Interface WebClientServiceRequest

All Superinterfaces:

HttpRequest

public interface WebClientServiceRequest
extends HttpRequest

Request to SPI WebClientService that supports modification of the outgoing request.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.common.http.HttpRequest

HttpRequest.Path

Method Summary

Modifier and Type	Method	Description
Context	context()	Registry that can be used to propagate information from server (e.g.
void	fragment(String fragment)	Set the new fragment of the request.
WebClientRequestHeaders	headers()	Configured request headers.
String	host()	Host of the request uri.
void	host(String host)	Set new host of the request.
void	path(String path)	Set the new path of the request.
int	port()	Port of the request uri.
void	port(int port)	Set new port of the request.
Map<String,String>	properties()	Properties configured by user when creating this client request.
long	requestId()	Request id which will be used in logging messages.
void	requestId(long requestId)	Set new request id.
String	schema()	Schema of the request uri.
void	schema(String schema)	Set new schema of the request.
Single<WebClientServiceResponse>	whenComplete()	Completes when the full processing of this request is done (e.g.
Single<WebClientServiceResponse>	whenResponseReceived()	Completes when the response headers has been received, but entity has not been processed yet.
Single<WebClientServiceRequest>	whenSent()	Completes when the request part of this request is done (e.g.

Methods inherited from interface io.helidon.common.http.HttpRequest

fragment, method, path, query, queryParams, uri, version

Method Detail

headers

WebClientRequestHeaders headers()

Configured request headers.

Returns:

headers (mutable)

context

Context context()

Registry that can be used to propagate information from server (e.g. security context, tracing spans etc.).

Returns:

registry propagated by the user

requestId

long requestId()

Request id which will be used in logging messages.

Returns:

current request id

requestId

void requestId(long requestId)

Set new request id. This id is used in logging messages.

Parameters:

requestId - new request id

whenSent

Single<WebClientServiceRequest> whenSent()

Completes when the request part of this request is done (e.g. we have sent all headers and bytes).

Returns:

completion stage that finishes when we fully send request (including entity) to server

whenResponseReceived

Single<WebClientServiceResponse> whenResponseReceived()

Completes when the response headers has been received, but entity has not been processed yet.

Returns:

completion stage that finishes when we received headers

whenComplete

Single<WebClientServiceResponse> whenComplete()

Completes when the full processing of this request is done (e.g. we have received a full response).

Returns:

completion stage that finishes when we receive and fully read response from the server

properties

Map<String,String> properties()

Properties configured by user when creating this client request.

Returns:

properties that were configured (mutable)

See Also:

WebClientRequestBuilder.property(String, String)

schema

String schema()

Schema of the request uri. This will not match schema returned by HttpRequest.uri() if changed by schema(String schema)

Returns:

schema of the request

schema

void schema(String schema)

Set new schema of the request.

Parameters:

schema - new request schema

host

String host()

Host of the request uri. This will not match host returned by HttpRequest.uri() if changed by host(String host)

Returns:

host of the request

host

void host(String host)

Set new host of the request.

Parameters:

host - new request host

port

int port()

Port of the request uri. This will not match port returned by HttpRequest.uri() if changed by port(int port)

Returns:

port of the request

port

void port(int port)

Set new port of the request.

Parameters:

port - new request port

path

void path(String path)

Set the new path of the request.

Parameters:

path - new request path

fragment

void fragment(String fragment)

Set the new fragment of the request.

Parameters:

fragment - new request fragment