io.quarkus.vertx.http.runtime

Class ProxyConfig

java.lang.Object

io.quarkus.vertx.http.runtime.ProxyConfig

public class ProxyConfig
extends Object

Holds configuration related with proxy addressing forward.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowForwarded If this is true and proxy address forwarding is enabled then the standard Forwarded header will be used, rather than the more common but not standard X-Forwarded-For.
boolean	enableForwardedHost Enable override the received request's host through a forwarded host header.
boolean	enableForwardedPrefix Enable prefix the received request's path with a forwarded prefix header.
String	forwardedHostHeader Configure the forwarded host header to be used if override enabled.
String	forwardedPrefixHeader Configure the forwarded prefix header to be used if prefixing enabled.
boolean	proxyAddressForwarding If this is true then the address, scheme etc will be set from headers forwarded by the proxy server, such as X-Forwarded-For.

Constructor Summary

Constructors

Constructor and Description
ProxyConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

proxyAddressForwarding

@ConfigItem
public boolean proxyAddressForwarding

If this is true then the address, scheme etc will be set from headers forwarded by the proxy server, such as X-Forwarded-For. This should only be set if you are behind a proxy that sets these headers.

allowForwarded

@ConfigItem
public boolean allowForwarded

If this is true and proxy address forwarding is enabled then the standard Forwarded header will be used, rather than the more common but not standard X-Forwarded-For.

enableForwardedHost

@ConfigItem(defaultValue="false")
public boolean enableForwardedHost

Enable override the received request's host through a forwarded host header.

forwardedHostHeader

@ConfigItem(defaultValue="X-Forwarded-Host")
public String forwardedHostHeader

Configure the forwarded host header to be used if override enabled.

enableForwardedPrefix

@ConfigItem(defaultValue="false")
public boolean enableForwardedPrefix

Enable prefix the received request's path with a forwarded prefix header.

forwardedPrefixHeader

@ConfigItem(defaultValue="X-Forwarded-Prefix")
public String forwardedPrefixHeader

Configure the forwarded prefix header to be used if prefixing enabled.

Constructor Detail

ProxyConfig

public ProxyConfig()