Class ProxyServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.eclipse.jetty.ee9.proxy.AbstractProxyServlet

org.eclipse.jetty.ee9.proxy.ProxyServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

Direct Known Subclasses:

AsyncProxyServlet, BalancerServlet, ProxyServlet.Transparent

public class ProxyServlet
extends AbstractProxyServlet

Servlet 3.0 asynchronous proxy servlet.

The request processing is asynchronous, but the I/O is blocking.

See Also:

• AsyncProxyServlet
• AsyncMiddleManServlet
• ConnectHandler
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ProxyServlet.ProxyInputStreamRequestContent
protected class	ProxyServlet.ProxyResponseListener
static class	ProxyServlet.Transparent	Convenience extension of ProxyServlet that offers transparent proxy functionalities.

Nested classes/interfaces inherited from class AbstractProxyServlet

AbstractProxyServlet.TransparentDelegate

Field Summary

Fields inherited from class AbstractProxyServlet

_log, CLIENT_REQUEST_ATTRIBUTE, HOP_HEADERS

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
ProxyServlet()

Method Summary

Modifier and Type	Method	Description
protected Response.Listener	newProxyResponseListener(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected Runnable	onContinue(jakarta.servlet.http.HttpServletRequest clientRequest, Request proxyRequest)	Returns the action to perform when the proxy receives a 100 Continue response from the server.
protected void	onResponseContent(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Response proxyResponse, byte[] buffer, int offset, int length, Callback callback)
protected Request.Content	proxyRequestContent(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Request proxyRequest)	Wraps the client-to-proxy request content in a Request.Content for the proxy-to-server request.
protected void	service(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

Methods inherited from class AbstractProxyServlet

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

Methods inherited from class jakarta.servlet.http.HttpServlet

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

Methods inherited from class jakarta.servlet.GenericServlet

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

Methods inherited from class Object

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

Constructor Details

ProxyServlet

public ProxyServlet()

Method Details

service

protected void service(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                throws jakarta.servlet.ServletException,
IOException

Overrides:

service in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

proxyRequestContent

protected Request.Content proxyRequestContent(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Request proxyRequest)
                                       throws IOException

Wraps the client-to-proxy request content in a Request.Content for the proxy-to-server request.

Parameters:

request - the client-to-proxy request

response - the proxy-to-client response

proxyRequest - the proxy-to-server request

Returns:

a proxy-to-server request content

Throws:

IOException - if the proxy-to-server request content cannot be created

newProxyResponseListener

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

Specified by:

newProxyResponseListener in class AbstractProxyServlet

onResponseContent

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

onContinue

protected Runnable onContinue(jakarta.servlet.http.HttpServletRequest clientRequest,
 Request proxyRequest)

Description copied from class: AbstractProxyServlet

Returns the action to perform when the proxy receives a 100 Continue response from the server.

Overrides:

onContinue in class AbstractProxyServlet

Parameters:

clientRequest - the client request

proxyRequest - the request being proxied

Returns:

the 100 Continue action to run