Author: chris.laprun(a)jboss.com Date: 2007-12-03 18:38:42 -0500 (Mon, 03 Dec 2007) New Revision: 9259 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/wsrp.xml Log: - Started updating documentation (synchronization commit). Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/wsrp.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/wsrp.xml 2007-12-03 23:19:44 UTC (rev 9258) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/wsrp.xml 2007-12-03 23:38:42 UTC (rev 9259) @@ -223,34 +223,6 @@ portlet. </para> - <sect3> - <title>Using a WSRP Producer XML descriptor</title> - - <para>We will create a <emphasis>public-bea-wsrp.xml</emphasis> descriptor. Note that the actual name does not - matter as long as it ends with <emphasis>-wsrp.xml</emphasis>. - <programlisting><![CDATA[ -<?xml version='1.0' encoding='UTF-8' ?> -<!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD WSRP Remote Producer Configuration 2.6//EN" - "http://www.jboss.org/portal/dtd/jboss-wsrp-consumer_2_6.dtd"> -<deployments> - <deployment> - <wsrp-producer id="bea" expiration-cache="120"> - <endpoint-wsdl-url>http://wsrp.bea.com:7001/producer/producer?WSDL</endpoint-wsdl-url> - <registration-data> - <property> - <name>registration/consumerRole</name> - <lang>en</lang> - <value>public</value> - </property> - </registration-data> - </wsrp-producer> - </deployment> -</deployments>]]></programlisting> - This producer descriptor gives access to BEA's public WSRP producer. We will look at the details of the - different elements later. Note for now the <emphasis>producer-id</emphasis> element with a "bea" value. Put - this file in the deploy directory and start the server (with JBoss Portal and its WSRP service deployed). - </para></sect3> - <sect3 id="consumer_gui"> <title>Using the configuration portlet</title> <para> @@ -287,18 +259,17 @@ <imagedata fileref="images/wsrp/config_created.png" format="png" align="center" valign="middle"/> </imageobject> </mediaobject> - Set the cache expiration value to 120 seconds and check the "Use WSDL?" checkbox. The form should now - morph to: + Set the cache expiration value to 120 seconds and enter the WSDL URL for the producer in the text field + and press the "Save &amp; Refresh" button: <mediaobject> <imageobject> <imagedata fileref="images/wsrp/config_usewsdl.png" format="png" align="center" valign="middle"/> </imageobject> </mediaobject> - Enter the WSDL URL for the producer in the text field and press the "Save &amp; Refresh" button. This will retrieve - the service description associated with the Producer which WSRP is described by the WSDL file found at - the URL you just entered. In our case, querying the service description will allow us to learn that the - Producer requires registration and that it expects a value for the registration property named - "registration/consumerRole": + This will retrieve the service description associated with the Producer which WSRP is described by the + WSDL file found at the URL you just entered. In our case, querying the service description will allow us + to learn that the Producer requires registration and that it expects a value for the registration + property named "registration/consumerRole": <mediaobject> <imageobject> <imagedata fileref="images/wsrp/config_refresh.png" format="png" align="center" valign="middle"/> @@ -315,10 +286,48 @@ </mediaobject> The Consumer for the "bea" Producer should now be available as a portlet provider and is ready to be used. </para> - + <para> + A producer is configured, by default, by retrieving the producer's information via a WSDL URL. There are + rare cases, however, where URLs need to be provided for each of the producer's end points. You can do + exactly that by unchecking the "Use WSDL?" checkbox, as is the case for the <literal>self</literal> + producer: + <mediaobject> + <imageobject> + <imagedata fileref="images/wsrp/config_self.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + </para> </sect3> <sect3> + <title>Using a WSRP Producer XML descriptor</title> + + <para>We will create a <emphasis>public-bea-wsrp.xml</emphasis> descriptor. Note that the actual name does not + matter as long as it ends with <emphasis>-wsrp.xml</emphasis>. + <programlisting><![CDATA[ +<?xml version='1.0' encoding='UTF-8' ?> +<!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD WSRP Remote Producer Configuration 2.6//EN" + "http://www.jboss.org/portal/dtd/jboss-wsrp-consumer_2_6.dtd"> +<deployments> + <deployment> + <wsrp-producer id="bea" expiration-cache="120"> + <endpoint-wsdl-url>http://wsrp.bea.com:7001/producer/producer?WSDL</endpoint-wsdl-url> + <registration-data> + <property> + <name>registration/consumerRole</name> + <lang>en</lang> + <value>public</value> + </property> + </registration-data> + </wsrp-producer> + </deployment> +</deployments>]]></programlisting> + This producer descriptor gives access to BEA's public WSRP producer. We will look at the details of the + different elements later. Note for now the <emphasis>producer-id</emphasis> element with a "bea" value. Put + this file in the deploy directory and start the server (with JBoss Portal and its WSRP service deployed). + </para></sect3> + + <sect3> <title>Configuring access to a remote portlet</title> <para> Let's now look at the Admin page and the Management portlet. Click on the "Portlet definitions" tab at the @@ -568,12 +577,17 @@ <sect2> <title>Overview</title> <para> - You can configure the behavior of Portal's WSRP Producer by editing the <emphasis>conf/config.xml</emphasis> + You can configure the behavior of Portal's WSRP Producer by using the WSRP administration interface, which + is the preferred way, or by editing the <emphasis>conf/config.xml</emphasis> file found in <emphasis>portal-wsrp.sar</emphasis>. Several aspects can be modified with respects to whether registration is required for consumers to access the Producer's services. </para> </sect2> <sect2> + <para>Using the configuration portlet</para> + <para>TODO: ADD CONTENT</para> + </sect2> + <sect2> <title>Default configuration</title> <para> Let's look at the default configuration: