WAR Module

The Web Content Application 2 WAR Module packages all the other modules with default servlet/filter/portlet configurations and demonstration-purpose examples.

    <dependency>
      <groupId>org.apache.portals.applications</groupId>
      <artifactId>apa-webcontent2-war</artifactId>
      <type>war</type>
      <version>${webcontent2.version}</version>
    </dependency>
          

Default Reverse Proxy Servlet/Filter Definition(s)

The Web Content Application 2 WAR Module contains a reverse proxy servlet definition like the following in /WEB-INF/web.xml by default.

  <!-- Default Reverse Proxy Servlet -->
  <servlet>
    <servlet-name>ReverseProxyServlet</servlet-name>
    <servlet-class>org.apache.portals.applications.webcontent2.proxy.servlet.SimpleReverseProxyServlet</servlet-class>
    <init-param>
      <param-name>mappings</param-name>
      <param-value>
        /WEB-INF/rproxy-mappings.yaml
      </param-value>
    </init-param>
    <init-param>
      <param-name>ssl-hostname-verifier</param-name>
      <param-value>ALLOW_ALL_HOSTNAME_VERIFIER</param-value>
    </init-param>
  </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 mapping configuration for the servlet is configured in /WEB-INF/rproxy-mappings.yaml by default:

--- !regex
localPattern: ^/localhost_(\d+)/(.*)$
remoteReplace: http://localhost:$1/$2
remotePattern: ^http://localhost:(\d+)/(.*)$
localReplace: /localhost_$1/$2
contentRewriters:
    text/html: !!org.apache.portals.applications.webcontent2.proxy.rewriter.DefaultReverseProxyTextLineContentRewriter []

--- !simple
local: /portals/applications/
remote: http://portals.apache.org/applications/
contentRewriters:
    text/html: !!org.apache.portals.applications.webcontent2.proxy.rewriter.DefaultReverseProxyTextLineContentRewriter []

--- !simple
local: /portals/bridges/
remote: http://portals.apache.org/bridges/
contentRewriters:
    text/html: !!org.apache.portals.applications.webcontent2.proxy.rewriter.DefaultReverseProxyTextLineContentRewriter []

--- !regex
localPattern: ^/apache/(\w+)/(.*)$
remoteReplace: http://$1.apache.org/$2
remotePattern: ^http://(\w+)\.apache\.org/(.*)$
localReplace: /apache/$1/$2
contentRewriters:
    text/html: !!org.apache.portals.applications.webcontent2.proxy.rewriter.DefaultReverseProxyTextLineContentRewriter []

--- !simple
local: /
remote: http://apache.org/
contentRewriters:
    text/html: !!org.apache.portals.applications.webcontent2.proxy.rewriter.DefaultReverseProxyTextLineContentRewriter []
      

Portlet Definitions

The Web Content Application 2 WAR Module contains several portlet definitions in /WEB-INF/portlet.xml:

• IFrame Portlet 2
• ReverseProxy IFrame Portlet 2
• Web Content Portlet 2
• SimpleReverseProxyPortlet

The IFrame Portet 2 achieves this by embedding an HTML iframe within a portlet.

The ReverseProxy IFrame Portlet 2 behaves in the same way as IFrame Portlet 2 does, except that it uses reverse proxy service URLs instead of the original SRC URLs. By using Reverse Proxy service component, more sophisticated content can be served by setting content rewriting configurations or Cross-Domain Scripting can be enabled. The Web Content Application includes Reverse Proxy Service servlet and component.

The Web Content Portlet 2 takes a more complicated approach: it actually embeds the content of the remote website inside the HTML payload delivered by the portal, without the help of the browser. This approach is more complicated since it may require rewriting all links within the hosted website, that is, if you want to keep the website navigation inside the portlet window. While a noble cause, this approach is far from perfect and does not always work correctly.

The SimpleReverseProxyPortlet behaves in the same way as Reverse Proxy Servlet or Filter by itself without having to depend on an external reverse proxy servlet or filter. This portlet also rewrite all the links to portlet action URLs like Web Content Portlet 2 does. This simple reverse proxying portlet can be used as a base class that you can extend or as an example.

If you are interested in secure versions of these portlets, see the Jetspeed-specific versions of the IFrame 2, ReverseProxyIFrame 2, or WebContent 2 portlets found at the Jetspeed J2-Admin website. The SSOIFrame, SSOReverseProxyIFrame and SSOWebContent portlets leverage the Jetspeed SSO Services, and are not portable to other portal servers.

Here are the classes to declare when using the portlets:

<portlet-class>org.apache.portals.applications.webcontent2.portlet.IFrameGenericPortlet</portlet-class>        
      

Note: The ReverseProxyIFramePortlet uses the same class, but has different preferences configurations.

or

<portlet-class>org.apache.portals.applications.webcontent2.portlet.WebContentPortlet</portlet-class>        
      

emptySessionPath="true"

cfoutput |
c:block=div,false |
font=span,true |
font.size |
font.face |
font.style=${style};font-family=${face};font-size=${size};

Here are examples of the Web Content, IFrame, ReverseProxyIFrame and SimpleReverseProxy Portlets: