org.apache.portals.applications.webcontent2.portlet.proxy

Class SimpleReverseProxyPortlet

java.lang.Object

javax.portlet.GenericPortlet

org.apache.portals.bridges.common.GenericServletPortlet

org.apache.portals.bridges.velocity.GenericVelocityPortlet

org.apache.portals.applications.webcontent2.portlet.proxy.GenericReverseProxyPortlet

org.apache.portals.applications.webcontent2.portlet.proxy.SimpleReverseProxyPortlet

All Implemented Interfaces:

javax.portlet.EventPortlet, javax.portlet.Portlet, javax.portlet.PortletConfig, javax.portlet.ResourceServingPortlet

public class SimpleReverseProxyPortlet
extends GenericReverseProxyPortlet

Simple reverse proxy portlet implementation with using HtmlCleanerContentRewriter as the default ContentRewriter. And this is given as an example and a base class to be overriden.

This portlet reads XPATH_EXPRESSION_PARAM_NAME parameter value (//body by default) to select only the specified DOM element and its descendants. Also, this portlet can transform the content by using HtmlCleaner transformation rules. Finally, this portlet can use TagNodeVisitors to give custom TagNodeVisitors a chance to transform the selected content.

Field Summary

Fields inherited from class org.apache.portals.applications.webcontent2.portlet.proxy.GenericReverseProxyPortlet

REMOTE_URI_PARAM_NAME

Fields inherited from class org.apache.portals.bridges.velocity.GenericVelocityPortlet

PORTLET_BRIDGE_CONTEXT

Fields inherited from class org.apache.portals.bridges.common.GenericServletPortlet

allowPreferences, defaultActionPage, defaultCustomPage, defaultEditPage, defaultHelpPage, defaultViewPage, PARAM_ACTION_PAGE, PARAM_ALLOW_PREFERENCES, PARAM_CUSTOM_PAGE, PARAM_EDIT_PAGE, PARAM_HELP_PAGE, PARAM_MAX_PAGE, PARAM_VIEW_PAGE

Constructor Summary

Constructors

Constructor and Description
SimpleReverseProxyPortlet() 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(PortletConfig) method invokes this method to create the root reverse proxy processing chain ({@link ProxyProcessingChain}).
protected org.apache.http.conn.socket.LayeredConnectionSocketFactory	createSslSocketFactory() Creates the default internal SSL Socket Connection Factory (LayeredConnectionSocketFactory).
void	destroy()
protected String[]	getCleanerTransformationStringArray() Returns HtmlCleaner transformation string array.
protected Map<String,ContentRewriter>	getContentRewriters() Returns a map containing only a ContentRewriter for text/html content by default.
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.
protected ProxyMapping	getProxyMapping() Returns a ProxyMapping instance (PortletAnyProxyMapping by default).
ProxyMappingRegistry	getProxyMappingRegistry() Returns the internal ProxyMappingRegistry instance.
org.apache.http.conn.socket.LayeredConnectionSocketFactory	getSslSocketFactory() Returns the internal SSL Socket Connection Factory (LayeredConnectionSocketFactory).
protected List<TagNodeVisitor>	getTagNodeVisitors() Returns a list of TagNodeVisitors which are given a chance to visit all the tag nodes.
protected String	getXpathExpression() Returns the XPath expression to select only the specific DOM element and its descendants from the remote content document.
void	init(javax.portlet.PortletConfig portletConfig)
protected void	initHostnameVerifier(javax.portlet.PortletConfig portletConfig) Initializes SSL hostnameVerifier (type of X509HostnameVerifier) from the init parameter, "ssl-hostname-verifier".
protected boolean	isInnerElementsOnly() Returns the flag whether or not only the inner elements should be selected by the XPath expression.
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.portlet.proxy.GenericReverseProxyPortlet

doView, getProxyService, invokeProxyService, processAction, serveResource, setProxyService

Methods inherited from class org.apache.portals.bridges.velocity.GenericVelocityPortlet

doCustom, doEdit, doHelp, doPreferencesEdit, getContext, getContext, render, setupPreferencesEdit

Methods inherited from class org.apache.portals.bridges.common.GenericServletPortlet

getDefaultActionPage, getDefaultCustomPage, getDefaultEditPage, getDefaultHelpPage, getDefaultViewPage, processPreferencesAction, setDefaultActionPage, setDefaultCustomPage, setDefaultEditPage, setDefaultHelpPage, setDefaultViewPage

Methods inherited from class javax.portlet.GenericPortlet

doDispatch, doHeaders, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, getTitle, init, processEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleReverseProxyPortlet

public SimpleReverseProxyPortlet()

Zero-argument default constructor.

Method Detail

init

public void init(javax.portlet.PortletConfig portletConfig)
          throws javax.portlet.PortletException

Specified by:

init in interface javax.portlet.Portlet

Overrides:

init in class org.apache.portals.bridges.velocity.GenericVelocityPortlet

Throws:

javax.portlet.PortletException

initHostnameVerifier

protected void initHostnameVerifier(javax.portlet.PortletConfig portletConfig)

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()

Specified by:

destroy in interface javax.portlet.Portlet

Overrides:

destroy in class javax.portlet.GenericPortlet

createProxyServiceCommand

protected ProxyProcessingChain createProxyServiceCommand()

#init(PortletConfig) method invokes this method to create the root reverse proxy processing chain ({@link ProxyProcessingChain}).

Returns:

getProxyMapping

protected ProxyMapping getProxyMapping()

Returns a ProxyMapping instance (PortletAnyProxyMapping by default).

Returns:

getContentRewriters

protected Map<String,ContentRewriter> getContentRewriters()

Returns a map containing only a ContentRewriter for text/html content by default. The ContentRewriter for HTML content is HtmlCleanerContentRewriter, by default, which is implemented with HtmlCleander library.

Returns:

getXpathExpression

protected String getXpathExpression()

Returns the XPath expression to select only the specific DOM element and its descendants from the remote content document. If not set, it returns //body by default.

Returns:

isInnerElementsOnly

protected boolean isInnerElementsOnly()

Returns the flag whether or not only the inner elements should be selected by the XPath expression.

Returns:

getCleanerTransformationStringArray

protected String[] getCleanerTransformationStringArray()

Returns HtmlCleaner transformation string array.

Returns:

getTagNodeVisitors

protected List<TagNodeVisitor> getTagNodeVisitors()

Returns a list of TagNodeVisitors which are given a chance to visit all the tag nodes. Custom s can be used to translate the selected content from the remote content.

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: