Module io.helidon.webclient.http1

Package io.helidon.webclient.http1

Interface Http1ClientRequest

All Superinterfaces:

ClientRequest<Http1ClientRequest>

public interface Http1ClientRequest
extends ClientRequest<Http1ClientRequest>

Client request for HTTP/1.1.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.webclient.api.ClientRequest

ClientRequest.OutputStreamHandler

Method Summary

Modifier and Type	Method	Description
Http1ClientResponse	outputStream(ClientRequest.OutputStreamHandler outputStreamConsumer)	Handle output stream and submit the request.
default Http1ClientResponse	request()	Request without an entity.
Http1ClientResponse	submit(Object entity)	Submit an entity.
UpgradeResponse	upgrade(String protocol)	Upgrade the current request to a different protocol.

Methods inherited from interface io.helidon.webclient.api.ClientRequest

accept, accept, connection, contentType, followRedirects, followRedirects, fragment, fragment, header, header, header, headers, headers, headers, keepAlive, maxRedirects, maxRedirects, outputStream, path, pathParam, property, proxy, queryParam, readContinueTimeout, readTimeout, request, requestEntity, resolvedUri, skipUriEncoding, submit, tls, uri, uri, uri

Method Details

submit

Http1ClientResponse submit(Object entity)

Description copied from interface: ClientRequest

Submit an entity.

Specified by:

submit in interface ClientRequest<Http1ClientRequest>

Parameters:

entity - request entity

Returns:

response

request

default Http1ClientResponse request()

Description copied from interface: ClientRequest

Request without an entity.

Specified by:

request in interface ClientRequest<Http1ClientRequest>

Returns:

response

outputStream

Http1ClientResponse outputStream(ClientRequest.OutputStreamHandler outputStreamConsumer)

Description copied from interface: ClientRequest

Handle output stream and submit the request.

Specified by:

outputStream in interface ClientRequest<Http1ClientRequest>

Parameters:

outputStreamConsumer - output stream to write request entity

Returns:

response

upgrade

UpgradeResponse upgrade(String protocol)

Upgrade the current request to a different protocol. As an upgrade is executing the usual HTTP method call, in case of failure to upgrade, the response will be a usual full HTTP response that you would get without an upgrade attempt.

Note that the response returned will trigger different behavior depending on whether the upgraded succeeded or failed. For success, it will not close the connection (or return it to the pool), and the upgrade caller must correctly handle the connection close. In case of failure, this is just a regular client response that closes the connection (or returns it to the pool)

Parameters:

protocol - protocol ID for upgrade

Returns:

upgrade response