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 ClientRequest

ClientRequest.OutputStreamHandler

Modifier and Type	Interface	Description
static interface	ClientRequest.OutputStreamHandler	Handle output stream.

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 ClientRequest

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

Modifier and Type	Method	Description
default Http1ClientRequest	accept(MediaType... acceptedTypes)	Accepted media types.
default Http1ClientRequest	accept(HttpMediaType... accepted)	Accepted media types.
default Http1ClientRequest	address(SocketAddress socketAddress)	Socket address to use.
Http1ClientRequest	connection(ClientConnection connection)	This method is for explicit connection use by this request.
default Http1ClientRequest	contentType(MediaType contentType)	Sets the content type of the request.
boolean	followRedirects()	Whether to follow redirects.
Http1ClientRequest	followRedirects(boolean followRedirects)	Whether to follow redirects.
Http1ClientRequest	fragment(UriFragment fragment)	Set fragment of the URI.
default Http1ClientRequest	fragment(String fragment)	Set fragment of the URI.
Http1ClientRequest	header(Header header)	Set an HTTP header.
default Http1ClientRequest	header(HeaderName name, String... values)	Set an HTTP header.
default Http1ClientRequest	header(HeaderName name, List<String> values)	Set an HTTP header with multiple values.
ClientRequestHeaders	headers()	Get a (mutable) instance of outgoing headers.
Http1ClientRequest	headers(Headers headers)	Configure headers.
Http1ClientRequest	headers(Consumer<ClientRequestHeaders> headersConsumer)	Update headers.
Http1ClientRequest	keepAlive(boolean keepAlive)	Whether to use keep alive with this request.
int	maxRedirects()	Maximal number of redirects to follow.
Http1ClientRequest	maxRedirects(int maxRedirects)	Max number of the followed redirects.
default <T> ClientResponseTyped<T>	outputStream(ClientRequest.OutputStreamHandler outputStreamConsumer, Class<T> requestedType)	Handle output stream and request a specific type.
default Http1ClientRequest	path(String uri)	Configure path to call.
Http1ClientRequest	pathParam(String name, String value)	Replace a placeholder in URI with an actual value.
Http1ClientRequest	property(String propertyName, String propertyValue)	Add a property to be used by this request.
Http1ClientRequest	proxy(Proxy proxy)	Proxy configuration for this specific request.
Http1ClientRequest	queryParam(String name, String... values)	Add query parameter.
Http1ClientRequest	readContinueTimeout(Duration readContinueTimeout)	Read 100-Continue timeout for this request.
Http1ClientRequest	readTimeout(Duration readTimeout)	Read timeout for this request.
default <E> ClientResponseTyped<E>	request(GenericType<E> type)	Request without sending an entity.
default <E> ClientResponseTyped<E>	request(Class<E> type)	Request without sending an entity.
default <E> E	requestEntity(GenericType<E> type)	Request entity without sending a request entity, asking for entity only.
default <E> E	requestEntity(Class<E> type)	Request entity without sending a request entity, asking for entity only.
UriInfo	resolvedUri()	Resolved URI that will be used to invoke this request.
Http1ClientRequest	sendExpectContinue(boolean sendExpectContinue)	Whether Expect 100-Continue header is sent to verify server availability before sending an entity.
Http1ClientRequest	skipUriEncoding(boolean skip)	Disable uri encoding.
default Http1ClientRequest	sni(SniConfig sni)	Configure client-side TLS SNI for this request.
default Http1ClientRequest	sni(Consumer<SniConfig.Builder> sni)	Configure client-side TLS SNI for this request.
default <E> ClientResponseTyped<E>	submit(Object entity, GenericType<E> requestedType)	Submit an entity and request a specific type.
default <E> ClientResponseTyped<E>	submit(Object entity, Class<E> requestedType)	Submit an entity and request a specific type.
Http1ClientRequest	tls(Tls tls)	TLS configuration for this specific request.
Http1ClientRequest	uri(ClientUri uri)	Configure request URI.
default Http1ClientRequest	uri(String uri)	Configure URI.
Http1ClientRequest	uri(URI uri)	Configure 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