Modified: portals/site-live/applications/webcontent/index.html URL: http://svn.apache.org/viewvc/portals/site-live/applications/webcontent/index.html?rev=1901430&r1=1901429&r2=1901430&view=diff ============================================================================== --- portals/site-live/applications/webcontent/index.html (original) +++ portals/site-live/applications/webcontent/index.html Tue May 31 02:23:06 2022 @@ -1,533 +1,670 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - - - - - - - - - - - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Apache Portals Applications - Apache Portals Web Content Application</title> - <style type="text/css" media="all"> - @import url("../css/maven-base.css"); - @import url("../css/maven-theme.css"); - @import url("../css/site.css"); - </style> - <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - </head> - <body class="composite"> - <div id="banner"> - <a href="http://portals.apache.org/" id="bannerLeft"> - - <img src="../images/apache-portals.gif" alt="" /> - - </a> - <a href="http://portals.apache.org/applications/" id="bannerRight"> - - Apache Portals Applications - - </a> - <div class="clear"> - <hr/> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 26 May 2022 --> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>Apache Portals Applications - + Apache Portals Web Content Application</title> + <style type="text/css" media="all"> + @import url("../css/maven-base.css"); + @import url("../css/maven-theme.css"); + @import url("../css/site.css"); + </style> + <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> + <meta name="Date-Revision-yyyymmdd" content="20220526" /> + <meta http-equiv="Content-Language" content="en" /> + + </head> + <body class="composite"> + <div id="banner"> + <a href="http://portals.apache.org/" id="bannerLeft"> + <img src="../images/apache-portals.gif" alt="Apache Software Foundation" /> + </a> + <a href="http://portals.apache.org/applications/" id="bannerRight"> + Apache Portals Applications + </a> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + + + <div class="xleft"> + <span id="publishDate">Last Published: 26 May 2022</span> + | <span id="projectVersion">Version: 1.0</span> + </div> + <div class="xright"> <a href="http://portals.apache.org/" class="externalLink" target="_nw" title="Portals">Portals</a> + | + <a href="http://portals.apache.org/jetspeed-2" class="externalLink" target="_nw" title="Jetspeed-2">Jetspeed-2</a> + | + <a href="http://portals.apache.org/bridges" class="externalLink" target="_nw" title="Bridges">Bridges</a> + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + + <h5>Essentials</h5> + <ul> + <li class="none"> + <a href="../index.html" title="Welcome">Welcome</a> + </li> + <li class="none"> + <a href="../news.html" title="News and Status">News and Status</a> + </li> + <li class="none"> + <a href="../download.html" title="Download">Download</a> + </li> + <li class="none"> + <a href="../getting-started.html" title="Getting Started">Getting Started</a> + </li> + </ul> + <h5>Subprojects</h5> + <ul> + <li class="none"> + <a href=".././portals-gems/index.html" title="Gems">Gems</a> + </li> + <li class="none"> + <a href=".././demo/index.html" title="Demo">Demo</a> + </li> + <li class="none"> + <a href=".././rss-main/index.html" title="RSS">RSS</a> + </li> + <li class="expanded"> + <a href=".././webcontent2/index.html" title="WebContent-2">WebContent-2</a> + <ul> + <li class="none"> + <a href=".././webcontent2/modules-overview.html" title="Modules Overview">Modules Overview</a> + </li> + <li class="none"> + <a href=".././webcontent2/content-rewriter-module.html" title="Content Rewriter Module">Content Rewriter Module</a> + </li> + <li class="none"> + <a href=".././webcontent2/reverse-proxy-module.html" title="Reverse Proxy Module">Reverse Proxy Module</a> + </li> + <li class="none"> + <a href=".././webcontent2/portlets-module.html" title="Portlets Module">Portlets Module</a> + </li> + <li class="none"> + <a href=".././webcontent2/war-module.html" title="WAR Module">WAR Module</a> + </li> + <li class="none"> + <a href=".././webcontent2/build-from-source.html" title="Build from source">Build from source</a> + </li> + <li class="none"> + <a href=".././webcontent2/apidocs/index.html" title="JavaDocs">JavaDocs</a> + </li> + <li class="none"> + <a href=".././webcontent2/faq.html" title="FAQ">FAQ</a> + </li> + </ul> + </li> + <li class="none"> + <a href=".././webcontent/index.html" title="WebContent-1">WebContent-1</a> + </li> + <li class="none"> + <a href=".././dbbrowser/index.html" title="DB Browser">DB Browser</a> + </li> + <li class="none"> + <a href=".././logging/index.html" title="Logging">Logging</a> + </li> + </ul> + <h5>Support</h5> + <ul> + <li class="none"> + <a href="../team-list.html" title="Project Team">Project Team</a> + </li> + <li class="none"> + <a href="../license.html" title="Project License">Project License</a> + </li> + <li class="none"> + <a href="http://wiki.apache.org/portals/applications" class="externalLink" title="Project Wiki">Project Wiki</a> + </li> + <li class="none"> + <a href="../mail-lists.html" title="Mailing List">Mailing List</a> + </li> + <li class="none"> + <a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a> + </li> + </ul> + <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> + <img class="poweredBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + + + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + <!-- Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version + 2.0 (the "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 Unless required by + applicable law or agreed to in writing, software distributed under + the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES + OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and + limitations under the License. --> + + <div class="section"> +<h2>Welcome to Apache Portals Web Content Application<a name="Welcome_to_Apache_Portals_Web_Content_Application"></a></h2> + +<div id="downloadbox"> + +<div class="section"> +<div class="section"> +<div class="section"> +<h5>Get Portals Web Content App<a name="Get_Portals_Web_Content_App"></a></h5> + +<p> + <a href="../download.html"> + <img src="../images/folder-open.gif" border="0" alt="" title="download" /> + Download + </a> + Portals Applications WebContent 1.3 + </p> + +<ul> + +<li> + <a href="../getting-started.html">System Requirements</a> + </li> + </ul> </div> - </div> - <div id="breadcrumbs"> + +<p> + A portlet application dedicated to the development of Web Content + rewriting and IFrame based web content. The portlet applications + here are designed to host content + from another web site or local servlet inside of a portlet window. + </p> + +<p> + The Web Content portet application consists of three portlets + that have similiar functionality, but different approaches: + </p> +<ul> - - - - - - - - <div class="xleft"> - Last Published: 4 March 2015 - </div> - <div class="xright"> <a href="http://portals.apache.org/" class="externalLink">Portals</a> - | - <a href="http://portals.apache.org/jetspeed-2" class="externalLink">Jetspeed-2</a> - | - <a href="http://portals.apache.org/bridges" class="externalLink">Bridges</a> +<li>IFrame Portlet</li> + +<li> + ReverseProxy IFrame Portlet - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - <div id="leftColumn"> - <div id="navcolumn"> - - - - - - - - - <h5>Essentials</h5> - <ul> - - <li class="none"> - <a href="../index.html">Welcome</a> - </li> - - <li class="none"> - <a href="../news.html">News and Status</a> - </li> - - <li class="none"> - <a href="../download.html">Download</a> - </li> - - <li class="none"> - <a href="../getting-started.html">Getting Started</a> - </li> - </ul> - <h5>Subprojects</h5> - <ul> - - <li class="none"> - <a href=".././portals-gems/index.html">Gems</a> - </li> +<ul> - <li class="none"> - <a href=".././demo/index.html">Demo</a> +<li><a href="rproxy.html">Reverse Proxy Service</a></li> + </ul> </li> - - <li class="none"> - <a href=".././rss-main/index.html">RSS</a> - </li> - - +<li>Web Content Portlet</li> + </ul> + All the portlets host content from a different website or local + servlet inside a portlet window. - - +<p> + The IFrame Portet achieves this + by embedding an HTML + <a class="externalLink" 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 class="externalLink" 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> + +<div class="source"> +<pre> +<portlet-class>org.apache.portals.applications.webcontent.portlet.IFrameGenericPortlet</portlet-class> + </pre></div> + +<p> + <i>Note: The ReverseProxyIFramePortlet uses the same class, but has different preferences configurations.</i> + </p> + +<p>or</p> +<div class="source"> +<pre> +<portlet-class>org.apache.portals.applications.webcontent.portlet.WebContentPortlet</portlet-class> + </pre></div> + </div></div></div> +<div class="section"> +<h3>Web Content Portlet Preferences<a name="Web_Content_Portlet_Preferences"></a></h3> + +<table border="0" class="bodyTable"> + +<tr class="a"> + +<th>Name</th> + +<th>Example Value</th> + +<th>Description</th> + </tr> + +<tr class="b"> + +<td>SRC</td> +<td>http://www.google.com</td> + +<td>The URL of the remote or local site to be hosted. + </td> + </tr> + +<tr class="a"> + +<td>PROXYHOST</td> + +<td>proxyserver1.mycompany.com</td> + +<td>The proxy server host name.</td> + </tr> + +<tr class="b"> + +<td>PROXYPORT</td> + +<td>8000</td> + +<td>The proxy server port.</td> + </tr> + </table> + </div> - - <li class="expanded"> - <a href=".././webcontent2/index.html">WebContent-2</a> - <ul> +<div class="section"> +<h3>IFrame Portlet Preferences<a name="IFrame_Portlet_Preferences"></a></h3> + +<table border="0" class="bodyTable"> + +<tr class="a"> + +<th>Name</th> + +<th>Example Value</th> + +<th>Description</th> + </tr> + +<tr class="b"> + +<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 /> + </p> +<ul> - <li class="none"> - <a href=".././webcontent2/modules-overview.html">Modules Overview</a> - </li> +<li>http://localhost:8080/webcontent/index.html</li> - <li class="none"> - <a href=".././webcontent2/content-rewriter-module.html">Content Rewriter Module</a> - </li> +<li>http://localhost:${serverPort}/webcontent/index.html</li> - <li class="none"> - <a href=".././webcontent2/reverse-proxy-module.html">Reverse Proxy Module</a> - </li> +<li>http://${serverName}:${serverPort}/webcontent/index.html</li> - <li class="none"> - <a href=".././webcontent2/portlets-module.html">Portlets Module</a> - </li> +<li>http://${serverName}:${serverPort}/${contextPath}/index.html</li> + </ul> + + </td> + </tr> + +<tr class="a"> + +<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 class="b"> + +<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 class="a"> + +<td>HEIGHT</td> + +<td>300</td> + +<td>The height of the IFrame window when in Normal Window State</td> + </tr> + +<tr class="b"> + +<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 class="a"> + +<td>MAX-HEIGHT</td> + +<td>800</td> + +<td>The height of the IFrame window when in Maximized Window State</td> + </tr> + +<tr class="b"> + +<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 class="a"> + +<td>SCROLLING</td> + +<td>AUTO | YES | NO</td> + +<td>Specifies whether or not to display scrollbars in an iframe</td> + </tr> + </table> + </div> + +<div class="section"> +<h3>ReverseProxyIFrame Portlet Preferences<a name="ReverseProxyIFrame_Portlet_Preferences"></a></h3> + +<p> + <i> + 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: + </p> +<div class="source"> +<pre>emptySessionPath="true"</pre></div> + </i> + + +<table border="0" class="bodyTable"> + +<tr class="a"> + +<th>Name</th> + +<th>Example Value</th> + +<th>Description</th> + </tr> + +<tr class="b"> + +<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 /> + </p> +<ul> - <li class="none"> - <a href=".././webcontent2/war-module.html">WAR Module</a> - </li> +<li>http://localhost:8080/webcontent/index.html</li> - <li class="none"> - <a href=".././webcontent2/build-from-source.html">Build from source</a> - </li> +<li>http://localhost:${serverPort}/webcontent/index.html</li> - <li class="none"> - <a href=".././webcontent2/apidocs/index.html">JavaDocs</a> - </li> +<li>http://${serverName}:${serverPort}/webcontent/index.html</li> - <li class="none"> - <a href=".././webcontent2/faq.html">FAQ</a> - </li> - </ul> - </li> +<li>http://${serverName}:${serverPort}/${contextPath}/index.html</li> + </ul> - <li class="none"> - <a href=".././webcontent/index.html">WebContent-1</a> - </li> - - <li class="none"> - <a href=".././dbbrowser/index.html">DB Browser</a> - </li> - - <li class="none"> - <a href=".././logging/index.html">Logging</a> - </li> - </ul> - <h5>Support</h5> - <ul> - - <li class="none"> - <a href="../team-list.html">Project Team</a> - </li> - - <li class="none"> - <a href="../license.html">Project License</a> - </li> - - <li class="none"> - <a href="http://wiki.apache.org/portals/applications" class="externalLink">Project Wiki</a> - </li> + </td> + </tr> + +<tr class="a"> + +<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 /> + </p> +<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> - <li class="none"> - <a href="../mail-lists.html">Mailing List</a> - </li> + </td> + </tr> + +<tr class="b"> + +<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 /> + </p> +<ul> + +<li>/webcontent/rproxy/portals</li> + +<li>${contextPath}/rproxy/portals</li> + </ul> - <li class="none"> - <a href="../issue-tracking.html">Issue Tracking</a> - </li> - </ul> - <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> - <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img> - </a> - - + </td> + </tr> + +<tr class="a"> + +<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 class="b"> + +<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 class="a"> + +<td>HEIGHT</td> + +<td>300</td> + +<td>The height of the IFrame window when in Normal Window State</td> + </tr> + +<tr class="b"> + +<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 class="a"> + +<td>MAX-HEIGHT</td> + +<td>800</td> + +<td>The height of the IFrame window when in Maximized Window State</td> + </tr> + +<tr class="b"> + +<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 class="a"> + +<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> + + </div> - - - - - - </div> - </div> - <div id="bodyColumn"> - <div id="contentBox"> - <subtitle></subtitle><authors><person name="David Sean Taylor" email="[email protected]"></authors><div class="section"><h2><a name="Welcome_to_Apache_Portals_Web_Content_Application"></a>Welcome to Apache Portals Web Content Application</h2> -<div id="downloadbox"><h5>Get Portals Web Content App</h5> -<p><a href="../download.html"><img src="../images/folder-open.gif" alt="" /> - Download - </a> - Portals Applications WebContent 1.3 - </p> -<ul><li><a href="../getting-started.html">System Requirements</a></li> -</ul> -</div><p> - A portlet application dedicated to the development of Web Content - rewriting and IFrame based web content. The portlet applications - here are designed to host content - from another web site or local servlet inside of a portlet window. - </p> -<p> - The Web Content portet application consists of three 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> -</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 class="externalLink" 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 class="externalLink" 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> -<div class="source"><pre> -<portlet-class>org.apache.portals.applications.webcontent.portlet.IFrameGenericPortlet</portlet-class> - </pre> -</div> -<p><em>Note: The ReverseProxyIFramePortlet uses the same class, but has different preferences configurations.</em></p> -<p>or</p> -<div class="source"><pre> -<portlet-class>org.apache.portals.applications.webcontent.portlet.WebContentPortlet</portlet-class> - </pre> -</div> -<div class="section"><h3><a name="Web_Content_Portlet_Preferences"></a>Web Content Portlet Preferences</h3> -<table class="bodyTable"><tr class="a"><th>Name</th> -<th>Example Value</th> -<th>Description</th> -</tr> -<tr class="b"><td>SRC</td> -<td>http://www.google.com</td> -<td>The URL of the remote or local site to be hosted. - </td> -</tr> -<tr class="a"><td>PROXYHOST</td> -<td>proxyserver1.mycompany.com</td> -<td>The proxy server host name.</td> -</tr> -<tr class="b"><td>PROXYPORT</td> -<td>8000</td> -<td>The proxy server port.</td> -</tr> -</table> -</div> -<div class="section"><h3><a name="IFrame_Portlet_Preferences"></a>IFrame Portlet Preferences</h3> -<table class="bodyTable"><tr class="a"><th>Name</th> -<th>Example Value</th> -<th>Description</th> -</tr> -<tr class="b"><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 class="a"><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 class="b"><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 class="a"><td>HEIGHT</td> -<td>300</td> -<td>The height of the IFrame window when in Normal Window State</td> -</tr> -<tr class="b"><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 class="a"><td>MAX-HEIGHT</td> -<td>800</td> -<td>The height of the IFrame window when in Maximized Window State</td> -</tr> -<tr class="b"><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 class="a"><td>SCROLLING</td> -<td>AUTO | YES | NO</td> -<td>Specifies whether or not to display scrollbars in an iframe</td> -</tr> -</table> -</div> -<div class="section"><h3><a name="ReverseProxyIFrame_Portlet_Preferences"></a>ReverseProxyIFrame Portlet Preferences</h3> -<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: - <div class="source"><pre>emptySessionPath="true"</pre> -</div> -</em></p> -<table class="bodyTable"><tr class="b"><th>Name</th> -<th>Example Value</th> -<th>Description</th> -</tr> -<tr class="a"><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 class="b"><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 class="a"><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 class="b"><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 class="a"><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 class="b"><td>HEIGHT</td> -<td>300</td> -<td>The height of the IFrame window when in Normal Window State</td> -</tr> -<tr class="a"><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 class="b"><td>MAX-HEIGHT</td> -<td>800</td> -<td>The height of the IFrame window when in Maximized Window State</td> -</tr> -<tr class="a"><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 class="b"><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> -</div> -<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" /></div> + +<p>Here are examples of the Web Content, IFrame and ReverseProxyIFrame Portlets:</p> + <br /> + <img src="../images/wc.png" alt="" /> + <br /> + <img src="../images/iframe.png" alt="" /> + <br /> + <img src="../images/rproxyif.png" alt="" /> - </div> </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright">© - 2004-2015 - - Apache Software Foundation - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> -</html> + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright"> + Copyright © 2004-2022 + <a href="http://www.apache.org/">Apache Software Foundation</a>. + All Rights Reserved. + + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html>
