Module io.inverno.mod.http.client

Package io.inverno.mod.http.client

Interface InterceptedRequest

All Superinterfaces:

BaseRequest

All Known Subinterfaces:

InterceptedWebRequest

public interface InterceptedRequest
extends BaseRequest

An intercepted request is exposed in the InterceptedExchange to proxy the original request that is about to be sent to the endpoint and the actual request after it has been sent to the endpoint.

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

Since:

1.6

Author:

Jeremy Kuhn

See Also:

• InterceptedExchange

Method Summary

Modifier and Type	Method	Description
InterceptedRequest	authority(String authority)	Sets the request authority.
InterceptedRequestBody	body()	Returns the request body when the request method allows it.
InterceptedRequest	headers(Consumer<OutboundRequestHeaders> headersConfigurer)	Configures the HTTP headers to send in the request.
boolean	isSent()	Determines whether the request was sent to the endpoint.
InterceptedRequest	method(Method method)	Sets the request method.
InterceptedRequest	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

method

InterceptedRequest 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

InterceptedRequest 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

InterceptedRequest path(String path)
                 throws IllegalStateException

Sets the request path.

This actually overrides the request target path provided when the exchange 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

InterceptedRequest 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

InterceptedRequestBody body()
                     throws IllegalStateException

Returns the request body when the request method allows it.

Returns:

the request body when the method allows it (i.e. POST PUT...)

Throws:

IllegalStateException - if the method does not allow a body in the request (i.e. GET...)

isSent

boolean isSent()

Determines whether the request was sent to the endpoint.

Once the request is sent, it is no longer possible to modify it resulting in IllegalArgumentException.

Returns:

true if the request has been sent, false otherwise