Web Content Portlet Preferences

IFrame Portlet Preferences

ReverseProxyIFrame Portlet Preferences

ReverseProxyService Configurations

Note: The ReverseProxyService should be able to access application level session attribute shared by a portlet of IFrameGenericPortlet or its descendant, which is conforming with the Portlet Specification. If you are using Tomcat, then be sure to set the following in the server.xml to enable this proper Portlet API session management requirements. Modify the Connector element (default on port 8080) by adding the folowing attribute:

emptySessionPath="true"

The ReverseProxyService component is initialized by the ReverseProxyServlet configured in the web.xml as follows:

<!-- Default Reverse Proxy Servlet -->
<servlet>
  <servlet-name>ReverseProxyServlet</servlet-name>
  <servlet-class>org.apache.portals.applications.webcontent.proxy.impl.DefaultHttpReverseProxyServlet</servlet-class>
  <init-param>
    <param-name>reverseproxy.configuration</param-name>
    <param-value>/WEB-INF/conf/reverseproxy.properties</param-value>
  </init-param>
  <init-param>
    <param-name>reverseproxy.configuration.refresh.delay</param-name>
    <param-value>60000</param-value>
  </init-param>
  <load-on-startup>11</load-on-startup>
</servlet>

<!-- Map /rproxy path to the Default Reverse Proxy Servlet -->
<servlet-mapping>
  <servlet-name>ReverseProxyServlet</servlet-name>
  <url-pattern>/rproxy/*</url-pattern>
</servlet-mapping>
          

The above servlet can have the following init parameters:

In the above servlet mapping configuration, the entry path mapping of this reverse proxy servlet is set to '/rproxy/*'. So, the remaining local path info after the '/rproxy' is used to map the path to the remote url. This mapping configurations and other sophisticated http parameters are configured in '/WEB-INF/conf/reverseproxy.properties' by default. A simple configuration example can be as follows:

# A very simple configuration of reverseproxy.properties
#
# Proxy Pass Reverse Mapping configurations for each category
# ... Put the path item names here. Each path item will be evaluated by the order. 
proxy.reverse.pass = apache, portals

proxy.reverse.pass.apache.local = /apache/
proxy.reverse.pass.apache.remote = http://www.apache.org/

proxy.reverse.pass.portals.local = /portals/
proxy.reverse.pass.portals.remote = http://portals.apache.org/
          

In the above example, just two path mappings are defined: One for http://www.apache.org/ and the other for http://portals.apache.org/. For http://www.apache.org/, the local path, /apache/, is mapped. And for http://portals.apache.org/, the local path, /portals/, is mapped. So, if you visit the reverse proxy url like 'http://localhost:8080/webcontent/rproxy/portals/index.html in your browser, then you can browse the Apache Portals homepage via the reverse proxy component!

Here are full descriptions for configuration properties.
Note: The previously defined property variables are automatically expanded when the configuration has the variable references wrapped by '${property.name}' like the following example:

defaults.parserAdaptor.html = org.apache.portals.applications.webcontent.rewriter.html.neko.NekoParserAdaptor
proxy.reverse.pass.somewhere.rewriter.parserAdaptor.html = ${defaults.parserAdaptor.html}