org.eclipse.jetty.proxy

Class ProxyServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.proxy.ProxyServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

Direct Known Subclasses:

AsyncProxyServlet, BalancerServlet, ProxyServlet.Transparent

public class ProxyServlet
extends HttpServlet

Asynchronous ProxyServlet.

Forwards requests to another server either as a standard web reverse proxy (as defined by RFC2616) or as a transparent reverse proxy.

To facilitate JMX monitoring, the HttpClient instance is set as context attribute, prefixed with the servlet's name and exposed by the mechanism provided by ServletContext.setAttribute(String, Object).

The following init parameters may be used to configure the servlet:

• hostHeader - forces the host header to a particular value
• viaHost - the name to use in the Via header: Via: http/1.1 <viaHost>
• whiteList - comma-separated list of allowed proxy hosts
• blackList - comma-separated list of forbidden proxy hosts

In addition, see createHttpClient() for init parameters used to configure the HttpClient instance.

See Also:

ConnectHandler, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ProxyServlet.ProxyInputStreamContentProvider
protected class	ProxyServlet.ProxyResponseListener
static class	ProxyServlet.Transparent This convenience extension to ProxyServlet configures the servlet as a transparent proxy.
protected static class	ProxyServlet.TransparentDelegate

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	_log

Constructor Summary

Constructors

Constructor and Description
ProxyServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected Request	addViaHeader(Request proxyRequest)
protected void	addXForwardedHeaders(Request proxyRequest, HttpServletRequest request)
protected HttpClient	createHttpClient() Creates a HttpClient instance, configured with init parameters of this servlet.
protected Logger	createLogger()
protected void	customizeProxyRequest(Request proxyRequest, HttpServletRequest request) Extension point for subclasses to customize the proxy request.
void	destroy()
protected String	filterResponseHeader(HttpServletRequest request, String headerName, String headerValue) Extension point for remote server response header filtering.
Set<String>	getBlackListHosts()
protected HttpClient	getHttpClient()
protected int	getRequestId(HttpServletRequest request)
long	getTimeout()
String	getViaHost()
Set<String>	getWhiteListHosts()
void	init()
protected HttpClient	newHttpClient()
protected Response.Listener	newProxyResponseListener(HttpServletRequest request, HttpServletResponse response)
protected void	onClientRequestFailure(Request proxyRequest, HttpServletRequest request, Throwable failure)
protected void	onResponseContent(HttpServletRequest request, HttpServletResponse response, Response proxyResponse, byte[] buffer, int offset, int length, Callback callback)
protected void	onResponseFailure(HttpServletRequest request, HttpServletResponse response, Response proxyResponse, Throwable failure)
protected void	onResponseHeaders(HttpServletRequest request, HttpServletResponse response, Response proxyResponse)
protected void	onResponseSuccess(HttpServletRequest request, HttpServletResponse response, Response proxyResponse)
protected void	onRewriteFailed(HttpServletRequest request, HttpServletResponse response)
protected ContentProvider	proxyRequestContent(Request proxyRequest, HttpServletRequest request)
protected URI	rewriteURI(HttpServletRequest request)
protected void	service(HttpServletRequest request, HttpServletResponse response)
void	setTimeout(long timeout)
boolean	validateDestination(String host, int port) Checks the given host and port against whitelist and blacklist.
protected static String	viaHost()

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

_log

protected Logger _log

Constructor Detail

ProxyServlet

public ProxyServlet()

Method Detail

init

public void init()
          throws ServletException

Overrides:

init in class GenericServlet

Throws:

ServletException

getViaHost

public String getViaHost()

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

getWhiteListHosts

public Set<String> getWhiteListHosts()

getBlackListHosts

public Set<String> getBlackListHosts()

viaHost

protected static String viaHost()

getHttpClient

protected HttpClient getHttpClient()

createLogger

protected Logger createLogger()

Returns:

a logger instance with a name derived from this servlet's name.

destroy

public void destroy()

Specified by:

destroy in interface Servlet

Overrides:

destroy in class GenericServlet

createHttpClient

protected HttpClient createHttpClient()
                               throws ServletException

Creates a HttpClient instance, configured with init parameters of this servlet.

The init parameters used to configure the HttpClient instance are:

init-param	default	description
maxThreads	256	The max number of threads of HttpClient's Executor. If not set, or set to the value of "-", then the Jetty server thread pool will be used.
maxConnections	32768	The max number of connections per destination, see HttpClient.setMaxConnectionsPerDestination(int)
idleTimeout	30000	The idle timeout in milliseconds, see HttpClient.setIdleTimeout(long)
timeout	60000	The total timeout in milliseconds, see Request.timeout(long, TimeUnit)
requestBufferSize	HttpClient's default	The request buffer size, see HttpClient.setRequestBufferSize(int)
responseBufferSize	HttpClient's default	The response buffer size, see HttpClient.setResponseBufferSize(int)

Returns:

a HttpClient configured from the servlet configuration

Throws:

ServletException - if the HttpClient cannot be created

newHttpClient

protected HttpClient newHttpClient()

Returns:

a new HttpClient instance

validateDestination

public boolean validateDestination(String host,
                          int port)

Checks the given host and port against whitelist and blacklist.

Parameters:

host - the host to check

port - the port to check

Returns:

true if it is allowed to be proxy to the given host and port

service

protected void service(HttpServletRequest request,
           HttpServletResponse response)
                throws ServletException,
                       IOException

Overrides:

service in class HttpServlet

Throws:

ServletException

IOException

proxyRequestContent

protected ContentProvider proxyRequestContent(Request proxyRequest,
                                  HttpServletRequest request)
                                       throws IOException

Throws:

IOException

newProxyResponseListener

protected Response.Listener newProxyResponseListener(HttpServletRequest request,
                                         HttpServletResponse response)

onClientRequestFailure

protected void onClientRequestFailure(Request proxyRequest,
                          HttpServletRequest request,
                          Throwable failure)

onRewriteFailed

protected void onRewriteFailed(HttpServletRequest request,
                   HttpServletResponse response)
                        throws IOException

Throws:

IOException

addViaHeader

protected Request addViaHeader(Request proxyRequest)

addXForwardedHeaders

protected void addXForwardedHeaders(Request proxyRequest,
                        HttpServletRequest request)

onResponseHeaders

protected void onResponseHeaders(HttpServletRequest request,
                     HttpServletResponse response,
                     Response proxyResponse)

onResponseContent

protected void onResponseContent(HttpServletRequest request,
                     HttpServletResponse response,
                     Response proxyResponse,
                     byte[] buffer,
                     int offset,
                     int length,
                     Callback callback)

onResponseSuccess

protected void onResponseSuccess(HttpServletRequest request,
                     HttpServletResponse response,
                     Response proxyResponse)

onResponseFailure

protected void onResponseFailure(HttpServletRequest request,
                     HttpServletResponse response,
                     Response proxyResponse,
                     Throwable failure)

getRequestId

protected int getRequestId(HttpServletRequest request)

rewriteURI

protected URI rewriteURI(HttpServletRequest request)

customizeProxyRequest

protected void customizeProxyRequest(Request proxyRequest,
                         HttpServletRequest request)

Extension point for subclasses to customize the proxy request. The default implementation does nothing.

Parameters:

proxyRequest - the proxy request to customize

request - the request to be proxied

filterResponseHeader

protected String filterResponseHeader(HttpServletRequest request,
                          String headerName,
                          String headerValue)

Extension point for remote server response header filtering. The default implementation returns the header value as is. If null is returned, this header won't be forwarded back to the client.

Parameters:

headerName - the header name

headerValue - the header value

request - the request to proxy

Returns:

filteredHeaderValue the new header value