Module io.inverno.mod.web.client

Package io.inverno.mod.web.client

Interface InterceptedWebRequest

All Superinterfaces:

BaseRequest, InterceptedRequest

public interface InterceptedWebRequest
extends InterceptedRequest

An intercepted Web request extending HTTP client InterceptedRequest.

Since:

1.12

Author:

Jeremy Kuhn

Method Summary

Modifier and Type	Method	Description
InterceptedWebRequest	authority(String authority)	Sets the request authority.
URI	getUri()	Returns the Web exchange URI.
InterceptedWebRequest	headers(Consumer<OutboundRequestHeaders> headersConfigurer)	Configures the HTTP headers to send in the request.
InterceptedWebRequest	method(Method method)	Sets the request method.
InterceptedWebRequest	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

Methods inherited from interface io.inverno.mod.http.client.InterceptedRequest

body, isSent

Method Details

getUri

URI getUri()

Returns the Web exchange URI.

Returns:

the Web exchange URI

headers

InterceptedWebRequest headers(Consumer<OutboundRequestHeaders> headersConfigurer)
                       throws IllegalStateException

Description copied from interface: InterceptedRequest

Configures the HTTP headers to send in the request.

Specified by:

headers in interface InterceptedRequest

Parameters:

headersConfigurer - an outbound request headers configurer

Returns:

the request

Throws:

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

path

InterceptedWebRequest path(String path)
                    throws IllegalStateException

Description copied from interface: InterceptedRequest

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).

Specified by:

path in interface InterceptedRequest

Parameters:

path - the request target path

Returns:

the request

Throws:

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

authority

InterceptedWebRequest authority(String authority)
                         throws IllegalStateException

Description copied from interface: InterceptedRequest

Sets the request authority.

Specified by:

authority in interface InterceptedRequest

Parameters:

authority - the request authority

Returns:

the request

Throws:

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

method

InterceptedWebRequest method(Method method)
                      throws IllegalStateException

Description copied from interface: InterceptedRequest

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.

Specified by:

method in interface InterceptedRequest

Parameters:

method - the request method

Returns:

the request

Throws:

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