Author: woonsan
Date: Wed Nov 19 13:41:36 2014
New Revision: 1640550
URL: http://svn.apache.org/r1640550
Log:
APA-67: polishing modules-overview
Modified:
portals/site/applications/src/site/xdoc/webcontent2/modules-overview.xml
Modified:
portals/site/applications/src/site/xdoc/webcontent2/modules-overview.xml
URL:
http://svn.apache.org/viewvc/portals/site/applications/src/site/xdoc/webcontent2/modules-overview.xml?rev=1640550&r1=1640549&r2=1640550&view=diff
==============================================================================
--- portals/site/applications/src/site/xdoc/webcontent2/modules-overview.xml
(original)
+++ portals/site/applications/src/site/xdoc/webcontent2/modules-overview.xml
Wed Nov 19 13:41:36 2014
@@ -25,12 +25,98 @@
<body>
<section name="Modules Overview">
-
+ <p>
+ Web Content Application 2 was redesigned and rewritten
+ in order to maximize its modularity and support various use cases.
+ </p>
<p>
The Web Content Application 2 consists of four modules:
</p>
+
<img src="../images/webcontent2-modules-view.png" alt="Modules View" />
+ <h2>Modules Description</h2>
+ <table>
+ <tr>
+ <th>Module Name</th>
+ <th>Artifact ID</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>Content Rewriter</td>
+ <td>apa-webcontent2-content-rewriter</td>
+ <td>
+ <div>
+ Simple Content Rewriting API and default implementation
components
+ to be able to do simple text-basd rewriting
+ or use other richer content rewriting framework
+ such as <a href="http://htmlcleaner.sourceforge.net/";
target="_blank">HtmlCleaner</a>.
+ </div>
+ <div>
+ Basically this module was designed to leverage other content
rewriting frameworks
+ unless the content rewriting requirements are simple enough to
use simple text-based content rewriting.
+ Therefore, this module limited its responsibility to defining
very basic APIs such as
+
<code>org.apache.portals.applications.webcontent2.rewriter.ContentRewriter</code>,
+
<code>org.apache.portals.applications.webcontent2.rewriter.Source</code> and
+
<code>org.apache.portals.applications.webcontent2.rewriter.Sink</code>
+ as well as simple text-based ContentRewriter implementations.
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>Reverse Proxy</td>
+ <td>apa-webcontent2-reverse-proxy</td>
+ <td>
+ <div>
+ HTTP Reverse Proxy application framework for servlets, filters
or portlets,
+ providing YAML based proxy path mapping configurations and
default content rewriter components.
+ </div>
+ <div>
+ Unlike the reverse proxy servlet implementation in Web Content
Application 1,
+ this module splits its responsibilities to several commands
+
(<code>org.apache.portals.applications.webcontent2.proxy.command.*</code>)
+ and assemble the commands in chains.
+ </div>
+ <div>
+ Also, instead of trying to implement every feature in a servlet
with a lot of
+ possible configuration parameters as we did in Web Content
Application 1,
+ this module simply provides generic reverse proxy servlet and
filter
+ as well as simple implementations
+ (
+
<code>org.apache.portals.applications.webcontent2.proxy.servlet.SimpleReverseProxyServlet</code>
+ and
+
<code>org.apache.portals.applications.webcontent2.proxy.filter.SimpleReverseProxyFilter</code>
+ ).
+ </div>
+ <div>
+ Therefore, developers can easily extend those classes
+ to add (custom) behaviors (by adding a custom command for
instance)
+ in serve a reverse proxy in different forms.
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>Portlets</td>
+ <td>apa-webcontent2-portlets</td>
+ <td>
+ <div>
+ Various portlets serving remote content through either
server-side HTTP Client handling
+ or IFrame-based client-side page handling.
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>WAR Package</td>
+ <td>apa-webcontent2-war</td>
+ <td>
+ <div>
+ Packaged WAR module having apa-webcontent2-content-rewriter,
apa-webcontent2-reverse-proxy,
+ apa-webcontent2-portlets, and configurations and examples for
servlets, filters and others.
+ </div>
+ </td>
+ </tr>
+ </table>
+
</section>
</body>
