net.bluemind.central.reverse.proxy.vertx

Interface ProxyRequest

All Known Implementing Classes:

ProxyRequestImpl

public interface ProxyRequest

Handles the interoperability of the request between the user agent and the origin.

Author:

Julien Viet

Method Summary

Modifier and Type	Method and Description
java.lang.String	absoluteURI()
ProxyRequest	bodyFilter(java.util.function.Function<io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>,io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>> filter) Set a body filter.
Body	getBody()
io.vertx.core.http.HttpMethod	getMethod()
java.lang.String	getURI()
io.vertx.core.MultiMap	headers()
io.vertx.core.http.HttpServerRequest	outboundRequest()
default io.vertx.core.Future<java.lang.Void>	proxy(io.vertx.core.http.HttpClientRequest inboundRequest) Proxy this outbound request and response to the origin server using the specified inbound request.
ProxyRequest	putHeader(java.lang.CharSequence name, java.lang.CharSequence value) Put an HTTP header
ProxyRequest	release() Release the proxy request.
ProxyResponse	response() Create and return the proxy response.
static ProxyRequest	reverseProxy(io.vertx.core.http.HttpServerRequest outboundRequest) Create a new ProxyRequest instance, the outbound request will be paused.
io.vertx.core.Future<ProxyResponse>	send(io.vertx.core.http.HttpClientRequest inboundRequest) Send this request to the origin server using the specified inbound request.
ProxyRequest	setBody(Body body) Set the request body to be sent to the origin server.
ProxyRequest	setMethod(io.vertx.core.http.HttpMethod method) Set the HTTP method to be sent to the origin server.
ProxyRequest	setURI(java.lang.String uri) Set the request URI to be sent to the origin server.
io.vertx.core.http.HttpVersion	version()

Method Detail

reverseProxy

static ProxyRequest reverseProxy(io.vertx.core.http.HttpServerRequest outboundRequest)

Create a new ProxyRequest instance, the outbound request will be paused.

Parameters:

outboundRequest - the HttpServerRequest of the user agent

Returns:

a reference to this, so the API can be used fluently

version

io.vertx.core.http.HttpVersion version()

Returns:

the HTTP version of the outbound request

absoluteURI

java.lang.String absoluteURI()

Returns:

the absolute URI of the outbound request

getMethod

io.vertx.core.http.HttpMethod getMethod()

Returns:

the HTTP method to be sent to the origin server.

setMethod

ProxyRequest setMethod(io.vertx.core.http.HttpMethod method)

Set the HTTP method to be sent to the origin server.

The initial HTTP method value is the outbound request HTTP method.

Parameters:

method - the new HTTP method

Returns:

a reference to this, so the API can be used fluently

getURI

java.lang.String getURI()

Returns:

the request URI to be sent to the origin server.

setURI

ProxyRequest setURI(java.lang.String uri)

Set the request URI to be sent to the origin server.

The initial request URI value is the outbound request URI.

Parameters:

uri - the new URI

Returns:

a reference to this, so the API can be used fluently

getBody

Body getBody()

Returns:

the request body to be sent to the origin server.

setBody

ProxyRequest setBody(Body body)

Set the request body to be sent to the origin server.

The initial request body value is the outbound request body.

Parameters:

body - the new body

Returns:

a reference to this, so the API can be used fluently

headers

io.vertx.core.MultiMap headers()

Returns:

the headers that will be sent to the origin server, the returned headers can be modified. The headers map is populated with the outbound request headers

putHeader

ProxyRequest putHeader(java.lang.CharSequence name,
                       java.lang.CharSequence value)

Put an HTTP header

Parameters:

name - The header name

value - The header value

Returns:

a reference to this, so the API can be used fluently

bodyFilter

ProxyRequest bodyFilter(java.util.function.Function<io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>,io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>> filter)

Set a body filter.

The body filter can rewrite the request body sent to the origin server.

Parameters:

filter - the filter

Returns:

a reference to this, so the API can be used fluently

proxy

default io.vertx.core.Future<java.lang.Void> proxy(io.vertx.core.http.HttpClientRequest inboundRequest)

Proxy this outbound request and response to the origin server using the specified inbound request.

Parameters:

inboundRequest - the request connected to the origin server

send

io.vertx.core.Future<ProxyResponse> send(io.vertx.core.http.HttpClientRequest inboundRequest)

Send this request to the origin server using the specified inbound request.

The completionHandler will be called with the proxy response sent by the origin.

Parameters:

inboundRequest - the request connected to the origin server

release

ProxyRequest release()

Release the proxy request.

The HTTP server request is resumed, no HTTP server response is sent.

Returns:

a reference to this, so the API can be used fluently

outboundRequest

io.vertx.core.http.HttpServerRequest outboundRequest()

Returns:

the outbound HTTP server request

response

ProxyResponse response()

Create and return the proxy response.

Returns:

the proxy response