io.muserver.murp

Class ReverseProxyBuilder

java.lang.Object

io.muserver.murp.ReverseProxyBuilder

All Implemented Interfaces:

io.muserver.MuHandlerBuilder<ReverseProxy>

public class ReverseProxyBuilder
extends Object
implements io.muserver.MuHandlerBuilder<ReverseProxy>

A builder for creating a reverse proxy, which is a MuHandler that can be added to a Mu Server.

Constructor Summary

Constructors

Constructor and Description
ReverseProxyBuilder()

Method Summary

Modifier and Type	Method and Description
ReverseProxyBuilder	addProxyCompleteListener(ProxyCompleteListener proxyCompleteListener) Registers a proxy completion listener.
ReverseProxy	build() Creates a new ReverseProxy which is a MuHandler.
ReverseProxyBuilder	discardClientForwardedHeaders(boolean discardClientForwardedHeaders) If true, then any Forwarded or X-Forwarded-* headers that are sent from the client to this reverse proxy will be dropped (defaults to false).
ReverseProxyBuilder	proxyHostHeader(boolean sendHostToTarget) Specifies whether or not to send the original Host header to the target server.
static ReverseProxyBuilder	reverseProxy() Creates and returns a new instance of a reverse proxy builder.
ReverseProxyBuilder	sendLegacyForwardedHeaders(boolean sendLegacyForwardedHeaders) Murp always sends Forwarded headers, however by default does not send the non-standard X-Forwarded-* headers.
ReverseProxyBuilder	withHttpClient(org.eclipse.jetty.client.HttpClient httpClient) Specifies the Jetty HTTP client to use to make the request to the target server.
ReverseProxyBuilder	withTotalTimeout(long totalTimeoutInMillis) Sets the total request timeout in millis for a proxied request.
ReverseProxyBuilder	withTotalTimeout(long totalTimeout, TimeUnit unit) Sets the total request timeout in millis for a proxied request.
ReverseProxyBuilder	withUriMapper(UriMapper uriMapper) Required value.
ReverseProxyBuilder	withViaName(String viaName) The name to add as the Via header, which defaults to private.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReverseProxyBuilder

public ReverseProxyBuilder()

Method Detail

withViaName

public ReverseProxyBuilder withViaName(String viaName)

The name to add as the Via header, which defaults to private.

Parameters:

viaName - The name to add to the Via header.

Returns:

This builder

withHttpClient

public ReverseProxyBuilder withHttpClient(org.eclipse.jetty.client.HttpClient httpClient)

Specifies the Jetty HTTP client to use to make the request to the target server. It's recommended you do not set this in order to use the default client that is optimised for reverse proxy usage.

Parameters:

httpClient - The HTTP client to use, or null to use the default client.

Returns:

This builder

withUriMapper

public ReverseProxyBuilder withUriMapper(UriMapper uriMapper)

Required value. Sets the mapper to use for creating target URIs.

If you want to proxy all requests to a single destination, consider using UriMapper.toDomain(URI)

If the mapper function returns null, then the handler will not proxy the request and the next handler in the chain will be invoked (or a 404 will be returned if there are no further handlers that can handle the request).

Parameters:

uriMapper - A mapper that creates a target URI based on a client request.

Returns:

This builder

sendLegacyForwardedHeaders

public ReverseProxyBuilder sendLegacyForwardedHeaders(boolean sendLegacyForwardedHeaders)

Murp always sends Forwarded headers, however by default does not send the non-standard X-Forwarded-* headers. Set this to true to enable these legacy headers for older clients that rely on them.

Parameters:

sendLegacyForwardedHeaders - true to forward headers such as X-Forwarded-Host; otherwise false

Returns:

This builder

proxyHostHeader

public ReverseProxyBuilder proxyHostHeader(boolean sendHostToTarget)

Specifies whether or not to send the original Host header to the target server.

Reverse proxies are generally supposed to forward the original Host header to target servers, however there are cases (particularly where you are proxying to HTTPS servers) that the Host needs to match the Host of the SSL certificate (in which case you may see SNI-related errors).

Parameters:

sendHostToTarget - If true (which is the default) the Host request header will be sent to the target; if false then the host header will be based on the target's URL.

Returns:

This builder

discardClientForwardedHeaders

public ReverseProxyBuilder discardClientForwardedHeaders(boolean discardClientForwardedHeaders)

If true, then any Forwarded or X-Forwarded-* headers that are sent from the client to this reverse proxy will be dropped (defaults to false). Set this to true if you do not trust the client.

Parameters:

discardClientForwardedHeaders - true to ignore Forwarded headers from the client; otherwise false

Returns:

This builder

withTotalTimeout

public ReverseProxyBuilder withTotalTimeout(long totalTimeoutInMillis)

Sets the total request timeout in millis for a proxied request. Defaults to 5 minutes.

Parameters:

totalTimeoutInMillis - The allowed time in milliseconds for a request.

Returns:

This builder

withTotalTimeout

public ReverseProxyBuilder withTotalTimeout(long totalTimeout,
                                            TimeUnit unit)

Sets the total request timeout in millis for a proxied request. Defaults to 5 minutes.

Parameters:

totalTimeout - The allowed time for a request.

unit - The timeout unit.

Returns:

This builder

addProxyCompleteListener

public ReverseProxyBuilder addProxyCompleteListener(ProxyCompleteListener proxyCompleteListener)

Registers a proxy completion listener.

Parameters:

proxyCompleteListener - A listener to be called when a proxy request is complete

Returns:

This builder

reverseProxy

public static ReverseProxyBuilder reverseProxy()

Creates and returns a new instance of a reverse proxy builder.

Returns:

A builder

build

public ReverseProxy build()

Creates a new ReverseProxy which is a MuHandler. You can pass the resulting handler directly to MuServerBuilder.addHandler(MuHandler)

Specified by:

build in interface io.muserver.MuHandlerBuilder<ReverseProxy>

Returns:

A MuHandler that acts as a reverse proxy