org.apache.portals.applications.webcontent2.proxy.servlet

Class SimpleReverseProxyServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.portals.applications.webcontent2.proxy.servlet.GenericReverseProxyServlet

org.apache.portals.applications.webcontent2.proxy.servlet.SimpleReverseProxyServlet

All Implemented Interfaces:

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

public class SimpleReverseProxyServlet
extends GenericReverseProxyServlet

Simple reverse proxy servlet implementation as an example and a base class to be overriden.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAPPINGS_PARAM_NAME Reverse proxy mapping initialization parameter name.

Constructor Summary

Constructors

Constructor and Description
SimpleReverseProxyServlet() Zero-argument default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.http.impl.client.HttpClientBuilder	createHttpClientBuilder() Creates HttpClientBuilder instance.
protected ProxyProcessingChain	createProxyServiceCommand() init(ServletConfig) method invokes this method to create the root reverse proxy processing chain (ProxyProcessingChain).
protected org.apache.http.conn.socket.LayeredConnectionSocketFactory	createSslSocketFactory() Creates the default internal SSL Socket Connection Factory (LayeredConnectionSocketFactory).
void	destroy() Disposes all the Commands in the root reverse proxy processing chain.
org.apache.http.conn.ssl.X509HostnameVerifier	getHostnameVerifier() Returns the internal SSL Hostname Verifier.
org.apache.http.impl.client.HttpClientBuilder	getHttpClientBuilder() Returns the internal HttpClientBuilder instance.
HttpClientContextBuilder	getHttpClientContextBuilder() Returns the internal HttpClientContextBuilder instance.
ProxyMappingRegistry	getProxyMappingRegistry() Returns the internal ProxyMappingRegistry instance.
org.apache.http.conn.socket.LayeredConnectionSocketFactory	getSslSocketFactory() Returns the internal SSL Socket Connection Factory (LayeredConnectionSocketFactory).
void	init(javax.servlet.ServletConfig servletConfig) Creates the root reverse proxy processing chain instance, and initializes all the Commands inside the chain.
protected void	initHostnameVerifier(javax.servlet.ServletConfig servletConfig) Initializes SSL hostnameVerifier (type of X509HostnameVerifier) from the init parameter, "ssl-hostname-verifier".
void	setHostnameVerifier(org.apache.http.conn.ssl.X509HostnameVerifier hostnameVerifier) Sets the internal SSL Hostname Verifier.
void	setHttpClientBuilder(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder) Sets the internal HttpClientBuilder instance.
void	setHttpClientContextBuilder(HttpClientContextBuilder httpClientContextBuilder) Sets the internal HttpClientContextBuilder instance.
void	setProxyMappingRegistry(ProxyMappingRegistry proxyMappingRegistry) Sets the internal ProxyMappingRegistry instance.
void	setSslSocketFactory(org.apache.http.conn.socket.LayeredConnectionSocketFactory sslSocketFactory) Sets the internal SSL Socket Connection Factory (LayeredConnectionSocketFactory).

Methods inherited from class org.apache.portals.applications.webcontent2.proxy.servlet.GenericReverseProxyServlet

getProxyService, isAllowedHttpMethod, service, setProxyService

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

MAPPINGS_PARAM_NAME

public static final String MAPPINGS_PARAM_NAME

Reverse proxy mapping initialization parameter name.

See Also:

Constant Field Values

Constructor Detail

SimpleReverseProxyServlet

public SimpleReverseProxyServlet()

Zero-argument default constructor.

Method Detail

init

public void init(javax.servlet.ServletConfig servletConfig)
          throws javax.servlet.ServletException

Creates the root reverse proxy processing chain instance, and initializes all the Commands inside the chain.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

initHostnameVerifier

protected void initHostnameVerifier(javax.servlet.ServletConfig servletConfig)

Initializes SSL hostnameVerifier (type of X509HostnameVerifier) from the init parameter, "ssl-hostname-verifier".

The init parameter can be any of "ALLOW_ALL_HOSTNAME_VERIFIER", "BROWSER_COMPATIBLE_HOSTNAME_VERIFIER" or "STRICT_HOSTNAME_VERIFIER", case-insensitively. The default value is "BROWSER_COMPATIBLE_HOSTNAME_VERIFIER".

Parameters:

servletConfig -

getProxyMappingRegistry

public ProxyMappingRegistry getProxyMappingRegistry()

Returns the internal ProxyMappingRegistry instance.

Returns:

setProxyMappingRegistry

public void setProxyMappingRegistry(ProxyMappingRegistry proxyMappingRegistry)

Sets the internal ProxyMappingRegistry instance.

Parameters:

proxyMappingRegistry -

getHttpClientBuilder

public org.apache.http.impl.client.HttpClientBuilder getHttpClientBuilder()

Returns the internal HttpClientBuilder instance.

Returns:

setHttpClientBuilder

public void setHttpClientBuilder(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder)

Sets the internal HttpClientBuilder instance.

Parameters:

httpClientBuilder -

getHttpClientContextBuilder

public HttpClientContextBuilder getHttpClientContextBuilder()

Returns the internal HttpClientContextBuilder instance.

Returns:

setHttpClientContextBuilder

public void setHttpClientContextBuilder(HttpClientContextBuilder httpClientContextBuilder)

Sets the internal HttpClientContextBuilder instance.

Parameters:

httpClientContextBuilder -

getSslSocketFactory

public org.apache.http.conn.socket.LayeredConnectionSocketFactory getSslSocketFactory()

Returns the internal SSL Socket Connection Factory (LayeredConnectionSocketFactory). If not set, it invokes createSslSocketFactory() to create a default one.

Returns:

setSslSocketFactory

public void setSslSocketFactory(org.apache.http.conn.socket.LayeredConnectionSocketFactory sslSocketFactory)

Sets the internal SSL Socket Connection Factory (LayeredConnectionSocketFactory).

Parameters:

sslSocketFactory -

getHostnameVerifier

public org.apache.http.conn.ssl.X509HostnameVerifier getHostnameVerifier()

Returns the internal SSL Hostname Verifier.

Returns:

setHostnameVerifier

public void setHostnameVerifier(org.apache.http.conn.ssl.X509HostnameVerifier hostnameVerifier)

Sets the internal SSL Hostname Verifier.

Parameters:

hostnameVerifier -

destroy

public void destroy()

Disposes all the Commands in the root reverse proxy processing chain.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

createProxyServiceCommand

protected ProxyProcessingChain createProxyServiceCommand()

init(ServletConfig) method invokes this method to create the root reverse proxy processing chain (ProxyProcessingChain).

Returns:

createHttpClientBuilder

protected org.apache.http.impl.client.HttpClientBuilder createHttpClientBuilder()

Creates HttpClientBuilder instance. This method is invoked by getHttpClientBuilder() if an HttpClientBuilder instance was not set before.

Returns:

createSslSocketFactory

protected org.apache.http.conn.socket.LayeredConnectionSocketFactory createSslSocketFactory()

Creates the default internal SSL Socket Connection Factory (LayeredConnectionSocketFactory).

Returns: