[portal-commits] JBoss Portal SVN: r6264 - docs/trunk/referenceGuide/en/modules.

Author: chris.laprun(a)jboss.com Date: 2007-02-14 01:14:20 -0500 (Wed, 14 Feb 2007) New Revision: 6264 Modified: docs/trunk/referenceGuide/en/modules/configuration.xml docs/trunk/referenceGuide/en/modules/wsrp.xml Log: - Updated documentation on configuring ports, pointing to the Wiki. - Minor other improvements. Modified: docs/trunk/referenceGuide/en/modules/configuration.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/configuration.xml 2007-02-14 05:29:16 UTC (rev 6263) +++ docs/trunk/referenceGuide/en/modules/configuration.xml 2007-02-14 06:14:20 UTC (rev 6264) @@ -46,19 +46,8 @@ ]]> </programlisting> </para> - <para>You also need to change the port number in the following files for WSRP: - <itemizedlist> - <listitem> - <literal>jboss-portal.sar/portal-wsrp.sar/default-wsrp.xml</literal> - </listitem> - <listitem> - <literal>jbossws.sar/META-INF/jboss-service.xml</literal> - as indicated in - <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBWSFAQURLRewriting&qu... WS' URL rewriting - FAQ - </ulink> - </listitem> - </itemizedlist> + <para> + Please refer to <xref linkend="wsrp-ports"/> to update the WSRP after having changed the port. </para> <para>Now you can restart JBoss and use the new port that you defined. On systems like Linux, you need privileges to be able to run a server on a port lower than 1000, starting JBoss on Modified: docs/trunk/referenceGuide/en/modules/wsrp.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/wsrp.xml 2007-02-14 05:29:16 UTC (rev 6263) +++ docs/trunk/referenceGuide/en/modules/wsrp.xml 2007-02-14 06:14:20 UTC (rev 6264) @@ -69,11 +69,19 @@ </para> </sect2> + <sect2 id="wsrp-ports"> + <title>Considerations to use WSRP when running Portal on a non-default port</title> + <para>If you have modified the port number on which Portal runs, you will also need + <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=WSRPChangePorts"&... the port information for WSRP</ulink> + as found on <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossPortal">J... Portal's wiki</ulink>. + </para> + </sect2> + <sect2> <title>Considerations to use WSRP with SSL</title> - <para>It is possible to use WSRP over SSL for secure exchanges of data. Please refer to the - <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=WSRPUseSSL">in...;. on - how to do so as found on + <para>It is possible to use WSRP over SSL for secure exchange of data. Please refer to the + <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=WSRPUseSSL">in... on + how to do so from <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossPortal">J... Portal's wiki</ulink>. </para> </sect2> @@ -145,20 +153,21 @@ <sect1> <title>Consuming JBoss Portal's WSRP portlets from a remote Consumer</title> <para>WSRP Consumers vary a lot as far as how they are configured. Most of them require that you either specify - the URL for the Producer's WSDL definition or the URLs for the individual endpoints. + the URL for the Producer's WSDL definition or the URLs for the individual endpoints. Please refer to your + Consumer's documentation for specific instructions. </para> <para> JBoss Portal's Producer is automatically set up when you deploy a portal instance with the WSRP service. - Assuming you're running a - default configuration (i.e. you haven't changed the server's port number), you can access the WSDL file at - <literal>http://localhost:8080/portal-wsrp/MarkupService?wsdl</literal>. You can access the endpoint URLs at: + You can access the WSDL file at + <literal>http://{hostname}:{port}/portal-wsrp/MarkupService?wsdl</literal>. You can access the endpoint URLs at: <itemizedlist> - <listitem>http://localhost:8080/portal-wsrp/ServiceDescriptionService</listitem> - <listitem>http://localhost:8080/portal-wsrp/MarkupService</listitem> - <listitem>http://localhost:8080/portal-wsrp/RegistrationService</listitem> - <listitem>http://localhost:8080/portal-wsrp/PortletManagementService</listitem> + <listitem><literal>http://{hostname}:{port}/portal-wsrp/ServiceDescriptionService</literal></listitem> + <listitem><literal>http://{hostname}:{port}/portal-wsrp/MarkupService</literal></listitem> + <listitem><literal>http://{hostname}:{port}/portal-wsrp/RegistrationService</literal></listitem> + <listitem><literal>http://{hostname}:{port}/portal-wsrp/PortletManagementService</literal></listitem> </itemizedlist> - </para> + The default hostname is <literal>localhost</literal> and the default port is 8080. + </para> </sect1> <sect1> @@ -463,10 +472,10 @@ and <literal>org.jboss.portal.Registration.policies.RegistrationPropertyValidator</literal> for more details on what is expected of each method. </para> - <para>As far as configuration of the Producer goes, a registration policy is required. This is accomplished + <para>Defining a registration policy is required for the producer to be correctly configured. This is accomplished by specifying the qualified class name of the registration policy via the <emphasis role="bold">&lt;registration-policy&gt;</emphasis> element. Since we anticipate that most users - will use the default registration policy, it is possible to use + will use the default registration policy, it is possible to use the <emphasis role="bold">&lt;registration-property-validator&gt;</emphasis> element and provide the class name of your custom property validator instead. Since specifying a property validator only makes sense in the context of the default registration policy, both elements are mutually exclusive.