org.eclipse.jetty.proxy

Class ProxyServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.proxy.AbstractProxyServlet

org.eclipse.jetty.proxy.ProxyServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

Direct Known Subclasses:

AsyncProxyServlet, BalancerServlet, ProxyServlet.Transparent

public class ProxyServlet
extends AbstractProxyServlet

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 AbstractProxyServlet.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 inherited from class org.eclipse.jetty.proxy.AbstractProxyServlet

_log, HOP_HEADERS

Constructor Summary

Constructors

Constructor and Description
ProxyServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyHeaders(HttpServletRequest clientRequest, Request proxyRequest) Deprecated. use AbstractProxyServlet.copyRequestHeaders(HttpServletRequest, Request) instead
protected void	customizeProxyRequest(Request proxyRequest, HttpServletRequest request) Deprecated. use AbstractProxyServlet.sendProxyRequest(HttpServletRequest, HttpServletResponse, Request)
protected String	filterResponseHeader(HttpServletRequest request, String headerName, String headerValue) Extension point for remote server response header filtering.
protected String	filterServerResponseHeader(HttpServletRequest clientRequest, Response serverResponse, String headerName, String headerValue)
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) Deprecated. Use AbstractProxyServlet.onProxyResponseFailure(HttpServletRequest, HttpServletResponse, Response, Throwable)
protected void	onResponseHeaders(HttpServletRequest request, HttpServletResponse response, Response proxyResponse) Deprecated. use AbstractProxyServlet.onServerResponseHeaders(HttpServletRequest, HttpServletResponse, Response)
protected void	onResponseSuccess(HttpServletRequest request, HttpServletResponse response, Response proxyResponse) Deprecated. Use AbstractProxyServlet.onProxyResponseSuccess(HttpServletRequest, HttpServletResponse, Response)
protected void	onRewriteFailed(HttpServletRequest request, HttpServletResponse response) Deprecated. use AbstractProxyServlet.onProxyRewriteFailed(HttpServletRequest, HttpServletResponse)
protected ContentProvider	proxyRequestContent(Request proxyRequest, HttpServletRequest request)
protected URI	rewriteURI(HttpServletRequest request) Deprecated. use AbstractProxyServlet.rewriteTarget(HttpServletRequest)
protected void	service(HttpServletRequest request, HttpServletResponse response)

Methods inherited from class org.eclipse.jetty.proxy.AbstractProxyServlet

addProxyHeaders, addViaHeader, addXForwardedHeaders, copyRequestHeaders, createHttpClient, createLogger, destroy, findConnectionHeaders, getBlackListHosts, getHostHeader, getHttpClient, getRequestId, getTimeout, getViaHost, getWhiteListHosts, hasContent, init, newHttpClient, onClientRequestFailure, onProxyResponseFailure, onProxyResponseSuccess, onProxyRewriteFailed, onServerResponseHeaders, rewriteTarget, sendProxyRequest, setTimeout, validateDestination

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

Constructor Detail

ProxyServlet

public ProxyServlet()

Method Detail

service

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

Overrides:

service in class HttpServlet

Throws:

ServletException

IOException

copyHeaders

@Deprecated
protected void copyHeaders(HttpServletRequest clientRequest,
                          Request proxyRequest)

Deprecated. use AbstractProxyServlet.copyRequestHeaders(HttpServletRequest, Request) instead

proxyRequestContent

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

Throws:

IOException

newProxyResponseListener

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

Specified by:

newProxyResponseListener in class AbstractProxyServlet

onClientRequestFailure

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

onRewriteFailed

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

Deprecated. use AbstractProxyServlet.onProxyRewriteFailed(HttpServletRequest, HttpServletResponse)

Throws:

IOException

onResponseHeaders

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

Deprecated. use AbstractProxyServlet.onServerResponseHeaders(HttpServletRequest, HttpServletResponse, Response)

filterServerResponseHeader

protected String filterServerResponseHeader(HttpServletRequest clientRequest,
                                Response serverResponse,
                                String headerName,
                                String headerValue)

Overrides:

filterServerResponseHeader in class AbstractProxyServlet

onResponseContent

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

onResponseSuccess

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

Deprecated. Use AbstractProxyServlet.onProxyResponseSuccess(HttpServletRequest, HttpServletResponse, Response)

onResponseFailure

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

Deprecated. Use AbstractProxyServlet.onProxyResponseFailure(HttpServletRequest, HttpServletResponse, Response, Throwable)

rewriteURI

@Deprecated
protected URI rewriteURI(HttpServletRequest request)

Deprecated. use AbstractProxyServlet.rewriteTarget(HttpServletRequest)

customizeProxyRequest

@Deprecated
protected void customizeProxyRequest(Request proxyRequest,
                                    HttpServletRequest request)

Deprecated. use AbstractProxyServlet.sendProxyRequest(HttpServletRequest, HttpServletResponse, Request)

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