[portal-commits] JBoss Portal SVN: r12611 - docs/enterprise/trunk/Reference_Guide/en-US.

Author: thomas.heute(a)jboss.com Date: 2009-01-22 12:46:05 -0500 (Thu, 22 Jan 2009) New Revision: 12611 Modified: docs/enterprise/trunk/Reference_Guide/en-US/Configuration.xml docs/enterprise/trunk/Reference_Guide/en-US/Identity_Portlets.xml docs/enterprise/trunk/Reference_Guide/en-US/Migration.xml docs/enterprise/trunk/Reference_Guide/en-US/Supported.xml docs/enterprise/trunk/Reference_Guide/en-US/Tutorials.xml docs/enterprise/trunk/Reference_Guide/en-US/URLs.xml docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml Log: Improvements Modified: docs/enterprise/trunk/Reference_Guide/en-US/Configuration.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Configuration.xml 2009-01-22 16:39:10 UTC (rev 12610) +++ docs/enterprise/trunk/Reference_Guide/en-US/Configuration.xml 2009-01-22 17:46:05 UTC (rev 12611) @@ -2,26 +2,16 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd"> <chapter id="configuration"> - <!-- <chapterinfo> - <author> - <firstname>Thomas</firstname> - <surname>Heute</surname> - </author> - <author> - <firstname>Roy</firstname> - <surname>Russo</surname> - </author> - </chapterinfo>--> <title>Customizing your Installation</title> <para> - This chapter describes how to customize the default installation. This includes the JBoss EAP or JBoss AS listening port, + This chapter describes how to customize the default installation. This includes the JBoss EAP listening port, email and proxy settings, and database dialect settings. For further configuration details, refer to <xref linkend="portaldescriptors"/> and <xref linkend="troubleshooting"/>. <note> <title> - Choosing server Coniguration + Choosing server Configuration </title> <para> - In rest of the document, you will see several references of <filename>$JBOSS_HOME/server/production/</filename>. This applies to + In rest of the document, you will see several references of <filename>$JBOSS_HOME/server/production/</filename>. This also applies to <filename>$JBOSS_HOME/server/default/</filename> as well as <filename>$JBOSS_HOME/server/all/</filename> </para> </note> @@ -29,7 +19,12 @@ <section> <title>Changing the Port</title> <para> - It is common for web services to run on port 80. By default, JBoss EAP and JBoss AS use port 8080. If you can not use <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=UsingPortForwardingWit... forwarding</ulink>, it is recommended to change the port JBoss EAP or JBoss AS listens on. To change the default port, open the <filename>$JBOSS_HOME/server/production/deploy/jboss-web.deployer/server.xml</filename> file, and edit the <computeroutput>Connector port</computeroutput> value for the <computeroutput>jboss.web</computeroutput> service; however, this configuration only applies to Apache Tomcat: + It is common for web services to run on port 80. By default, JBoss EAP and JBoss AS use port 8080. + If you can not use <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=UsingPortForwardingWit... + forwarding</ulink>, it is recommended to change the port JBoss EAP or JBoss AS listens on. To change the + default port, open the <filename>$JBOSS_HOME/server/production/deploy/jboss-web.deployer/server.xml</filename> + file, and edit the <computeroutput>Connector port</computeroutput> value for the + <computeroutput>jboss.web</computeroutput> service; however, this configuration only applies to Apache Tomcat: </para> <programlisting role="XML"> &lt;Service name="jboss.web"&gt; @@ -48,7 +43,7 @@ <warning> <title>Root User Privileges</title> <para> - Linux operating systems require root user privileges to run a service on a port less than 1024. Starting JBoss EAP or JBoss AS on port 80 as a non-privileged user will not work. Running JBoss EAP or JBoss AS as the root user could lead to security breaches. + Linux operating systems require root user privileges to run a service on a port less than 1024. Starting JBoss EAP on port 80 as a non-privileged user will not work. Running JBoss EAP as the root user could lead to security breaches. </para> </warning> </para> @@ -251,6 +246,9 @@ add them when starting Java.</para> <para>Usually setting up JAVA_OPTS environment variable to <literal>-Dhttp.proxyHost=YOUR_PROXY_HOST -Dhttp.proxyPort=YOUR_PROXY_PORT</literal> is enough.</para> + <note> + <para>If the proxy requires authentication, it is also possible to pass username and password by specifying those additional parameters: <literal>-Dhttp.proxyUser=MYUSERNAME -Dhttp.proxyPassword=MYPASSWORD</literal></para> + </note> </section> <section> <title>Disabling Dynamic Proxy Un-wrapping</title> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Identity_Portlets.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Identity_Portlets.xml 2009-01-22 16:39:10 UTC (rev 12610) +++ docs/enterprise/trunk/Reference_Guide/en-US/Identity_Portlets.xml 2009-01-22 17:46:05 UTC (rev 12611) @@ -3,17 +3,11 @@ "http://www.docbook.org/xml/4.5/docbookx.dtd"> <chapter id="identityportlets"> -<!-- <chapterinfo> - <author> - <firstname>Emanuel</firstname> - <surname>Muckenhuber</surname> - </author> - </chapterinfo>--> <title>JBoss Portal Identity Portlets</title> <section id="identity_portlet_introduction"> <title>Introduction</title> <para> - Since JBoss Portal 2.6.2 two new Identity Portlets are + Two Identity Portlets are shipped by default: <itemizedlist> <listitem> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Migration.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Migration.xml 2009-01-22 16:39:10 UTC (rev 12610) +++ docs/enterprise/trunk/Reference_Guide/en-US/Migration.xml 2009-01-22 17:46:05 UTC (rev 12611) @@ -3,22 +3,16 @@ "http://www.docbook.org/xml/4.5/docbookx.dtd"> <chapter id="changelog"> - <!-- <chapterinfo> - <author> - <firstname>Thomas</firstname> - <surname>Heute</surname> - </author> - </chapterinfo>--> - <title>Upgrading JBoss Portal 2.6 to 2.7</title> + <title>Upgrading JBoss Portal 2.6 to Enterprise Portal Platform 4.3</title> <para> <warning> <para> - Before performing any instructions or operations in this chapter, back up your database and the entire JBoss EAP or JBoss AS directory! + Before performing any instructions or operations in this chapter, back up your database and the entire JBoss EAP directory! </para> </warning> </para> <para> - JBoss Portal 2.7 compatibility with JBoss Portal 2.6 is very high. The main differences are the use of JSR-286 features to replace + Enterprise Portal Platform 4.3 compatibility with JBoss Portal 2.6 is very high. The main differences are the use of JSR-286 features to replace JBoss Portal specific features. The database schema hasn't changed. </para> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Supported.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Supported.xml 2009-01-22 16:39:10 UTC (rev 12610) +++ docs/enterprise/trunk/Reference_Guide/en-US/Supported.xml 2009-01-22 17:46:05 UTC (rev 12611) @@ -3,28 +3,19 @@ "http://www.docbook.org/xml/4.5/docbookx.dtd"> <chapter id="supportedversions"> - <!-- <chapterinfo> - <author> - <firstname>Thomas</firstname> - <surname>Heute</surname> - </author> - <author> - <firstname>Roy</firstname> - <surname>Russo</surname> - </author> - </chapterinfo>--> <title>System Requirements</title> <para> - The following chapter details hardware and software versions that are compatible with Enterprise Portal Platform. The hardware and software listed has either been tested, or reported as working by users. Before reporting a problem, make sure you are using compatible hardware and software. + The following chapter details hardware and software versions that are compatible with Enterprise Portal Platform. + The hardware and software listed has been tested and is supported. </para> <para> - If you successfully installed Enterprise Portal Platform on versions not listed here, please let us know so it can be added to this section. + If you want to use the Enterprise Portal Platform on other combinations, please let your sale representative know. </para> <section> <title>Minimum System Requirements</title> <para> <itemizedlist> - <listitem><para>JDK 5 (JDK 6 is not part of the test platform)</para></listitem> + <listitem><para>JDK 5 or JDK 6 (requires modification, see the <ulink url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Application_P... guide</ulink></para></listitem> <listitem><para>512 MB RAM</para></listitem> <listitem><para>100 MB hard disk space</para></listitem> <listitem><para>400 MHz CPU</para></listitem> @@ -39,15 +30,11 @@ </section> <section> <title>JBoss Enterprise Application Platform (EAP)</title> - <para>Enterprise Portal Platform 2.7.0 is tested with JBoss EAP 4.3_CP03. It is highly recommended that customers who have access to the <ulink url="https://support.redhat.com/portal/login.html">JBoss Customer Support Portal (CSP)</ulink> use JBoss EAP 4.3_CP03. - </para> - <warning> - <para>Other JBoss Application Sever (AS) and EAP versions <replaceable>x</replaceable> are not supported.</para> - </warning> + <para>Enterprise Portal Platform 4.3 embeds JBoss EAP 4.3_CP03 and supports the same environment unless specified.</para> </section> <section id="supportedversions-db"> <title>Databases</title> - <para>Enterprise Portal Platform is database-agnostic. The following list outlines known-to-be-working database vendor and version combinations:</para> + <para>Enterprise Portal Platform is database-agnostic. The following list outlines tested database vendor and version combinations:</para> <itemizedlist> <listitem><para><trademark class="registered">MySQL</trademark> 4 (use <ulink url="http://dev.mysql.com/downloads/connector/j/3.1.html">Co... 3.1</ulink>) and 5 (<ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=AvoidMySQL5DataTruncat... issue</ulink>)</para></listitem> <listitem><para>PostgreSQL 8.<replaceable>x</replaceable></para></listitem> @@ -57,7 +44,7 @@ <listitem><para><trademark class="registered">Microsoft</trademark><trademark class="registered"> SQL Server</trademark></para></listitem> <listitem><para>MaxDB</para></listitem> </itemizedlist> - <para>Enterprise Portal Platform employs Hibernate as an interface to a Relational Database Management System (RDBMS). Most Relational Database Management Systems supported by Hibernate will work with Enterprise Portal Platform.</para> + <para>Enterprise Portal Platform employs Hibernate as an interface to a Relational Database Management System (RDBMS).</para> </section> <section> <title>Source Building</title> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Tutorials.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Tutorials.xml 2009-01-22 16:39:10 UTC (rev 12610) +++ docs/enterprise/trunk/Reference_Guide/en-US/Tutorials.xml 2009-01-22 17:46:05 UTC (rev 12611) @@ -121,12 +121,7 @@ that portlet developers read and understand the <ulink url="http://www.jcp.org/en/jsr/detail?id=286"> JSR-286 Portlet Specification - </ulink> - . Feel free to use the - <ulink url="http://jboss.org/index.html?module=bb&amp;op=viewforum&... - JBoss Portal User Forums - </ulink> - for user-to-user help. + </ulink>. </para> <section> <title>Deploying your first Portlet</title> @@ -137,8 +132,8 @@ find the <emphasis>SimplestHelloWorld</emphasis> portlet in the - <literal>examples</literal> - directory at the root of your JBoss Portal binary package. + <literal>jboss-epp-4.3/jboss-as/docs/portal</literal> + directory of your distribution. </para> </section> <section> @@ -750,10 +745,10 @@ page to render the markup. We will use the portlet tag library to generate links to our portlet in different ways and use the other standard portlet modes. This example can be found in the directory - <literal>JSPHelloUser</literal>. + <literal>jboss-epp-4.3/jboss-as/docs/portal/JSPHelloUser</literal>. Use <literal>mvn package</literal> then copy <filename>JSPHelloUser/target/JSPHelloUser-0.0.1.war</filename> in the <literal>deploy</literal> directory of JBoss Application Server. - Point your brwoser to <literal></literal>, you should see the following: + Point your browser to <literal></literal>, you should see the following: <mediaobject> <imageobject> <imagedata @@ -1122,7 +1117,7 @@ <para>In order to write a portlet using JSF we need a piece of software called 'bridge' that lets us write a portlet application as if it was a JSF application, the bridge takes care of the interactions between the two layers.</para> - <para>Such an example is available in examples/JSFHelloUser, it uses the JBoss Portlet Bridge. + <para>Such an example is available in jboss-epp-4.3/jboss-as/docs/portal/JSFHelloUser, it uses the JBoss Portlet Bridge. The configuration is slightly different from a JSP application, since it is a bit tricky it is usally a good idea to copy an existing application that starting from scratch.</para> <para>First, as any JSF application, the file <literal>faces-config.xml</literal> is required. It includes Modified: docs/enterprise/trunk/Reference_Guide/en-US/URLs.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/URLs.xml 2009-01-22 16:39:10 UTC (rev 12610) +++ docs/enterprise/trunk/Reference_Guide/en-US/URLs.xml 2009-01-22 17:46:05 UTC (rev 12611) @@ -55,10 +55,14 @@ </para> </listitem> </itemizedlist> - - <note><title>Note</title><para>The default page or portal can be specified either by using the admin portlet or by using the XML descriptors as explained in the <xref linkend="xml.default.objectname.property"/>.</para></note> + <para> + A default link like http://localhost:8080/portal/portal/foo/bar can be decomposed as hostname:port:/contextPath/'portal'/portalName/pageName. The 'portal' part can be modified in: + <literal>jboss-portal.sar/portal-core.sar/META-INF/jboss-service.xml</literal> by modifying the attribute <literal>Path</literal> on the two + following MBEans: <literal>portal:commandFactory=Delegate,path=portal</literal> and <literal>portal:commandFactory=Delegate,path=portal"</literal>, however this cannot be changed to '/'. + </para> + + <note><title>Note</title><para>The default page or portal can be specified either by using the admin portlet or by using the XML descriptors as explained in the <xref linkend="xml.default.objectname.property"/>.</para></note> - </section> <section> <title>Accessing a Page</title> Modified: docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml 2009-01-22 16:39:10 UTC (rev 12610) +++ docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml 2009-01-22 17:46:05 UTC (rev 12611) @@ -785,7 +785,12 @@ <section id="desc_objectxml"> <title><filename>*-object.xml</filename> Descriptors</title> <para> - The <filename>*-object.xml</filename> descriptors define portal instances, pages, windows, and the window layout. As well, themes and layouts for specific portal instances, pages, and windows, can be defined. The following example defines a portlet window being added to the <computeroutput>default</computeroutput> page, in the <computeroutput>default</computeroutput> portal. For advanced functionality using these descriptors, refer to <xref linkend="desc_examples"/>: + The <filename>*-object.xml</filename> descriptors define portal instances, pages, windows, and the window layout. + You can define several files if you want to split them into many files, they just all have to end with '-object.xml'. + As well, themes and layouts for specific portal instances, pages, and windows, can be defined. The following example + defines a portlet window being added to the <computeroutput>default</computeroutput> page, in the + <computeroutput>default</computeroutput> portal. For advanced functionality using these descriptors, refer to + <xref linkend="desc_examples"/>: </para> <programlisting role="XML"><![CDATA[ <?xml version="1.0" encoding="UTF-8"?>