org.eclipse.jetty.server

Class ForwardedRequestCustomizer

java.lang.Object

org.eclipse.jetty.server.ForwardedRequestCustomizer

All Implemented Interfaces:

HttpConfiguration.Customizer

public class ForwardedRequestCustomizer
extends Object
implements HttpConfiguration.Customizer

Customize Requests for Proxy Forwarding.

This customizer looks at at HTTP request for headers that indicate it has been forwarded by one or more proxies. Specifically handled are:

• X-Forwarded-Host
• X-Forwarded-Server
• X-Forwarded-For
• X-Forwarded-Proto

If these headers are present, then the Request object is updated so that the proxy is not seen as the other end point of the connection on which the request came

Headers can also be defined so that forwarded SSL Session IDs and Cipher suites may be customised

See Also:

Wikipedia: X-Forwarded-For

Constructor Summary

Constructors

Constructor and Description
ForwardedRequestCustomizer()

Method Summary

Methods

Modifier and Type	Method and Description
void	customize(Connector connector, HttpConfiguration config, Request request)
String	getForwardedCipherSuiteHeader()
String	getForwardedForHeader()
String	getForwardedHostHeader()
String	getForwardedProtoHeader() Get the forwardedProtoHeader.
String	getForwardedServerHeader()
String	getForwardedSslSessionIdHeader()
String	getHostHeader()
protected String	getLeftMostFieldValue(HttpFields fields, String header)
void	setForwardedCipherSuiteHeader(String forwardedCipherSuite)
void	setForwardedForHeader(String forwardedRemoteAddressHeader)
void	setForwardedHostHeader(String forwardedHostHeader)
void	setForwardedProtoHeader(String forwardedProtoHeader) Set the forwardedProtoHeader.
void	setForwardedServerHeader(String forwardedServerHeader)
void	setForwardedSslSessionIdHeader(String forwardedSslSessionId)
void	setHostHeader(String hostHeader) Set a forced valued for the host header to control what is returned by ServletRequest#getServerName() and ServletRequest#getServerPort().
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardedRequestCustomizer

public ForwardedRequestCustomizer()

Method Detail

getHostHeader

public String getHostHeader()

setHostHeader

public void setHostHeader(String hostHeader)

Set a forced valued for the host header to control what is returned by ServletRequest#getServerName() and ServletRequest#getServerPort().

Parameters:

hostHeader - The value of the host header to force.

getForwardedHostHeader

public String getForwardedHostHeader()

setForwardedHostHeader

public void setForwardedHostHeader(String forwardedHostHeader)

Parameters:

forwardedHostHeader - The header name for forwarded hosts (default x-forwarded-host)

getForwardedServerHeader

public String getForwardedServerHeader()

Returns:

the header name for forwarded server.

setForwardedServerHeader

public void setForwardedServerHeader(String forwardedServerHeader)

Parameters:

forwardedServerHeader - The header name for forwarded server (default x-forwarded-server)

getForwardedForHeader

public String getForwardedForHeader()

Returns:

the forwarded for header

setForwardedForHeader

public void setForwardedForHeader(String forwardedRemoteAddressHeader)

Parameters:

forwardedRemoteAddressHeader - The header name for forwarded for (default x-forwarded-for)

getForwardedProtoHeader

public String getForwardedProtoHeader()

Get the forwardedProtoHeader.

Returns:

the forwardedProtoHeader (default X-Forwarded-For)

setForwardedProtoHeader

public void setForwardedProtoHeader(String forwardedProtoHeader)

Set the forwardedProtoHeader.

Parameters:

forwardedProtoHeader - the forwardedProtoHeader to set (default X-Forwarded-For)

getForwardedCipherSuiteHeader

public String getForwardedCipherSuiteHeader()

Returns:

The header name holding a forwarded cipher suite (default null)

setForwardedCipherSuiteHeader

public void setForwardedCipherSuiteHeader(String forwardedCipherSuite)

Parameters:

forwardedCipherSuite - The header name holding a forwarded cipher suite (default null)

getForwardedSslSessionIdHeader

public String getForwardedSslSessionIdHeader()

Returns:

The header name holding a forwarded SSL Session ID (default null)

setForwardedSslSessionIdHeader

public void setForwardedSslSessionIdHeader(String forwardedSslSessionId)

Parameters:

forwardedSslSessionId - The header name holding a forwarded SSL Session ID (default null)

customize

public void customize(Connector connector,
             HttpConfiguration config,
             Request request)

Specified by:

customize in interface HttpConfiguration.Customizer

getLeftMostFieldValue

protected String getLeftMostFieldValue(HttpFields fields,
                           String header)

toString

public String toString()

Overrides:

toString in class Object