Author: woonsan
Date: Thu Nov 20 13:32:27 2014
New Revision: 1640739
URL: http://svn.apache.org/r1640739
Log:
APA-67: adding JavaDocs menu; describing portlets-module and war-module.
Modified:
portals/site/applications/src/site/site.xml
portals/site/applications/src/site/xdoc/webcontent2/portlets-module.xml
portals/site/applications/src/site/xdoc/webcontent2/war-module.xml
Modified: portals/site/applications/src/site/site.xml
URL:
http://svn.apache.org/viewvc/portals/site/applications/src/site/site.xml?rev=1640739&r1=1640738&r2=1640739&view=diff
==============================================================================
--- portals/site/applications/src/site/site.xml (original)
+++ portals/site/applications/src/site/site.xml Thu Nov 20 13:32:27 2014
@@ -49,10 +49,11 @@
<item name="Reverse Proxy Module"
href="./webcontent2/reverse-proxy-module.html" />
<item name="Portlets Module"
href="./webcontent2/portlets-module.html" />
<item name="WAR Module" href="./webcontent2/war-module.html" />
+ <item name="JavaDocs" href="./webcontent2/apidocs/index.html" />
</item>
- <item name='WebContent-1' href='./webcontent/index.html'/>
+ <item name='WebContent-1' href='./webcontent/index.html'/>
<item name='DB Browser' href='./dbbrowser/index.html'/>
- <item name="Logging" href="./logging/index.html"/>
+ <item name="Logging" href="./logging/index.html"/>
</menu>
<menu name="Support">
Modified:
portals/site/applications/src/site/xdoc/webcontent2/portlets-module.xml
URL:
http://svn.apache.org/viewvc/portals/site/applications/src/site/xdoc/webcontent2/portlets-module.xml?rev=1640739&r1=1640738&r2=1640739&view=diff
==============================================================================
--- portals/site/applications/src/site/xdoc/webcontent2/portlets-module.xml
(original)
+++ portals/site/applications/src/site/xdoc/webcontent2/portlets-module.xml Thu
Nov 20 13:32:27 2014
@@ -27,311 +27,66 @@
<section name="Portlets Module">
<p>
- The Web Content Application 2 consists of three portlets
+ The Web Content Application 2 Portlets Module provides several portlets
that have similiar functionality, but different approaches:
<ul>
- <li>IFrame Portlet</li>
- <li>
- ReverseProxy IFrame Portlet
- <ul>
- <li><a href="rproxy.html">Reverse Proxy Service</a></li>
- </ul>
- </li>
- <li>Web Content Portlet</li>
+
<li>org.apache.portals.applications.webcontent2.portlet.IFrameGenericPortlet</li>
+
<li>org.apache.portals.applications.webcontent2.portlet.WebContentPortlet</li>
+
<li>org.apache.portals.applications.webcontent2.portlet.proxy.SimpleReverseProxyPortlet</li>
</ul>
All the portlets host content from a different website or local
servlet inside a portlet window.
</p>
- <p>
- The IFrame Portet achieves this
- by embedding an HTML
- <a href='http://www.w3schools.com/TAGS/tag_iframe.asp'>iframe</a>
- within a portlet.
- </p>
- <p>
- The ReverseProxy IFrame Portlet behaves in the same way as IFrame
Portlet does,
- except that it uses <a href="rproxy.html">Reverse Proxy Service</a>
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.
- </p>
- <p>
- The Web Content portlet 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.
- </p>
- <p>
- If you are interested in secure versions of these portlets, see
- the Jetspeed-specific versions of the IFrame, ReverseProxyIFrame, or
WebContent
- portlets found at the
- <a
href='http://portals.apache.org/jetspeed-2/applications/j2-admin.html'>Jetspeed
J2-Admin</a>
- website.
- The SSOIFrame, SSOReverseProxyIFrame and SSOWebContent portlets
leverage the Jetspeed SSO
- Services, and are not portable to other portal servers.
- </p>
- <p>Here are the classes to declare when using the portlets:</p>
- <source><![CDATA[
-<portlet-class>org.apache.portals.applications.webcontent.portlet.IFrameGenericPortlet</portlet-class>
- ]]></source>
- <p>
- <em>Note: The ReverseProxyIFramePortlet uses the same class, but has
different preferences configurations.</em>
- </p>
- <p>or</p>
- <source><![CDATA[
-<portlet-class>org.apache.portals.applications.webcontent.portlet.WebContentPortlet</portlet-class>
- ]]></source>
- <subsection name='Web Content Portlet Preferences'>
- <table>
- <tr>
- <th>Name</th>
- <th>Example Value</th>
- <th>Description</th>
- </tr>
- <tr>
- <td>SRC</td>
- <td>http://www.google.com</td>
- <td>The URL of the remote or local site to be hosted.
- </td>
- </tr>
- <tr>
- <td>PROXYHOST</td>
- <td>proxyserver1.mycompany.com</td>
- <td>The proxy server host name.</td>
- </tr>
- <tr>
- <td>PROXYPORT</td>
- <td>8000</td>
- <td>The proxy server port.</td>
- </tr>
- </table>
- </subsection>
- <subsection name='IFrame Portlet Preferences'>
- <table>
- <tr>
- <th>Name</th>
- <th>Example Value</th>
- <th>Description</th>
- </tr>
- <tr>
- <td>SRC</td>
- <td>
- http://portals.apache.org/index.html<br/>
- </td>
- <td>
- The URL of the remote or local site to be hosted.
- <br/>
- <p>
- You can use predefined variables, ${serverName}, ${serverPort}
or ${contextPath}, to set local URLs.<br/>
- So, if the requested server name is 'localhost', the requested
server port is '8080' and the request context path is '/webcontent', then
- the following configurations are equivalent:<br/>
- <ul>
- <li>http://localhost:8080/webcontent/index.html</li>
- <li>http://localhost:${serverPort}/webcontent/index.html</li>
-
<li>http://${serverName}:${serverPort}/webcontent/index.html</li>
-
<li>http://${serverName}:${serverPort}/${contextPath}/index.html</li>
- </ul>
- </p>
- </td>
- </tr>
- <tr>
- <td>AUTORESIZE</td>
- <td>true</td>
- <td>
- If this preference value is set to true, then
- this portlet tries to resize the height of the IFRAME tag based
on the rendered content.
- However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
- </td>
- </tr>
- <tr>
- <td>VISITLASTPAGE</td>
- <td>true</td>
- <td>
- If this preference value is set to true, then
- this last visited page in this portlet is stored in the session
and the page will be revisited
- when the portlet is rendered again.
- However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
- </td>
- </tr>
- <tr>
- <td>HEIGHT</td>
- <td>300</td>
- <td>The height of the IFrame window when in Normal Window
State</td>
- </tr>
- <tr>
- <td>WIDTH</td>
- <td>100%</td>
- <td>The width of the IFrame window when in Normal Window State.
Can be a percentage of available space to the portlet, or a constant value</td>
- </tr>
- <tr>
- <td>MAX-HEIGHT</td>
- <td>800</td>
- <td>The height of the IFrame window when in Maximized Window
State</td>
- </tr>
- <tr>
- <td>MAX-WIDTH</td>
- <td>100%</td>
- <td>The width of the IFrame window when in Maximized Window State.
Can be a percentage of available space to the portlet, or a constant value</td>
- </tr>
- <tr>
- <td>SCROLLING</td>
- <td>AUTO | YES | NO</td>
- <td>Specifies whether or not to display scrollbars in an
iframe</td>
- </tr>
- </table>
+
+ <subsection name="IFrameGenericPortlet">
+ <p>
+ The <code>IFrameGenericPortlet</code> achieves this
+ by embedding an HTML
+ <a href="http://en.wikipedia.org/wiki/HTML_element#Frames";>iframe</a>
+ within a portlet.
+ </p>
+ <p>
+ The <code>IFrameGenericPortlet</code> can also host a content from a
reverse proxy service
+ (in either servlet or filter) included in the
+ <a href="reverse-proxy-module.html">Reverse Proxy Module</a>
+ instead of the original SRC URLs.
+ By using reverse proxy service with
<code>IFrameGenericPortlet</code>, more sophisticated content can be
+ served by setting content rewriting configurations or Cross-Domain
Scripting can be enabled.
+ </p>
</subsection>
- <subsection name='ReverseProxyIFrame Portlet Preferences'>
+
+ <subsection name="WebContentPortlet">
<p>
- <em>
- 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:
- <source><![CDATA[emptySessionPath="true"]]></source>
- </em>
+ The <code>WebContentPortlet</code> 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.
</p>
- <table>
- <tr>
- <th>Name</th>
- <th>Example Value</th>
- <th>Description</th>
- </tr>
- <tr>
- <td>SRC</td>
- <td>http://portals.apache.org/index.html</td>
- <td>
- The URL of the remote or local site to be hosted.
- <br/>
- <p>
- You can use predefined variables, ${serverName}, ${serverPort}
or ${contextPath}, to set local URLs.<br/>
- So, if the requested server name is 'localhost', the requested
server port is '8080' and the request context path is '/webcontent', then
- the following configurations are equivalent:<br/>
- <ul>
- <li>http://localhost:8080/webcontent/index.html</li>
- <li>http://localhost:${serverPort}/webcontent/index.html</li>
-
<li>http://${serverName}:${serverPort}/webcontent/index.html</li>
-
<li>http://${serverName}:${serverPort}/${contextPath}/index.html</li>
- </ul>
- </p>
- </td>
- </tr>
- <tr>
- <td>PROXYREMOTEURL</td>
- <td>http://portals.apache.org/</td>
- <td>
- The base URL of the remote site.
- If 'PROXYREMOTEURL' and 'PROXYLOCALPATH' are set,
- then this portlet translates the 'SRC' url into a reverse proxy
url
- by replacing the value of 'PROXYREMOTEURL' by the value of
'PROXYLOCALPATH'.
- If you use the default reverse proxy component, then you should
configure
- the path mappings in the configuration file. (e.g.,
/WEB-INF/conf/reverseproxy.properties)
- <br/>
- <p>
- You can use predefined variables, ${serverName}, ${serverPort}
or ${contextPath}, to set local URLs.<br/>
- So, if the requested server name is 'localhost', the requested
server port is '8080' and the request context path is '/webcontent', then
- the following configurations are equivalent:<br/>
- <ul>
- <li>http://localhost:8080/webcontent/index.html</li>
- <li>http://localhost:${serverPort}/webcontent/index.html</li>
-
<li>http://${serverName}:${serverPort}/webcontent/index.html</li>
-
<li>http://${serverName}:${serverPort}/${contextPath}/index.html</li>
- </ul>
- </p>
- </td>
- </tr>
- <tr>
- <td>PROXYLOCALPATH</td>
- <td>${contextPath}/rproxy/portals/</td>
- <td>
- The base URL of the local proxy URL.
- If the value of 'PROXYLOCALPATH' doesn't starts with '/', then
- this portlet prepends the context path of the local servlet
application.
- By default, this web application contains reverse proxy servlet
mapped by '/rproxy' path.
- For some cases, you can use other external proxy server by
setting a context relative path
- or absolute url such as '/apache' or
'http://www.localhost.com/apache'.
- If you use the default reverse proxy component, then you should
configure
- the path mappings in the configuration file. (e.g.,
/WEB-INF/conf/reverseproxy.properties)
- <br/>
- <p>
- You can use the predefined variable, ${contextPath}, to set
local paths.<br/>
- So, if the request context path is '/webcontent', then
- the following configurations are equivalent:<br/>
- <ul>
- <li>/webcontent/rproxy/portals</li>
- <li>${contextPath}/rproxy/portals</li>
- </ul>
- </p>
- </td>
- </tr>
- <tr>
- <td>AUTORESIZE</td>
- <td>true</td>
- <td>
- If this preference value is set to true, then
- this portlet tries to resize the height of the IFRAME tag based
on the rendered content.
- However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
- Also, if 'PROXYREMOTEURL' and 'PROXYLOCALPATH' are set to use a
proxy url in the same domain,
- then this option can be applied as well.
- </td>
- </tr>
- <tr>
- <td>VISITLASTPAGE</td>
- <td>true</td>
- <td>
- If this preference value is set to true, then
- this last visited page in this portlet is stored in the session
and the page will be revisited
- when the portlet is rendered again.
- However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
- Also, if 'PROXYREMOTEURL' and 'PROXYLOCALPATH' are set to use a
proxy url in the same domain,
- then this option can be applied as well.
- </td>
- </tr>
- <tr>
- <td>HEIGHT</td>
- <td>300</td>
- <td>The height of the IFrame window when in Normal Window
State</td>
- </tr>
- <tr>
- <td>WIDTH</td>
- <td>100%</td>
- <td>The width of the IFrame window when in Normal Window State.
Can be a percentage of available space to the portlet, or a constant value</td>
- </tr>
- <tr>
- <td>MAX-HEIGHT</td>
- <td>800</td>
- <td>The height of the IFrame window when in Maximized Window
State</td>
- </tr>
- <tr>
- <td>MAX-WIDTH</td>
- <td>100%</td>
- <td>The width of the IFrame window when in Maximized Window State.
Can be a percentage of available space to the portlet, or a constant value</td>
- </tr>
- <tr>
- <td>SCROLLING</td>
- <td>AUTO | YES | NO</td>
- <td>Specifies whether or not to display scrollbars in an
iframe</td>
- </tr>
- </table>
+ </subsection>
+
+ <subsection name="SimpleReverseProxyPortlet">
<p>
- For details on how to configure the Reverse Proxy Service, please
refer to <a href="rproxy.html">Introduction to Reverse Proxy Service</a>.
+ The <code>SimpleReverseProxyPortlet</code> behaves as a reverse
proxy by itself
+ without having to use <code>IFrameGenericPortlet</code> with
depending on
+ a separate reverse proxy servlet or filter.
</p>
-
</subsection>
- <p>Here are examples of the Web Content, IFrame and ReverseProxyIFrame
Portlets:</p>
- <br/>
- <img src='../images/wc.png'/>
- <br/>
- <img src='../images/iframe.png'/>
- <br/>
- <img src='../images/rproxyif.png'/>
+ <subsection name="Secure versions of these portlets">
+ <p>
+ If you are interested in secure versions of these portlets, see
+ the Jetspeed-specific versions of the IFrame, ReverseProxyIFrame, or
WebContent
+ portlets found at the
+ <a
href="http://portals.apache.org/jetspeed-2/applications/j2-admin.html";>Jetspeed
J2-Admin</a>
+ website.
+ The SSOIFrame, SSOReverseProxyIFrame and SSOWebContent portlets
leverage the Jetspeed SSO
+ Services, and are not portable to other portal servers.
+ </p>
+ </subsection>
</section>
Modified: portals/site/applications/src/site/xdoc/webcontent2/war-module.xml
URL:
http://svn.apache.org/viewvc/portals/site/applications/src/site/xdoc/webcontent2/war-module.xml?rev=1640739&r1=1640738&r2=1640739&view=diff
==============================================================================
--- portals/site/applications/src/site/xdoc/webcontent2/war-module.xml
(original)
+++ portals/site/applications/src/site/xdoc/webcontent2/war-module.xml Thu Nov
20 13:32:27 2014
@@ -28,6 +28,316 @@
<p>TODO</p>
</section>
+ <section name="Reverse Proxy Servlet Definitions">
+ <p>TODO</p>
+ </section>
+
+ <section name="Portlet Definitions">
+
+ <p>
+ The Web Content Application 2 WAR Module contains several portlet
definitions
+ in /WEB-INF/portlet.xml:
+ <ul>
+ <li>IFrame Portlet</li>
+ <li>ReverseProxy IFrame Portlet</li>
+ <li>Web Content Portlet</li>
+ </ul>
+ All the portlets host content from a different website or local
+ servlet inside a portlet window.
+ </p>
+ <p>
+ The IFrame Portet achieves this
+ by embedding an HTML
+ <a href="http://en.wikipedia.org/wiki/HTML_element#Frames";>iframe</a>
+ within a portlet.
+ </p>
+ <p>
+ The ReverseProxy IFrame Portlet behaves in the same way as IFrame
Portlet does,
+ except that it uses <a href="rproxy.html">Reverse Proxy Service</a>
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.
+ </p>
+ <p>
+ The Web Content portlet 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.
+ </p>
+ <p>
+ If you are interested in secure versions of these portlets, see
+ the Jetspeed-specific versions of the IFrame, ReverseProxyIFrame, or
WebContent
+ portlets found at the
+ <a
href='http://portals.apache.org/jetspeed-2/applications/j2-admin.html'>Jetspeed
J2-Admin</a>
+ website.
+ The SSOIFrame, SSOReverseProxyIFrame and SSOWebContent portlets
leverage the Jetspeed SSO
+ Services, and are not portable to other portal servers.
+ </p>
+ <p>Here are the classes to declare when using the portlets:</p>
+ <source><![CDATA[
+<portlet-class>org.apache.portals.applications.webcontent.portlet.IFrameGenericPortlet</portlet-class>
+ ]]></source>
+ <p>
+ <em>Note: The ReverseProxyIFramePortlet uses the same class, but has
different preferences configurations.</em>
+ </p>
+ <p>or</p>
+ <source><![CDATA[
+<portlet-class>org.apache.portals.applications.webcontent.portlet.WebContentPortlet</portlet-class>
+ ]]></source>
+ <subsection name='Web Content Portlet Preferences'>
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Example Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>SRC</td>
+ <td>http://www.google.com</td>
+ <td>The URL of the remote or local site to be hosted.
+ </td>
+ </tr>
+ <tr>
+ <td>PROXYHOST</td>
+ <td>proxyserver1.mycompany.com</td>
+ <td>The proxy server host name.</td>
+ </tr>
+ <tr>
+ <td>PROXYPORT</td>
+ <td>8000</td>
+ <td>The proxy server port.</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name='IFrame Portlet Preferences'>
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Example Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>SRC</td>
+ <td>
+ http://portals.apache.org/index.html<br/>
+ </td>
+ <td>
+ The URL of the remote or local site to be hosted.
+ <br/>
+ <p>
+ You can use predefined variables, ${serverName}, ${serverPort}
or ${contextPath}, to set local URLs.<br/>
+ So, if the requested server name is 'localhost', the requested
server port is '8080' and the request context path is '/webcontent', then
+ the following configurations are equivalent:<br/>
+ <ul>
+ <li>http://localhost:8080/webcontent/index.html</li>
+ <li>http://localhost:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/${contextPath}/index.html</li>
+ </ul>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>AUTORESIZE</td>
+ <td>true</td>
+ <td>
+ If this preference value is set to true, then
+ this portlet tries to resize the height of the IFRAME tag based
on the rendered content.
+ However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
+ </td>
+ </tr>
+ <tr>
+ <td>VISITLASTPAGE</td>
+ <td>true</td>
+ <td>
+ If this preference value is set to true, then
+ this last visited page in this portlet is stored in the session
and the page will be revisited
+ when the portlet is rendered again.
+ However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
+ </td>
+ </tr>
+ <tr>
+ <td>HEIGHT</td>
+ <td>300</td>
+ <td>The height of the IFrame window when in Normal Window
State</td>
+ </tr>
+ <tr>
+ <td>WIDTH</td>
+ <td>100%</td>
+ <td>The width of the IFrame window when in Normal Window State.
Can be a percentage of available space to the portlet, or a constant value</td>
+ </tr>
+ <tr>
+ <td>MAX-HEIGHT</td>
+ <td>800</td>
+ <td>The height of the IFrame window when in Maximized Window
State</td>
+ </tr>
+ <tr>
+ <td>MAX-WIDTH</td>
+ <td>100%</td>
+ <td>The width of the IFrame window when in Maximized Window State.
Can be a percentage of available space to the portlet, or a constant value</td>
+ </tr>
+ <tr>
+ <td>SCROLLING</td>
+ <td>AUTO | YES | NO</td>
+ <td>Specifies whether or not to display scrollbars in an
iframe</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name='ReverseProxyIFrame Portlet Preferences'>
+ <p>
+ <em>
+ 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:
+ <source><![CDATA[emptySessionPath="true"]]></source>
+ </em>
+ </p>
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Example Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>SRC</td>
+ <td>http://portals.apache.org/index.html</td>
+ <td>
+ The URL of the remote or local site to be hosted.
+ <br/>
+ <p>
+ You can use predefined variables, ${serverName}, ${serverPort}
or ${contextPath}, to set local URLs.<br/>
+ So, if the requested server name is 'localhost', the requested
server port is '8080' and the request context path is '/webcontent', then
+ the following configurations are equivalent:<br/>
+ <ul>
+ <li>http://localhost:8080/webcontent/index.html</li>
+ <li>http://localhost:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/${contextPath}/index.html</li>
+ </ul>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>PROXYREMOTEURL</td>
+ <td>http://portals.apache.org/</td>
+ <td>
+ The base URL of the remote site.
+ If 'PROXYREMOTEURL' and 'PROXYLOCALPATH' are set,
+ then this portlet translates the 'SRC' url into a reverse proxy
url
+ by replacing the value of 'PROXYREMOTEURL' by the value of
'PROXYLOCALPATH'.
+ If you use the default reverse proxy component, then you should
configure
+ the path mappings in the configuration file. (e.g.,
/WEB-INF/conf/reverseproxy.properties)
+ <br/>
+ <p>
+ You can use predefined variables, ${serverName}, ${serverPort}
or ${contextPath}, to set local URLs.<br/>
+ So, if the requested server name is 'localhost', the requested
server port is '8080' and the request context path is '/webcontent', then
+ the following configurations are equivalent:<br/>
+ <ul>
+ <li>http://localhost:8080/webcontent/index.html</li>
+ <li>http://localhost:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/${contextPath}/index.html</li>
+ </ul>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>PROXYLOCALPATH</td>
+ <td>${contextPath}/rproxy/portals/</td>
+ <td>
+ The base URL of the local proxy URL.
+ If the value of 'PROXYLOCALPATH' doesn't starts with '/', then
+ this portlet prepends the context path of the local servlet
application.
+ By default, this web application contains reverse proxy servlet
mapped by '/rproxy' path.
+ For some cases, you can use other external proxy server by
setting a context relative path
+ or absolute url such as '/apache' or
'http://www.localhost.com/apache'.
+ If you use the default reverse proxy component, then you should
configure
+ the path mappings in the configuration file. (e.g.,
/WEB-INF/conf/reverseproxy.properties)
+ <br/>
+ <p>
+ You can use the predefined variable, ${contextPath}, to set
local paths.<br/>
+ So, if the request context path is '/webcontent', then
+ the following configurations are equivalent:<br/>
+ <ul>
+ <li>/webcontent/rproxy/portals</li>
+ <li>${contextPath}/rproxy/portals</li>
+ </ul>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>AUTORESIZE</td>
+ <td>true</td>
+ <td>
+ If this preference value is set to true, then
+ this portlet tries to resize the height of the IFRAME tag based
on the rendered content.
+ However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
+ Also, if 'PROXYREMOTEURL' and 'PROXYLOCALPATH' are set to use a
proxy url in the same domain,
+ then this option can be applied as well.
+ </td>
+ </tr>
+ <tr>
+ <td>VISITLASTPAGE</td>
+ <td>true</td>
+ <td>
+ If this preference value is set to true, then
+ this last visited page in this portlet is stored in the session
and the page will be revisited
+ when the portlet is rendered again.
+ However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
+ Also, if 'PROXYREMOTEURL' and 'PROXYLOCALPATH' are set to use a
proxy url in the same domain,
+ then this option can be applied as well.
+ </td>
+ </tr>
+ <tr>
+ <td>HEIGHT</td>
+ <td>300</td>
+ <td>The height of the IFrame window when in Normal Window
State</td>
+ </tr>
+ <tr>
+ <td>WIDTH</td>
+ <td>100%</td>
+ <td>The width of the IFrame window when in Normal Window State.
Can be a percentage of available space to the portlet, or a constant value</td>
+ </tr>
+ <tr>
+ <td>MAX-HEIGHT</td>
+ <td>800</td>
+ <td>The height of the IFrame window when in Maximized Window
State</td>
+ </tr>
+ <tr>
+ <td>MAX-WIDTH</td>
+ <td>100%</td>
+ <td>The width of the IFrame window when in Maximized Window State.
Can be a percentage of available space to the portlet, or a constant value</td>
+ </tr>
+ <tr>
+ <td>SCROLLING</td>
+ <td>AUTO | YES | NO</td>
+ <td>Specifies whether or not to display scrollbars in an
iframe</td>
+ </tr>
+ </table>
+ <p>
+ For details on how to configure the Reverse Proxy Service, please
refer to <a href="rproxy.html">Introduction to Reverse Proxy Service</a>.
+ </p>
+
+ </subsection>
+
+ <p>Here are examples of the Web Content, IFrame and ReverseProxyIFrame
Portlets:</p>
+ <br/>
+ <img src='../images/wc.png'/>
+ <br/>
+ <img src='../images/iframe.png'/>
+ <br/>
+ <img src='../images/rproxyif.png'/>
+
+ </section>
+
</body>
</document>
