Author: smumford Date: 2010-05-24 01:29:09 -0400 (Mon, 24 May 2010) New Revision: 3182 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbossts-transaction-service.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/statistics.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/transaction-manager-lookup.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/WSRP.xml Log: JBEPP-276: Further QE edits. Outstanding issues in JIRA comment 24/May/10 01:28 AM Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbossts-transaction-service.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbossts-transaction-service.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbossts-transaction-service.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -8,7 +8,7 @@ <section id="sect-Reference_Guide-JBossTransactionsService-Introduction"> <title>Introduction</title> <para> - JBossTransactionsService implements eXo <xref linkend="chap-Reference_Guide-eXoJCR"/> and provides access to <ulink type="http" url="http://www.jboss.org/jbosstm/">JBoss Transaction Service (JBossTS)</ulink> JTA implementation via eXo container dependency. + JBossTransactionsService implements eXo JCR and provides access to <ulink type="http" url="http://www.jboss.org/jbosstm/">JBoss Transaction Service (JBossTS)</ulink> JTA implementation via eXo container dependency. </para> <para> TransactionService used in JCR cache <emphasis>org.exoplatform.services.jcr.impl.dataflow.persistent.jbosscache.JBossCacheWorkspaceStorageCache</emphasis> implementation. Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -395,7 +395,7 @@ </varlistentry> </variablelist> <para> - For information on defining other parameters, refer to the <ulink url="http://jakarta.apache.org/commons/dbcp/configuration.html"... DBCP configuration</ulink> + For information on defining other parameters, refer to the Apache DBCP configuration at <ulink url="http://jakarta.apache.org/commons/dbcp/configuration.html"... </para> </step> <step> @@ -596,41 +596,39 @@ The following example shows the settings for embedded mode for the <parameter>jdbcjcr</parameter> data container: </para> -<programlisting>&lt;external-component-plugins&gt; - &lt;target-component&gt;org.exoplatform.services.naming.InitialContextInitializer&lt;/target-component&gt; - &lt;component-plugin&gt; - &lt;name&gt;bind.datasource&lt;/name&gt; - &lt;set-method&gt;addPlugin&lt;/set-method&gt; - &lt;type&gt;org.exoplatform.services.naming.BindReferencePlugin&lt;/type&gt; - &lt;init-params&gt; - &lt;value-param&gt; - &lt;name&gt;bind-name&lt;/name&gt; - &lt;value&gt;jdbcjcr&lt;/value&gt; - &lt;/value-param&gt; - &lt;value-param&gt; - &lt;name&gt;class-name&lt;/name&gt; - &lt;value&gt;javax.sql.DataSource&lt;/value&gt; - &lt;/value-param&gt; - &lt;value-param&gt; - &lt;name&gt;factory&lt;/name&gt; - &lt;value&gt;org.apache.commons.dbcp.BasicDataSourceFactory&lt;/value&gt; - &lt;/value-param&gt; - &lt;properties-param&gt; - &lt;name&gt;ref-addresses&lt;/name&gt; - &lt;description&gt;ref-addresses&lt;/description&gt; - &lt;property name="driverClassName" value="org.postgresql.Driver"/&gt; - &lt;property name="url" value="jdbc:postgresql://exoua.dnsalias.net/portal"/&gt; - &lt;property name="username" value="exoadmin"/&gt; - &lt;property name="password" value="exo12321"/&gt; - &lt;property name="maxActive" value="50"/&gt; - &lt;property name="maxIdle" value="5"/&gt; - &lt;property name="initialSize" value="5"/&gt; - &lt;/properties-param&gt; - &lt;/init-params&gt; - &lt;/component-plugin&gt; - &lt;/external-component-plugins&gt; -</programlisting> - +<programlisting language="XML" role="XML"><![CDATA[<external-component-plugins> + <target-component>org.exoplatform.services.naming.InitialContextInitializer</target-component> + <component-plugin> + <name>bind.datasource</name> + <set-method>addPlugin</set-method> + <type>org.exoplatform.services.naming.BindReferencePlugin</type> + <init-params> + <value-param> + <name>bind-name</name> + <value>jdbcjcr</value> + </value-param> + <value-param> + <name>class-name</name> + <value>javax.sql.DataSource</value> + </value-param> + <value-param> + <name>factory</name> + <value>org.apache.commons.dbcp.BasicDataSourceFactory</value> + </value-param> + <properties-param> + <name>ref-addresses</name> + <description>ref-addresses</description> + <property name="driverClassName" value="org.postgresql.Driver"/> + <property name="url" value="jdbc:postgresql://exoua.dnsalias.net/portal"/> + <property name="username" value="exoadmin"/> + <property name="password" value="exo12321"/> + <property name="maxActive" value="50"/> + <property name="maxIdle" value="5"/> + <property name="initialSize" value="5"/> + </properties-param> + </init-params> + </component-plugin> + </external-component-plugins>]]></programlisting> <para> To configure multiple repository workspaces with a single database the "multi-db" parameter must be switched off (set the value to "false"). </para> @@ -638,64 +636,63 @@ The following example shows configuration for two workspaces <parameter>ws</parameter> (jdbcjcr) and <parameter>ws1</parameter> (jdbcjcr) which will be persisted in one <application>PostgreSQL</application> database: </para> -<programlisting>&lt;workspaces&gt; - &lt;workspace name="ws" auto-init-root-nodetype="nt:unstructured"&gt; - &lt;container class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer"&gt; - &lt;properties&gt; - &lt;property name="source-name" value="jdbcjcr"/&gt; - &lt;property name="dialect" value="pgsql"/&gt; - &lt;property name="multi-db" value="false"/&gt; - &lt;property name="max-buffer-size" value="200K"/&gt; - &lt;property name="swap-directory" value="target/temp/swap/ws"/&gt; - &lt;/properties&gt; - &lt;/container&gt; - &lt;cache enabled="true"&gt; - &lt;properties&gt; - &lt;property name="max-size" value="10K"/&gt; - &lt;property name="live-time" value="30m"/&gt; - &lt;/properties&gt; - &lt;/cache&gt; - &lt;query-handler class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex"&gt; - &lt;properties&gt; - &lt;property name="index-dir" value="../temp/index"/&gt; - &lt;/properties&gt; - &lt;/query-handler&gt; - &lt;lock-manager&gt; - &lt;time-out&gt;15m&lt;/time-out&gt; - &lt;persister class="org.exoplatform.services.jcr.impl.core.lock.FileSystemLockPersister"&gt; - &lt;properties&gt; - &lt;property name="path" value="target/temp/lock/ws"/&gt; - &lt;/properties&gt; - &lt;/persister&gt; - &lt;/lock-manager&gt; - &lt;/workspace&gt; - &lt;workspace name="ws1" auto-init-root-nodetype="nt:unstructured"&gt; - &lt;container class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer"&gt; - &lt;properties&gt; - &lt;property name="source-name" value="jdbcjcr"/&gt; - &lt;property name="dialect" value="pgsql"/&gt; - &lt;property name="multi-db" value="false"/&gt; - &lt;property name="max-buffer-size" value="200K"/&gt; - &lt;property name="swap-directory" value="target/temp/swap/ws1"/&gt; - &lt;/properties&gt; - &lt;/container&gt; - &lt;cache enabled="true"&gt; - &lt;properties&gt; - &lt;property name="max-size" value="10K"/&gt; - &lt;property name="live-time" value="5m"/&gt; - &lt;/properties&gt; - &lt;/cache&gt; - &lt;lock-manager&gt; - &lt;time-out&gt;15m&lt;/time-out&gt; - &lt;persister class="org.exoplatform.services.jcr.impl.core.lock.FileSystemLockPersister"&gt; - &lt;properties&gt; - &lt;property name="path" value="target/temp/lock/ws1"/&gt; - &lt;/properties&gt; - &lt;/persister&gt; - &lt;/lock-manager&gt; - &lt;/workspace&gt; -&lt;/workspaces&gt; -</programlisting> +<programlisting language="XML" role="XML"><![CDATA[<workspaces> + <workspace name="ws" auto-init-root-nodetype="nt:unstructured"> + <container class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer"> + <properties> + <property name="source-name" value="jdbcjcr"/> + <property name="dialect" value="pgsql"/> + <property name="multi-db" value="false"/> + <property name="max-buffer-size" value="200K"/> + <property name="swap-directory" value="target/temp/swap/ws"/> + </properties> + </container> + <cache enabled="true"> + <properties> + <property name="max-size" value="10K"/> + <property name="live-time" value="30m"/> + </properties> + </cache> + <query-handler class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex"> + <properties> + <property name="index-dir" value="../temp/index"/> + </properties> + </query-handler> + <lock-manager> + <time-out>15m</time-out> + <persister class="org.exoplatform.services.jcr.impl.core.lock.FileSystemLockPersister"> + <properties> + <property name="path" value="target/temp/lock/ws"/> + </properties> + </persister> + </lock-manager> + </workspace> + <workspace name="ws1" auto-init-root-nodetype="nt:unstructured"> + <container class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer"> + <properties> + <property name="source-name" value="jdbcjcr"/> + <property name="dialect" value="pgsql"/> + <property name="multi-db" value="false"/> + <property name="max-buffer-size" value="200K"/> + <property name="swap-directory" value="target/temp/swap/ws1"/> + </properties> + </container> + <cache enabled="true"> + <properties> + <property name="max-size" value="10K"/> + <property name="live-time" value="5m"/> + </properties> + </cache> + <lock-manager> + <time-out>15m</time-out> + <persister class="org.exoplatform.services.jcr.impl.core.lock.FileSystemLockPersister"> + <properties> + <property name="path" value="target/temp/lock/ws1"/> + </properties> + </persister> + </lock-manager> + </workspace> +</workspaces>]]></programlisting> <section id="sect-Reference_Guide-Single_database_configuration-Configuration_without_DataSource"> <title>Configuration without DataSource</title> @@ -715,16 +712,15 @@ </step> </procedure> -<programlisting>&lt;workspace name="ws" auto-init-root-nodetype="nt:unstructured"&gt; - &lt;container class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer"&gt; - &lt;properties&gt; - &lt;property name="dialect" value="hsqldb"/&gt; - &lt;property name="driverClassName" value="org.hsqldb.jdbcDriver"/&gt; - &lt;property name="url" value="jdbc:hsqldb:file:target/temp/data/portal"/&gt; - &lt;property name="username" value="su"/&gt; - &lt;property name="password" value=""/&gt; - ...... -</programlisting> +<programlisting language="XML" role="XML"><![CDATA[<workspace name="ws" auto-init-root-nodetype="nt:unstructured"> + <container class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer"> + <properties> + <property name="dialect" value="hsqldb"/> + <property name="driverClassName" value="org.hsqldb.jdbcDriver"/> + <property name="url" value="jdbc:hsqldb:file:target/temp/data/portal"/> + <property name="username" value="su"/> + <property name="password" value=""/> + ......]]></programlisting> <note> <para> Ensure the JDBC driver provides connection pooling. Connection pooling is required for use with JCR to prevent a database overload. @@ -784,13 +780,13 @@ <classname>org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer</classname>: </para> -<programlisting>&lt;workspaces&gt; - &lt;workspace name="ws" auto-init-root-nodetype="nt:unstructured"&gt; - &lt;container class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer"&gt; +<programlisting language="XML" role="XML"><![CDATA[<workspaces> + <workspace name="ws" auto-init-root-nodetype="nt:unstructured"> + <container class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer"> ... - &lt;/workspace&gt; -&lt;/worksapces&gt; -</programlisting> + </workspace> +</worksapces>]]></programlisting> + <para> Simple queries are implemented in such a way so as to support as many database dialects as possible. They do not use sub queries, or left or right joins. </para> @@ -798,13 +794,14 @@ <para> Complex queries will be used if you choose <classname>org.exoplatform.services.jcr.impl.storage.jdbc.optimisation.CQJDBCWorkspaceDataContainer</classname>: </para> -<programlisting>&lt;workspaces&gt; - &lt;workspace name="ws" auto-init-root-nodetype="nt:unstructured"&gt; - &lt;container class="org.exoplatform.services.jcr.impl.storage.jdbc.optimisation.CQJDBCWorkspaceDataContainer"&gt; + +<programlisting language="XML" role="XML"><![CDATA[<workspaces> + <workspace name="ws" auto-init-root-nodetype="nt:unstructured"> + <container class="org.exoplatform.services.jcr.impl.storage.jdbc.optimisation.CQJDBCWorkspaceDataContainer"> ... - &lt;/workspace&gt; -&lt;/worksapces&gt; -</programlisting> + </workspace> +</worksapces>]]></programlisting> + <para> Complex queries are optimized to reduce the number of requests made to a database. </para> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -41,28 +41,29 @@ </repositories> </repository-service>]]></programlisting> - <note> - <para> - Due to sizing constraints in the table below, all references to classes or values that begin with the string <literal>org.exoplatform.services.jcr.impl.core.query.lucene</literal> will be refered to as <literal>$lucene.<replaceable>identifier</replaceable></literal>. - </para> - <para> - For example; <literal>org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex</literal> will appear as <literal>$lucene.SearchIndex</literal> - </para> - </note> - <table pgwide="0" align="left" > + <table pgwide="1" align="left" > <title>Configuration parameters</title> <!--Removing 'version' column <tgroup cols="4"> --> <tgroup cols="3"> + <colspec colwidth="90pt"/> + <colspec colwidth="135pt"/> + <colspec colwidth="270pt"/> <thead> <row> <entry> - Parameter + <para> + Parameter + </para> </entry> <entry> - Default + <para> + Default + </para> </entry> <entry> - Description + <para> + Description + </para> </entry> <!-- <entry> Version @@ -72,13 +73,19 @@ <tbody> <row> <entry> - index-dir + <para> + index-dir + </para> </entry> <entry> - none + <para> + none + </para> </entry> <entry> - The location of the index directory. This parameter is mandatory. It is called "<literal>indexDir</literal>" in versions prior to version 1.9. + <para> + The location of the index directory. This parameter is mandatory. It is called "<literal>indexDir</literal>" in versions prior to version 1.9. + </para> </entry> <!--<entry> 1.0 @@ -86,13 +93,19 @@ </row> <row> <entry> - use-compoundfile + <para> + use-compoundfile + </para> </entry> <entry> - true + <para> + true + </para> </entry> <entry> - Advises lucene to use compound files for the index files. + <para> + Advises lucene to use compound files for the index files. + </para> </entry> <!-- <entry> 1.9 @@ -100,13 +113,19 @@ --> </row> <row> <entry> - min-merge-docs + <para> + min-merge-docs + </para> </entry> <entry> - 100 + <para> + 100 + </para> </entry> <entry> - The minimum number of nodes in an index until segments are merged. + <para> + The minimum number of nodes in an index until segments are merged. + </para> </entry> <!-- <entry> 1.9 @@ -114,13 +133,17 @@ --> </row> <row> <entry> - volatile-idle-time + <para> + volatile-idle-time + </para> </entry> <entry> 3 </entry> <entry> - Idle time in seconds until the volatile index part is moved to a persistent index even though <literal>minMergeDocs</literal> is not reached. + <para> + Idle time in seconds until the volatile index part is moved to a persistent index even though <literal>minMergeDocs</literal> is not reached. + </para> </entry> <!-- <entry> 1.9 @@ -128,13 +151,19 @@ --> </row> <row> <entry> - max-merge-docs + <para> + max-merge-docs + </para> </entry> <entry> - Integer.MAX_VALUE + <para> + Integer.MAX_VALUE + </para> </entry> <entry> - The maximum number of nodes in segments that will be merged. The default value changed to <literal>Integer.MAX_VALUE</literal> in JCR version 1.9. + <para> + The maximum number of nodes in segments that will be merged. The default value changed to <literal>Integer.MAX_VALUE</literal> in JCR version 1.9. + </para> </entry> <!-- <entry> 1.9 @@ -142,13 +171,19 @@ --> </row> <row> <entry> - merge-factor + <para> + merge-factor + </para> </entry> <entry> - 10 + <para> + 10 + </para> </entry> <entry> - Determines how often segment indices are merged. + <para> + Determines how often segment indices are merged. + </para> </entry> <!-- <entry> 1.9 @@ -156,13 +191,19 @@ --> </row> <row> <entry> - max-field-length + <para> + max-field-length + </para> </entry> <entry> - 10000 + <para> + 10000 + </para> </entry> <entry> - The number of words that are fulltext indexed at most per property. + <para> + The number of words that are fulltext indexed at most per property. + </para> </entry> <!-- <entry> 1.9 @@ -170,13 +211,19 @@ --> </row> <row> <entry> - cache-size + <para> + cache-size + </para> </entry> <entry> - 1000 + <para> + 1000 + </para> </entry> <entry> - Size of the document number cache. This cache maps uuids to lucene document numbers + <para> + Size of the document number cache. This cache maps uuids to lucene document numbers + </para> </entry> <!-- <entry> 1.9 @@ -184,13 +231,19 @@ --> </row> <row> <entry> - force-consistencycheck + <para> + force-consistencycheck + </para> </entry> <entry> - false + <para> + false + </para> </entry> <entry> - Runs a consistency check on every startup. If false, a consistency check is only performed when the search index detects a prior forced shutdown. + <para> + Runs a consistency check on every startup. If false, a consistency check is only performed when the search index detects a prior forced shutdown. + </para> </entry> <!-- <entry> 1.9 @@ -198,13 +251,19 @@ --> </row> <row> <entry> - auto-repair + <para> + auto-repair + </para> </entry> <entry> - true + <para> + true + </para> </entry> <entry> - Errors detected by a consistency check are automatically repaired. If false, errors are only written to the log. + <para> + Errors detected by a consistency check are automatically repaired. If false, errors are only written to the log. + </para> </entry> <!-- <entry> 1.9 @@ -218,7 +277,13 @@ QueryImpl </entry> <entry> - Classname that implements the javax.jcr.query.Query interface.This class must also extend from the class: org.exoplatform.services.jcr.impl.core.query.AbstractQueryImpl. + <para> + Classname that implements the javax.jcr.query.Query interface. + </para> + <para> + This class must also extend from the class: <literal>org.exoplatform.services.jcr.impl.core. +query.AbstractQueryImpl</literal>. + </para> </entry> <!-- <entry> 1.9 @@ -226,13 +291,19 @@ --> </row> <row> <entry> - document-order + <para> + document-order + </para> </entry> <entry> - true + <para> + true + </para> </entry> <entry> - If true and the query does not contain an 'order by' clause, result nodes will be in document order. For better performance set to 'false' when queries return many nodes. + <para> + If true and the query does not contain an 'order by' clause, result nodes will be in document order. For better performance set to 'false' when queries return many nodes. + </para> </entry> <!-- <entry> 1.9 @@ -240,13 +311,19 @@ --> </row> <row> <entry> - result-fetch-size + <para> + result-fetch-size + </para> </entry> <entry> - Integer.MAX_VALUE + <para> + Integer.MAX_VALUE + </para> </entry> <entry> - The number of results when a query is executed. Default value: <literal>Integer.MAX_VALUE</literal>. + <para> + The number of results when a query is executed. Default value: <literal>Integer.MAX_VALUE</literal>. + </para> </entry> <!-- <entry> 1.9 @@ -254,13 +331,23 @@ --> </row> <row> <entry> - excerptprovider-class + <para> + excerptprovider-class + </para> </entry> <entry> - DefaultXMLExcerpt + <para> + DefaultXMLExcerpt + </para> </entry> <entry> - The name of the class that implements <literal>$lucene.ExcerptProvider</literal>. This should be used for the <literal>rep:excerpt()</literal> function in a query. + <para> + The name of the class that implements <literal>org.exoplatform.services.jcr.impl.core. +query.lucene.ExcerptProvider</literal>. + </para> + <para> + This should be used for the <literal>rep:excerpt()</literal> function in a query. + </para> </entry> <!-- <entry> 1.9 @@ -268,13 +355,19 @@ --> </row> <row> <entry> - support-highlighting + <para> + support-highlighting + </para> </entry> <entry> - false + <para> + false + </para> </entry> <entry> - If set to true additional information is stored in the index to support highlighting using the <literal>rep:excerpt()</literal> function. + <para> + If set to true additional information is stored in the index to support highlighting using the <literal>rep:excerpt()</literal> function. + </para> </entry> <!-- <entry> 1.9 @@ -282,13 +375,23 @@ --> </row> <row> <entry> - synonymprovider-class + <para> + synonymprovider-class + </para> </entry> <entry> - none + <para> + none + </para> </entry> <entry> - The name of a class that implements <literal>$lucene.SynonymProvider</literal>. The default value is null. + <para> + The name of a class that implements <literal>org.exoplatform.services.jcr.impl.core. +query.lucene.SynonymProvider</literal>. + </para> + <para> + The default value is null. + </para> </entry> <!-- <entry> 1.9 @@ -296,13 +399,19 @@ --> </row> <row> <entry> - synonymprovider-config-path + <para> + synonymprovider-config-path + </para> </entry> <entry> - none + <para> + none + </para> </entry> <entry> - The path to the synonym provider configuration file. This path is interpreted relative to the path parameter. If there is a path element inside the <literal>SearchIndex</literal> element, then this path is interpreted relative to the root path of the path. Whether this parameter is mandatory depends on the synonym provider implementation. The default value is null. + <para> + The path to the synonym provider configuration file. This path is interpreted relative to the path parameter. If there is a path element inside the <literal>SearchIndex</literal> element, then this path is interpreted relative to the root path of the path. Whether this parameter is mandatory depends on the synonym provider implementation. The default value is null. + </para> </entry> <!-- <entry> 1.9 @@ -310,13 +419,19 @@ --> </row> <row> <entry> - indexing-configuration-path + <para> + indexing-configuration-path + </para> </entry> <entry> - none + <para> + none + </para> </entry> <entry> - The path to the indexing configuration file. + <para> + The path to the indexing configuration file. + </para> </entry> <!-- <entry> 1.9 @@ -324,13 +439,20 @@ --> </row> <row> <entry> - indexing-configuration-class + <para> + indexing-configuration-class + </para> </entry> <entry> - IndexingConfigurationImpl + <para> + IndexingConfigurationImpl + </para> </entry> <entry> - The name of the class that implements <literal>$lucene.IndexingConfiguration</literal>. + <para> + The name of the class that implements <literal>org.exoplatform.services.jcr.impl.core. +query.lucene.IndexingConfiguration</literal>. + </para> </entry> <!-- <entry> 1.9 @@ -338,13 +460,19 @@ --> </row> <row> <entry> - force-consistencycheck + <para> + force-consistencycheck + </para> </entry> <entry> - false + <para> + false + </para> </entry> <entry> - If set to true a consistency check is performed depending on the parameter <literal>forceConsistencyCheck</literal>. If set to false no consistency check is performed on startup, even if a redo log had been applied. + <para> + If set to true a consistency check is performed depending on the parameter <literal>forceConsistencyCheck</literal>. If set to false no consistency check is performed on startup, even if a redo log had been applied. + </para> </entry> <!-- <entry> 1.9 @@ -352,13 +480,20 @@ --> </row> <row> <entry> - spellchecker-class + <para> + spellchecker-class + </para> </entry> <entry> - none + <para> + none + </para> </entry> <entry> - The name of a class that implements <literal>$lucene.SpellChecker</literal>. + <para> + The name of a class that implements <literal>org.exoplatform.services.jcr.impl.core. +query.lucene.SpellChecker</literal>. + </para> </entry> <!-- <entry> 1.9 @@ -366,13 +501,19 @@ --> </row> <row> <entry> - errorlog-size + <para> + errorlog-size + </para> </entry> <entry> - 50(Kb) + <para> + 50(Kb) + </para> </entry> <entry> - The default size of error log file in Kb. + <para> + The default size of error log file in Kb. + </para> </entry> <!-- <entry> 1.9 @@ -380,10 +521,14 @@ --> </row> <row> <entry> - upgrade-index + <para> + upgrade-index + </para> </entry> <entry> - false + <para> + false + </para> </entry> <entry> <para> @@ -411,13 +556,20 @@ --> </row> <row> <entry> - analyzer + <para> + analyzer + </para> </entry> <entry> - org.apache.lucene.analysis.standard.StandardAnalyzer + <para> + org.apache.lucene.analysis. + standard.StandardAnalyzer + </para> </entry> <entry> - Class name of a lucene analyzer to use for fulltext indexing of text. + <para> + Class name of a lucene analyzer to use for fulltext indexing of text. + </para> </entry> <!-- <entry> 1.12 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/statistics.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/statistics.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/statistics.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -58,6 +58,16 @@ <table id="tabl-Reference_Guide-Statistics_on_the_Database_Access_Layer-Method_Alias"> <title>Method Alias</title> <tgroup cols="2"> + <thead> + <row> + <entry> + Method Alias + </entry> + <entry> + Definition + </entry> + </row> + </thead> <tbody> <row> <entry> @@ -324,6 +334,20 @@ <table id="tabl-Reference_Guide-Statistics_Manager-Metric_Alias"> <title>Metric Alias</title> <tgroup cols="2"> + <thead> + <row> + <entry> + <para> + Metric Alias + </para> + </entry> + <entry> + <para> + Definition + </para> + </entry> + </row> + </thead> <tbody> <row> <entry> @@ -381,6 +405,20 @@ <table id="tabl-Reference_Guide-Statistics_Manager-JMX_Methods"> <title>JMX Methods</title> <tgroup cols="2"> + <thead> + <row> + <entry> + <para> + JMX Method + </para> + </entry> + <entry> + <para> + Definition + </para> + </entry> + </row> + </thead> <tbody> <row> <entry> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/transaction-manager-lookup.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/transaction-manager-lookup.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/transaction-manager-lookup.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -16,7 +16,7 @@ <type&gt;org.jboss.cache.transaction.JBossStandaloneJTAManagerLookup&lt;/type> </component>]]></programlisting> <para> - JBossStandaloneJTAManagerLookup used in standalone environment. But for Application Server environment use GenericTransactionManagerLookup. + In this example <literal>JBossStandaloneJTAManagerLookup</literal> is being used in a standalone environment. However use <literal>GenericTransactionManagerLookup</literal> for an Application Server environment . </para> </section> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -42,10 +42,10 @@ <section id="sect-Reference_Guide-Authentication_Token_Configuration-Configuring_token_services"> <title>Configuring Token Services</title> <para> - Token services configuration includes specifying the token validity period. The token service is configured as a portal component. + Token services configuration includes specifying the token validity period. The token service is configured as a portal component using the <filename>server/$CONF/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/autologin-configuration.xml</filename> file. </para> <para> - In the example below, <emphasis>CookieTokenService</emphasis> is a subclass of <emphasis role="bold">AbstractTokenService</emphasis> so it has a property which specifies the validity period of the token. + In the XML example below, <emphasis>CookieTokenService</emphasis> is a subclass of <emphasis role="bold">AbstractTokenService</emphasis> so it has a property which specifies the validity period of the token. </para> <para> The token service will initialize this validity property by looking for an <parameter>init-param</parameter> named <emphasis role="bold">service.configuration</emphasis>. Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -185,6 +185,14 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term>apiCacheConfig</term> <term>storeCacheConfig</term> + <listitem> + <para> + These options reference the JBoss cache configuration used for Picketlink. + </para> + </listitem> + </varlistentry> </variablelist> </callout> <callout arearefs="area-Reference_Guide-PicketLink_IDM_integration-Configuration_files-JBossIDMOrganizationServiceImpl"> @@ -276,6 +284,15 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term>useJTA</term> + <listitem> + <para> + This options reference the JBoss Transactions configuration used for Picketlink. + </para> +<!-- DOC TODO: Unsure if this decription of the useJTA option is correct. Extrapolated from info provided for cacheconfig options in previous varlist --> + </listitem> + </varlistentry> </variablelist> <para> Additionally, <literal>JBossIDMOrganizationServiceImpl</literal> uses those defaults to perform identity management operations Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -815,7 +815,7 @@ </step> <step> <para> - Repeat the above process for the "<emphasis role="bold">gatein</emphasis>" realm user privileges. + Repeat the above process for the '<emphasis role="bold">gatein</emphasis>' realm. </para> </step> </procedure> @@ -836,7 +836,7 @@ </step> <step> <para> - Edit the <filename>jboss-as/server/&lt;SERVER-TYPE&gt;/gatein.ear/META-INF/gatein-jboss-beans.xml</filename> and uncomment this section: + Edit the <filename>jboss-as/server/&lt;SERVER-TYPE&gt;/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename> and uncomment this section: </para> <programlisting language="XML" role="XML"><![CDATA[<authentication> <login-module code="org.gatein.sso.agent.login.SSOLoginModule" flag="required"> @@ -921,7 +921,7 @@ <init-param> <!-- This should point to your SSO authentication server --> <param-name>LOGIN_URL</param-name> - <param-value>http://localhost:8888/opensso/UI/Login?realm=gatein&amp;goto=http://localhost:8080 + <param-value>http://localhost:8888/opensso/UI/Login?realm=gatein&amp;amp;goto=http://localhost:8080 /portal/private/classic</param-value> </init-param> </filter> @@ -1016,7 +1016,7 @@ <title>SPNEGO Configuration</title> <step> <para> - Activate the Host authentication. Add the following host login module to the <filename>conf.xml</filename> or <filename>login-config.xml</filename> file (whichever your system uses): + Activate the Host authentication. Add the following host login module to the <filename>jboss-as/server/&lt;SERVER-TYPE&gt;/conf/login-config.xml</filename>: </para> <programlisting language="XML" role="XML"><![CDATA[<!-- SPNEGO domain --> <application-policy name="host"> @@ -1033,7 +1033,7 @@ </authentication> </application-policy>]]></programlisting> <para> - The '<literal>keyTab</literal>' value should point to the keytab file that was generated by the <literal>kadmin</literal> Kerberos tool. See the <citetitle>Setting up your Kerberos Development Environment</citetitle> guide for more details. + The '<literal>keyTab</literal>' value should point to the keytab file that was generated by the <literal>kadmin</literal> Kerberos tool. See the <ulink type="http" url="http://community.jboss.org/wiki/SettingupyourKerberosDevelopmen... up your Kerberos Development Environment</ulink> guide for more details. </para> </step> <step> @@ -1073,7 +1073,7 @@ </step> <step> <para> - Add the JBoss Negotiation binary by copying <filename>$GATEIN_SSO_HOME/spnego/jboss-negotiation-2.0.3.GA.jar</filename> to lib. DOC TODO &lt;-- Which directory is meant by 'lib'?? (deploy/gatein.ear/lib?) + Add the JBoss Negotiation binary by copying <filename>$GATEIN_SSO_HOME/spnego/jboss-negotiation-2.0.3.GA.jar</filename> to <filename>jboss-as/server/&lt;SERVER-TYPE&gt;/lib</filename>. </para> </step> <step> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -14,12 +14,12 @@ An example would hosting the portal from <emphasis role="bold">http://www.sample.com</emphasis> and the gadgets from <emphasis role="bold">http://www.samplemodules.com</emphasis>. </para> <para> - To do this, configure a parameter called <emphasis>gadgets.hostName</emphasis>. The value is the <emphasis>path/to/gadgetServer</emphasis> in <literal>GadgetRegisteryService</literal>: + To do this, configure the <emphasis>gadgets.hostName</emphasis> parameter in the <filename>server/$CONF/deploy/gatein.ear/02portal.war/WEB-INF/conf/portal/application-registry-configuration.xml</filename> file. The value is the <emphasis role="bold">path/to/gadgetServer</emphasis> in <literal>GadgetRegisteryService</literal>: </para> <programlisting language="XML" role="XML"><![CDATA[<component> <key>org.exoplatform.application.gadget.GadgetRegistryService</key> - <type>org.exoplatform.application.gadget.jcr.GadgetRegistryServiceImpl</type> + <type>org.exoplatform.application.gadget.impl.GadgetRegistryServiceImpl</type> <init-params> <value-param> <name>gadgets.hostName</name> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -232,6 +232,9 @@ <para> The file <filename>eXoGadgets.war/WEB-INF/gadget.xml</filename> defines the gadgets that will be available on a user dashboard. </para> + <para> + The example below shows a dashboard with all of the default gadgets included, as well as an extra currency converter gadget sourced from <ulink type="http" url="http://www.google.com/ig/directory?synd=open">Google Gadgets</ulink>. + </para> <programlisting role="XML" language="XML"><xi:include href="../../extras/gadgets.xml" xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" /></programlisting> </section> </chapter> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -287,8 +287,12 @@ javax.portlet.keywords=Breadcrumbs, Breadcrumb]]></programlisting> </section> +<!-- DOC TODO: This section requires more information. Source content and unmark section for next release. + <section id="sect-Reference_Guide-_Portlets_-Debugging_Resource_Bundle_Usage"> <title>Debugging Resource Bundle Usage</title> + + <para> When translating an application it can sometimes be difficult to find the right key for a given property. </para> @@ -301,7 +305,7 @@ <para> For example, the translated value for the key "<parameter>organization.title</parameter>" is simply the value "<parameter>organization.title</parameter>". Selecting that language allows use of the portal and its applications with all the keys visible. This makes it easier to find out the correct key for a given label in the portal page. </para> - </section> + </section> --> </section> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -330,16 +330,14 @@ You must also define the following <emphasis>init params</emphasis> in your <filename>portlet.xml</filename>. </para> -<programlisting language="XML" role="XML"><![CDATA[ - </init-param> - <init-param> - <name>javax.portlet.faces.autoDispatchEvents</name> - <value>true</value> - </init-param> - <init-param> - <name>javax.portlet.faces.bridgeEventHandler</name> - <value>org.foo.eventhandler</value> - </init-param> +<programlisting language="XML" role="XML"><![CDATA[ <init-param> + <name>javax.portlet.faces.autoDispatchEvents</name> + <value>true</value> + </init-param> + <init-param> + <name>javax.portlet.faces.bridgeEventHandler</name> + <value>org.foo.eventhandler</value> + </init-param> ]]></programlisting> <para> While future versions on the 2.0 bridge will automate the dispatching and consuming of events, at the moments you must dispatch the event in the JSF or Seam backing bean. Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -127,7 +127,7 @@ This section describes how to deploy a portlet in &PRODUCT;. </para> <para> - An example portlet called <filename>SimplestHelloWorld</filename> is located in the <literal>epp-doc/examples/portlets</literal> directory at the root of your &PRODUCT; sources package. + An example portlet called <filename>SimplestHelloWorld</filename> is available in the <filename>/jboss-epp-5.0-src/portal/examples/portlets/</filename> directory of the &PRODUCT; sources package or the <filename>boss-epp-5.0-docs/epp-doc/examples/portlets</filename> directory of the documentation package.. </para> <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Compiling"> <title>Compiling</title> @@ -161,6 +161,11 @@ </step> <step> <para> + Add the new portlet to the Application Registry. + </para> + </step> + <step> + <para> Create a new portal page and add the portlet to it. </para> @@ -228,7 +233,7 @@ <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class"> <title>Portlet Class</title> <para> - Below is the Java source for an example portlet named <filename>SimplestHelloWorldPortlet/src/main/java/org/gatein/portal/examples/portlets/SimplestHelloWorldPortlet.java </filename>: + Below is the Java source for an example portlet named <filename>simplesthelloworld/src/main/java/org/jboss/portal/portlet/samples</filename>: </para> <programlistingco> <areaspec> @@ -239,25 +244,25 @@ <area coords="17" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class.close" /> </areaspec> -<programlisting language="Java" role="JAVA"><![CDATA[package org.gatein.portal.examples.portlets; - +<programlisting language="Java" role="JAVA"><![CDATA[package org.jboss.portal.portlet.samples; + import java.io.IOException; import java.io.PrintWriter; - + import javax.portlet.GenericPortlet; import javax.portlet.RenderRequest; import javax.portlet.RenderResponse; - + public class SimplestHelloWorldPortlet extends GenericPortlet { - public void doView(RenderRequest request, - RenderResponse response) throws IOException + public void doView(RenderRequest request, RenderResponse response) throws IOException { PrintWriter writer = response.getWriter(); writer.write("Hello World !"); writer.close(); } -}]]></programlisting> +} +]]></programlisting> <calloutlist> <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class.extends"> <para> @@ -327,7 +332,7 @@ <portlet> <portlet-name>SimplestHelloWorldPortlet</portlet-name> <portlet-class> - org.gatein.portal.examples.portlets.SimplestHelloWorldPortlet + org.jboss.portal.portlet.samples.SimplestHelloWorldPortlet </portlet-class> <supports> <mime-type>text/html</mime-type> @@ -405,7 +410,8 @@ <formalpara> <title>Compiling the example</title> <para> - The example used in this section can be found in the <literal>epp-doc/examples/portlets</literal> directory at the root of your &PRODUCT; sources package. + The example used in this section is available in the <filename>/jboss-epp-5.0-src/portal/examples/portlets/</filename> directory of the &PRODUCT; sources package or the <filename>boss-epp-5.0-docs/epp-doc/examples/portlets</filename> directory of the documentation package. + </para> </formalpara> <para> @@ -427,6 +433,12 @@ Copy <filename>jsphellouser/target/gatein-jsp-hellouser-<replaceable>1.0.0-GA-SNAPSHOT</replaceable>.war</filename> to the <literal>deploy</literal> directory of JBoss Application Server. </para> </step> + <step> + <para> + Add the new portlet to the Application Registry. + </para> + </step> + <step> <para> Create a new portal page and add the portlet to it. @@ -441,11 +453,12 @@ <imagedata fileref="images/PortletDevelopment/Standard/jsp_portlet/output.png" format="PNG" align="center" contentwidth="120mm" /> </imageobject> </mediaobject> +<!-- Does not seem to appear any longer <note> <para> The <literal>EDIT</literal> button only appears for logged-in users. </para> - </note> + </note> --> <section id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-Package_Structure"> <title>Package Structure</title> <para> @@ -602,7 +615,7 @@ <calloutlist> <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.processAction"> <para> - <literal>processAction</literal> is the method from <literal>GernericPorlet</literal> to override for the <emphasis>action</emphasis> phase. + <literal>processAction</literal> is the method from <literal>GenericPorlet</literal> to override for the <emphasis>action</emphasis> phase. </para> </callout> <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.getActionParameter"> @@ -737,7 +750,7 @@ In order to write a portlet using JSF a 'bridge' is needed. This software allows developers to write a portlet application as if it was a JSF application. The bridge then negotiates the interactions between the two layers. </para> <para> - An example using the JBoss Portlet Bridge is available in the <literal>epp-doc/examples/portlets</literal> directory at the root of your &PRODUCT; sources package. The configuration is slightly different from a JSP application. This example can be used as a base to configure instead of creating a new application. + An example using the JBoss Portlet Bridge is available in the <filename>/jboss-epp-5.0-src/portal/examples/portlets/</filename> directory of the &PRODUCT; sources package or the <filename>/jboss-epp-5.0-docs/epp-doc/examples/portlets</filename> directory of the documentation package. The configuration is slightly different from a JSP application. This example can be used as a base to configure instead of creating a new application. </para> <para> As in any JSF application, the file <literal>faces-config.xml</literal> is required. It must contain the following information: Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/WSRP.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/WSRP.xml 2010-05-24 02:58:11 UTC (rev 3181) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/WSRP.xml 2010-05-24 05:29:09 UTC (rev 3182) @@ -344,7 +344,7 @@ <procedure> <step> <para> - Log into the portal as an administrator and go to the Application Registry (Click <ulink url="http://localhost:8080/portal/login?initialURI=%2Fportal%2Fprivate%2Fclassic%2Fadministration%2Fregistry&amp;username=root&amp;password=gtn">here</ulink> if using the default installation). + Log into the portal as an administrator and go to the Application Registry (Click <ulink url="http://localhost:8080/portal/private/classic/administration/registry">http://localhost:8080/portal/private/classic/administration/registry</ulink> if using the default installation). </para> </step> <step>