Class BalancerServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.proxy.AbstractProxyServlet

org.eclipse.jetty.proxy.ProxyServlet

org.eclipse.jetty.proxy.BalancerServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class BalancerServlet
extends ProxyServlet

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	BalancerServlet.BalancerMember

Nested classes/interfaces inherited from class ProxyServlet

ProxyServlet.ProxyInputStreamContentProvider, ProxyServlet.ProxyResponseListener, ProxyServlet.Transparent

Nested classes/interfaces inherited from class AbstractProxyServlet

AbstractProxyServlet.ProxyContinueProtocolHandler, AbstractProxyServlet.TransparentDelegate

Field Summary

Fields

Modifier and Type	Field	Description
private final List<BalancerServlet.BalancerMember>	_balancerMembers
private boolean	_proxyPassReverse
private boolean	_stickySessions
private static final String	BALANCER_MEMBER_PREFIX
private final AtomicLong	counter
private static final List<String>	FORBIDDEN_CONFIG_PARAMETERS
private static final String	JSESSIONID
private static final String	JSESSIONID_URL_PREFIX
private static final List<String>	REVERSE_PROXY_HEADERS

Fields inherited from class AbstractProxyServlet

_log, CLIENT_REQUEST_ATTRIBUTE, HOP_HEADERS

Constructor Summary

Constructors

Constructor	Description
BalancerServlet()

Method Summary

Modifier and Type	Method	Description
private String	extractBalancerMemberNameFromSessionId(String sessionId)
protected String	filterServerResponseHeader(javax.servlet.http.HttpServletRequest request, Response serverResponse, String headerName, String headerValue)
private BalancerServlet.BalancerMember	findBalancerMemberByName(String name)
private String	getBalancerMemberNameFromSessionCookie(javax.servlet.http.HttpServletRequest request)
private String	getBalancerMemberNameFromSessionId(javax.servlet.http.HttpServletRequest request)
private String	getBalancerMemberNameFromURL(javax.servlet.http.HttpServletRequest request)
private Set<String>	getBalancerNames()
void	init()
private void	initBalancers()
private void	initProxyPassReverse()
private void	initStickySessions()
private boolean	isBackendLocation(URI locationURI)
protected String	rewriteTarget(javax.servlet.http.HttpServletRequest request)
private BalancerServlet.BalancerMember	selectBalancerMember(javax.servlet.http.HttpServletRequest request)
private void	validateConfig()
boolean	validateDestination(String host, int port)	Checks the given host and port against whitelist and blacklist.

Methods inherited from class ProxyServlet

newProxyResponseListener, onContinue, onResponseContent, proxyRequestContent, service

Methods inherited from class AbstractProxyServlet

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

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 Object

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

Field Details

BALANCER_MEMBER_PREFIX

private static final String BALANCER_MEMBER_PREFIX

See Also:

• Constant Field Values

FORBIDDEN_CONFIG_PARAMETERS

private static final List<String> FORBIDDEN_CONFIG_PARAMETERS

REVERSE_PROXY_HEADERS

private static final List<String> REVERSE_PROXY_HEADERS

JSESSIONID

private static final String JSESSIONID

See Also:

• Constant Field Values

JSESSIONID_URL_PREFIX

private static final String JSESSIONID_URL_PREFIX

See Also:

• Constant Field Values

_balancerMembers

private final List<BalancerServlet.BalancerMember> _balancerMembers

counter

private final AtomicLong counter

_stickySessions

private boolean _stickySessions

_proxyPassReverse

private boolean _proxyPassReverse

Constructor Details

BalancerServlet

public BalancerServlet()

Method Details

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class AbstractProxyServlet

Throws:

javax.servlet.ServletException

validateConfig

private void validateConfig()
                     throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

initStickySessions

private void initStickySessions()

initBalancers

private void initBalancers()
                    throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

initProxyPassReverse

private void initProxyPassReverse()

getBalancerNames

private Set<String> getBalancerNames()
                              throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

rewriteTarget

protected String rewriteTarget(javax.servlet.http.HttpServletRequest request)

Overrides:

rewriteTarget in class AbstractProxyServlet

selectBalancerMember

private BalancerServlet.BalancerMember selectBalancerMember(javax.servlet.http.HttpServletRequest request)

findBalancerMemberByName

private BalancerServlet.BalancerMember findBalancerMemberByName(String name)

getBalancerMemberNameFromSessionId

private String getBalancerMemberNameFromSessionId(javax.servlet.http.HttpServletRequest request)

getBalancerMemberNameFromSessionCookie

private String getBalancerMemberNameFromSessionCookie(javax.servlet.http.HttpServletRequest request)

getBalancerMemberNameFromURL

private String getBalancerMemberNameFromURL(javax.servlet.http.HttpServletRequest request)

extractBalancerMemberNameFromSessionId

private String extractBalancerMemberNameFromSessionId(String sessionId)

filterServerResponseHeader

protected String filterServerResponseHeader(javax.servlet.http.HttpServletRequest request,
 Response serverResponse,
 String headerName,
 String headerValue)

Overrides:

filterServerResponseHeader in class AbstractProxyServlet

isBackendLocation

private boolean isBackendLocation(URI locationURI)

validateDestination

public boolean validateDestination(String host,
 int port)

Description copied from class: AbstractProxyServlet

Checks the given host and port against whitelist and blacklist.

Overrides:

validateDestination in class AbstractProxyServlet

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