ProxyHandler (Undertow 1.4.13.Final-SNAPSHOT API)

java.lang.Object
- io.undertow.server.handlers.proxy.ProxyHandler

All Implemented Interfaces:

HttpHandler
```
public final class ProxyHandler
extends Object
implements HttpHandler
```
An HTTP handler which proxies content to a remote server.
This handler acts like a filter. The ProxyClient has a chance to decide if it knows how to proxy the request. If it does then it will provide a connection that can used to connect to the remote server, otherwise the next handler will be invoked and the request will proceed as normal.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProxyHandler.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProxyHandler.Builder`

Field Summary

Fields
Modifier and Type Field and Description

static String UTF_8

Fields
Modifier and Type	Field and Description
`static String`	`UTF_8`

Constructor Summary

Constructors
Constructor and Description
`ProxyHandler(ProxyClient proxyClient, HttpHandler next)`
`ProxyHandler(ProxyClient proxyClient, int maxRequestTime, HttpHandler next)`
`ProxyHandler(ProxyClient proxyClient, int maxRequestTime, HttpHandler next, boolean rewriteHostHeader, boolean reuseXForwarded)`
`ProxyHandler(ProxyClient proxyClient, int maxRequestTime, HttpHandler next, boolean rewriteHostHeader, boolean reuseXForwarded, int maxConnectionRetries)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProxyHandler`	`addRequestHeader(HttpString header, ExchangeAttribute attribute)` Adds a request header to the outgoing request.
`ProxyHandler`	`addRequestHeader(HttpString header, String value)` Adds a request header to the outgoing request.
`ProxyHandler`	`addRequestHeader(HttpString header, String attribute, ClassLoader classLoader)` Adds a request header to the outgoing request.
`Predicate`	`getIdempotentRequestPredicate()`
`int`	`getMaxConnectionRetries()`
`ProxyClient`	`getProxyClient()`
`void`	`handleRequest(HttpServerExchange exchange)` Handle the request.
`boolean`	`isReuseXForwarded()`
`boolean`	`isRewriteHostHeader()`
`ProxyHandler`	`removeRequestHeader(HttpString header)` Removes a request header
`ProxyHandler`	`setMaxConnectionRetries(int maxConnectionRetries)`
`ProxyHandler`	`setReuseXForwarded(boolean reuseXForwarded)`
`ProxyHandler`	`setRewriteHostHeader(boolean rewriteHostHeader)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UTF_8
```
public static final String UTF_8
```
- Constructor Detail
  - ProxyHandler
```
public ProxyHandler(ProxyClient proxyClient,
                    int maxRequestTime,
                    HttpHandler next)
```
  - ProxyHandler
```
public ProxyHandler(ProxyClient proxyClient,
                    int maxRequestTime,
                    HttpHandler next,
                    boolean rewriteHostHeader,
                    boolean reuseXForwarded)
```
    Parameters:
    
    proxyClient - the client to use to make the proxy call
    
    maxRequestTime - the maximum amount of time to allow the request to be processed
    
    next - the next handler in line
    
    rewriteHostHeader - should the HOST header be rewritten to use the target host of the call.
    
    reuseXForwarded - should any existing X-Forwarded-For header be used or should it be overwritten.
  - ProxyHandler
```
public ProxyHandler(ProxyClient proxyClient,
                    int maxRequestTime,
                    HttpHandler next,
                    boolean rewriteHostHeader,
                    boolean reuseXForwarded,
                    int maxConnectionRetries)
```
    Parameters:
    
    proxyClient - the client to use to make the proxy call
    
    maxRequestTime - the maximum amount of time to allow the request to be processed
    
    next - the next handler in line
    
    rewriteHostHeader - should the HOST header be rewritten to use the target host of the call.
    
    reuseXForwarded - should any existing X-Forwarded-For header be used or should it be overwritten.
    
    maxConnectionRetries -
  - ProxyHandler
```
public ProxyHandler(ProxyClient proxyClient,
                    HttpHandler next)
```
- Method Detail
  - handleRequest
```
public void handleRequest(HttpServerExchange exchange)
                   throws Exception
```
    Description copied from interface: HttpHandler
    
    Handle the request.
    
    Specified by:
    
    handleRequest in interface HttpHandler
    
    Parameters:
    
    exchange - the HTTP request/response exchange
    
    Throws:
    
    Exception
  - addRequestHeader
```
public ProxyHandler addRequestHeader(HttpString header,
                                     ExchangeAttribute attribute)
```
    Adds a request header to the outgoing request. If the header resolves to null or an empty string it will not be added, however any existing header with the same name will be removed.
    
    Parameters:
    
    header - The header name
    
    attribute - The header value attribute.
    
    Returns:
    
    this
  - addRequestHeader
```
public ProxyHandler addRequestHeader(HttpString header,
                                     String value)
```
    Adds a request header to the outgoing request. If the header resolves to null or an empty string it will not be added, however any existing header with the same name will be removed.
    
    Parameters:
    
    header - The header name
    
    value - The header value attribute.
    
    Returns:
    
    this
  - addRequestHeader
```
public ProxyHandler addRequestHeader(HttpString header,
                                     String attribute,
                                     ClassLoader classLoader)
```
    Adds a request header to the outgoing request. If the header resolves to null or an empty string it will not be added, however any existing header with the same name will be removed.
    The attribute value will be parsed, and the resulting exchange attribute will be used to create the actual header value.
    
    Parameters:
    
    header - The header name
    
    attribute - The header value attribute.
    
    Returns:
    
    this
  - removeRequestHeader
```
public ProxyHandler removeRequestHeader(HttpString header)
```
    Removes a request header
    
    Parameters:
    
    header - the header
    
    Returns:
    
    this
  - getProxyClient
```
public ProxyClient getProxyClient()
```
  - setMaxConnectionRetries
```
public ProxyHandler setMaxConnectionRetries(int maxConnectionRetries)
```
  - isRewriteHostHeader
```
public boolean isRewriteHostHeader()
```
  - setRewriteHostHeader
```
public ProxyHandler setRewriteHostHeader(boolean rewriteHostHeader)
```
  - isReuseXForwarded
```
public boolean isReuseXForwarded()
```
  - setReuseXForwarded
```
public ProxyHandler setReuseXForwarded(boolean reuseXForwarded)
```
  - getMaxConnectionRetries
```
public int getMaxConnectionRetries()
```
  - getIdempotentRequestPredicate
```
public Predicate getIdempotentRequestPredicate()
```

Class ProxyHandler

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UTF_8

Constructor Detail

ProxyHandler

ProxyHandler

ProxyHandler

ProxyHandler

Method Detail

handleRequest

addRequestHeader

addRequestHeader

addRequestHeader

removeRequestHeader

getProxyClient

setMaxConnectionRetries

isRewriteHostHeader

setRewriteHostHeader

isReuseXForwarded

setReuseXForwarded

getMaxConnectionRetries

getIdempotentRequestPredicate