logbook.server.proxy

クラス ProxyServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

logbook.server.proxy.ProxyServlet

すべての実装されたインタフェース:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

直系の既知のサブクラス:

ProxyServlet.Transparent, ReverseProxyServlet

public class ProxyServlet
extends javax.servlet.http.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 ContextHandler.MANAGED_ATTRIBUTES.

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.

関連項目:

ConnectHandler, 直列化された形式

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	ProxyServlet.Transparent Transparent Proxy.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected org.eclipse.jetty.util.log.Logger	_log
protected static java.lang.String	ASYNC_CONTEXT

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ProxyServlet()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected org.eclipse.jetty.client.HttpClient	createHttpClient() Creates a HttpClient instance, configured with init parameters of this servlet.
protected org.eclipse.jetty.util.log.Logger	createLogger()
protected void	customizeProxyRequest(org.eclipse.jetty.client.api.Request proxyRequest, javax.servlet.http.HttpServletRequest request) Extension point for subclasses to customize the proxy request.
void	destroy()
protected java.lang.String	filterResponseHeader(javax.servlet.http.HttpServletRequest request, java.lang.String headerName, java.lang.String headerValue) Extension point for remote server response header filtering.
java.util.Set<java.lang.String>	getBlackListHosts()
protected int	getRequestId(javax.servlet.http.HttpServletRequest request)
long	getTimeout()
java.util.Set<java.lang.String>	getWhiteListHosts()
void	init()
protected org.eclipse.jetty.client.HttpClient	newHttpClient()
protected void	onResponseContent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.eclipse.jetty.client.api.Response proxyResponse, byte[] buffer, int offset, int length)
protected void	onResponseFailure(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.eclipse.jetty.client.api.Response proxyResponse, java.lang.Throwable failure)
protected void	onResponseHeaders(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.eclipse.jetty.client.api.Response proxyResponse)
protected void	onResponseSuccess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.eclipse.jetty.client.api.Response proxyResponse)
protected java.net.URI	rewriteURI(javax.servlet.http.HttpServletRequest request)
protected void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setTimeout(long timeout)
boolean	validateDestination(java.lang.String host, int port) Checks the given host and port against whitelist and blacklist.
protected static java.lang.String	viaHost()

クラスから継承されたメソッド javax.servlet.http.HttpServlet

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

クラスから継承されたメソッド javax.servlet.GenericServlet

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

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

ASYNC_CONTEXT

protected static final java.lang.String ASYNC_CONTEXT

_log

protected org.eclipse.jetty.util.log.Logger _log

コンストラクタの詳細

ProxyServlet

public ProxyServlet()

メソッドの詳細

init

public void init()
          throws javax.servlet.ServletException

オーバーライド:

init クラス内 javax.servlet.GenericServlet

例外:

javax.servlet.ServletException

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

getWhiteListHosts

public java.util.Set<java.lang.String> getWhiteListHosts()

getBlackListHosts

public java.util.Set<java.lang.String> getBlackListHosts()

viaHost

protected static java.lang.String viaHost()

createLogger

protected org.eclipse.jetty.util.log.Logger createLogger()

戻り値:

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

destroy

public void destroy()

定義:

destroy インタフェース内 javax.servlet.Servlet

オーバーライド:

destroy クラス内 javax.servlet.GenericServlet

createHttpClient

protected org.eclipse.jetty.client.HttpClient createHttpClient()
                                                        throws javax.servlet.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
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)

戻り値:

a HttpClient configured from the servlet configuration

例外:

javax.servlet.ServletException - if the HttpClient cannot be created

newHttpClient

protected org.eclipse.jetty.client.HttpClient newHttpClient()

戻り値:

a new HttpClient instance

validateDestination

public boolean validateDestination(java.lang.String host,
                                   int port)

Checks the given host and port against whitelist and blacklist.

パラメータ:

host - the host to check

port - the port to check

戻り値:

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

service

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

オーバーライド:

service クラス内 javax.servlet.http.HttpServlet

例外:

javax.servlet.ServletException

java.io.IOException

onResponseHeaders

protected void onResponseHeaders(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 org.eclipse.jetty.client.api.Response proxyResponse)

onResponseContent

protected void onResponseContent(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 org.eclipse.jetty.client.api.Response proxyResponse,
                                 byte[] buffer,
                                 int offset,
                                 int length)
                          throws java.io.IOException

例外:

java.io.IOException

onResponseSuccess

protected void onResponseSuccess(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 org.eclipse.jetty.client.api.Response proxyResponse)

onResponseFailure

protected void onResponseFailure(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 org.eclipse.jetty.client.api.Response proxyResponse,
                                 java.lang.Throwable failure)

getRequestId

protected int getRequestId(javax.servlet.http.HttpServletRequest request)

rewriteURI

protected java.net.URI rewriteURI(javax.servlet.http.HttpServletRequest request)

customizeProxyRequest

protected void customizeProxyRequest(org.eclipse.jetty.client.api.Request proxyRequest,
                                     javax.servlet.http.HttpServletRequest request)

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

パラメータ:

proxyRequest - the proxy request to customize

request - the request to be proxied

filterResponseHeader

protected java.lang.String filterResponseHeader(javax.servlet.http.HttpServletRequest request,
                                                java.lang.String headerName,
                                                java.lang.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.

パラメータ:

headerName - the header name

headerValue - the header value

request - the request to proxy

戻り値:

filteredHeaderValue the new header value