Module io.inverno.mod.http.client

Package io.inverno.mod.http.client

Interface Request

All Superinterfaces:

BaseRequest

public interface Request
extends BaseRequest

Represents a client request in a client exchange.

Once the request has been sent to the endpoint it is no longer possible to modify it resulting in IllegalStateException on such operations.

Since:

1.6

Author:

Jeremy Kuhn

See Also:

• Exchange

Method Summary

Modifier and Type	Method	Description
Request	authority(String authority)	Sets the request authority.
Optional<? extends RequestBody>	body()	Returns the request body when the request method allows it.
Request	headers(Consumer<OutboundRequestHeaders> headersConfigurer)	Configures the HTTP headers to send in the request.
boolean	isHeadersWritten()	Determines whether the request headers have been sent to the endpoint.
Request	method(Method method)	Sets the request method.
Request	path(String path)	Sets the request path.

Methods inherited from interface io.inverno.mod.http.base.BaseRequest

getAuthority, getLocalAddress, getLocalCertificates, getMethod, getPath, getPathAbsolute, getPathBuilder, getQuery, getRemoteAddress, getRemoteCertificates, getScheme, headers, queryParameters

Method Details

isHeadersWritten

boolean isHeadersWritten()

Determines whether the request headers have been sent to the endpoint.

Returns:

true if headers have been sent, false otherwise

method

Request method(Method method)
        throws IllegalStateException

Sets the request method.

This actually overrides the method provided when the enclosing exchange was created by the Endpoint. It defaults to Method.GET if none is specified.

Parameters:

method - the request method

Returns:

the request

Throws:

IllegalStateException - if the request has already been sent to the endpoint

authority

Request authority(String authority)
           throws IllegalStateException

Sets the request authority.

Parameters:

authority - the request authority

Returns:

the request

Throws:

IllegalStateException - if the request has already been sent to the endpoint

path

Request path(String path)
      throws IllegalStateException

Sets the request path.

This actually overrides the request target path provided when the request was created using Endpoint.exchange(io.inverno.mod.http.base.Method, java.lang.String) or Endpoint.exchange(io.inverno.mod.http.base.Method, java.lang.String, io.inverno.mod.http.base.ExchangeContext).

Parameters:

path - the request target path

Returns:

the request

Throws:

IllegalStateException - if the request has already been sent to the endpoint

headers

Request headers(Consumer<OutboundRequestHeaders> headersConfigurer)
         throws IllegalStateException

Configures the HTTP headers to send in the request.

Parameters:

headersConfigurer - an outbound request headers configurer

Returns:

the request

Throws:

IllegalStateException - if the request has already been sent to the endpoint

body

Optional<? extends RequestBody> body()
                              throws IllegalStateException

Returns the request body when the request method allows it.

Returns:

an optional returning the request body when the method allows it (i.e. POST PUT...) or an empty optional (i.e. GET...).

Throws:

IllegalStateException - if the request has already been sent to the endpoint