[jboss-cvs] jboss-portal-docs/referenceGuide/en/modules ...
Chris Laprun
chris.laprun at jboss.com
Wed Aug 9 13:05:38 EDT 2006
User: claprun
Date: 06/08/09 13:05:38
Modified: referenceGuide/en/modules wsrp.xml
Log:
Added introduction, improved to make it clearer.
Revision Changes Path
1.8 +129 -61 jboss-portal-docs/referenceGuide/en/modules/wsrp.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: wsrp.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-portal-docs/referenceGuide/en/modules/wsrp.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- wsrp.xml 26 May 2006 21:05:54 -0000 1.7
+++ wsrp.xml 9 Aug 2006 17:05:38 -0000 1.8
@@ -12,21 +12,60 @@
</author>
</chapterinfo>
- <title>Web Services for Remote Portlets</title>
+ <title>Web Services for Remote Portlets (WSRP)</title>
+
<sect1>
<title>Introduction</title>
- <para>Todo</para>
+ <para>The Web Services for Remote Portlets specification defines a web service interface for accessing and
+ interacting with interactive presentation-oriented web services. It has been produced through the efforts of
+ the Web Services for Remote Portlets (WSRP) OASIS Technical Committee. It is based on the requirements
+ gathered and on the concrete proposals made to the committee.</para>
+
+ <para>Scenarios that motivate WSRP functionality include:
+ <itemizedlist>
+ <listitem>Content hosts, such as portal servers, providing Portlets as presentation-oriented web services
+ that can be used by aggregation engines.</listitem>
+ <listitem>Aggregating frameworks, including portal servers, consuming presentation-oriented web services
+ offered by content providers and integrating them into the framework.</listitem>
+ </itemizedlist>
+ </para>
+
+ <para>More information on WSRP can be found on the
+ <ulink url="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wsrp">official website for WSRP</ulink>.
+ We suggest reading the <ulink url="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wsrp">primer</ulink>
+ for a good, albeit technical, overview of WSRP.
+ </para>
</sect1>
+
<sect1>
- <title>WSRP services</title>
- <para>The WSRP services are bundled with JBoss Portal, which provides basic compliance with the standard and offers
- both consumer and producer services. The wsrp services are bundled in the <emphasis>portal-wsrp.sar</emphasis>
- file which is nested in the <emphasis>jboss-portal.sar</emphasis> file.</para>
+ <title>Deploying JBoss Portal's WSRP services</title>
+ <para>JBoss Portal provides a base level support of the WSRP 1.0 standard and offers
+ both consumer and producer services. WSRP support is provided by the <emphasis>portal-wsrp.sar</emphasis>
+ service archive, included in the main <emphasis>jboss-portal.sar</emphasis> service archive.</para>
+ <para>If you've obtained the source distribution of JBoss Portal, you need to build and deploy the WSRP service
+ separately. Please follow the instructions on how to install
+ <ulink url="http://docs.jboss.com/jbportal/v2.4/reference-guide/en/html_single/#install_source">JBoss Portal
+ from the sources</ulink>. Once this is done, navigate to <emphasis>JBOSS_PORTAL_HOME_DIRECTORY/wsrp</emphasis>
+ and type:
+ <programlisting>build deploy</programlisting>
+ At the end of the build process, <emphasis>portal-wsrp.sar</emphasis> is copied to
+ <emphasis>JBOSS_HOME/server/default/deploy</emphasis>.
+
+ <note>
+ WSRP is built upon the JBoss WS web service stack. There is a known issue with the version 1.0.0.GA of JBoss
+ WS bundled with JBoss Application Server 4.0.4.GA, issue which prevents the complete deployment of JBoss
+ Portal's WSRP service if the user is not online or behind a firewall/proxy. This has been addressed in
+ version 1.0.2.GA of JBoss WS. Please follow the instructions on
+ <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=WSRP_UpdateJBossWS">how to upgrade JBoss WS</ulink>
+ as found on <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossPortal">JBoss Portal's wiki</ulink>.
+ </note>
+ </para>
</sect1>
+
<sect1>
<title>Making a portlet remotable</title>
- <para>Portlets are not published, by default, for remote consumption by JBoss Portal. In order to make a portlet
- remotely available (for example, via WSRP), a <emphasis>jboss-portlet.xml</emphasis> deployment descriptor
+ <para>JBoss Portal does not, by default, expose local portlets for consumption by remote WSRP consumers. In order
+ to make a portlet remotely available, a <emphasis>jboss-portlet.xml</emphasis> deployment descriptor
for that portlet must be added to the <emphasis>WEB-INF</emphasis> folder of the web application containing
the portlet and must be similar to the example below:</para>
<para>
@@ -39,11 +78,13 @@
</portlet>]]>
</programlisting>
</para>
+
<para>Here, the portlet named "BasicPortlet" is specified as being remotable. The "remotable" element is optional.</para>
<para>todo: explain how to set default remotable.</para>
</sect1>
+
<sect1>
- <title>Accessing JBoss Portal's WSRP Producer from a WSRP Consumer</title>
+ <title>Accessing JBoss Portal's WSRP Producer 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.
</para>
@@ -59,21 +100,46 @@
</itemizedlist>
</para>
</sect1>
+
<sect1>
- <title>Configuring access to a producer for JBoss Portal's WSRP Consumer</title>
+ <title>Consuming remote WSRP portlets in JBoss Portal</title>
+
+ <sect2>
+ <title>Overview</title>
+ <para>
+ To be able to consume WSRP portlets from a remote producer, JBoss Portal's WSRP consumer needs to know
+ how to access the remote producer. This is done via <emphasis>-wsrp.xml</emphasis> descriptors that
+ provide JBoss Portal's consumer information about which remote producers to access and with which
+ configuration. These files can be dropped in the deploy directory of the JBoss application server or nested
+ in .sar files for examples. It is possible to configure access to several different producers within
+ a single <emphasis>-wsrp.xml</emphasis> file or use one file per producer.
+ </para>
+ <para>
+ Once a remote producer has been configured in a <emphasis>-wsrp.xml</emphasis> file, it becomes available
+ in the list of portlet provider in the Management portlet on the Admin page of JBoss Portal. You can then
+ examine the list of portlets that are exposed by this producer and configure the portlets just like you
+ would for local portlets.
+ <note>
+ As of 2.4, the Portlet Management interface of WSRP is <emphasis role="bold">NOT</emphasis> supported.
+ It is therefore not possible to clone and configure portlets on the consumer side. This will be supported
+ in 2.6.
+ </note>
+ </para>
+ </sect2>
+
<sect2>
<title>Required configuration information</title>
- <para>Adding a producer is done using a specific descriptor that contains the information for
- the portal. Producer descriptor are containing in <emphasis>-wsrp.xml</emphasis> files.
- These files can be dropped in the deploy directory of the JBoss application server or nested in .sar files for examples.</para>
- <para>To establish a successful connection to a producer, JBoss Portal needs to know some information about the
- remote producer.</para>
+
+ <para>Let's look at which information needs to be provided to configure access to a remote producer.</para>
+
<para>First, we need to provide an identifier for the producer we are configuring so that we can refer to it
afterwards via the <emphasis role="bold"><producer-id></emphasis> element.</para>
+
<para>JBoss Portal also needs to learn about the remote producer's endpoints to be able to connect to the web services
and perform the WSRP invocations. Two options are currently provided to inform JBoss Portal of how to connect
to the remote web service, both by providing the required information via children elements:
</para>
+
<para>
<itemizedlist>
<listitem>We can provide the URLs for each of the different WSRP interfaces offered by the remote
@@ -97,9 +163,10 @@
</listitem>
</itemizedlist>
</para>
+
<para>Both <emphasis role="bold"><producer-id></emphasis> and either
- <emphasis role="bold"><endpoint-config></emphasis> or <emphasis
- role="bold"><endpoint-wsdl-url></emphasis>
+ <emphasis role="bold"><endpoint-config></emphasis> or
+ <emphasis role="bold"><endpoint-wsdl-url></emphasis>
are required elements for a functional remote producer configuration.</para></sect2>
<sect2>
@@ -122,7 +189,8 @@
<para>Registration configuration is done via the <emphasis role="bold"><registration-datat></emphasis>
element. We need to provide a consumer name (via the <emphasis role="bold"><consumer-name></emphasis>
element) for our consumer and then provide a list of values for the
- registration properties required by the remote producer via <emphasis role="bold"><property></emphasis>
+ registration properties required by the remote producer via <emphasis
+ role="bold"><property></emphasis>
elements. See the example below for more details.
</para>
</sect2>
@@ -181,17 +249,17 @@
]]>
</programlisting>
</para>
-
- <para>Note that a single <emphasis>-wsrp.xml</emphasis> file can contain several producer definitions.</para>
</sect2>
-
</sect1>
+
<sect1>
<title>Default consumer example</title>
- <para>JBoss Portal's producer exposes its information to the Portal itself as a default consumer with the
+ <para>
+ JBoss Portal's producer exposes its information to the Portal itself as a default consumer with the
identifier <emphasis>self</emphasis>. That means that all the remotable portlets
- are also exposed as remote portlets in the portal. The <emphasis>portal-wsrp.sar</emphasis> file contains the file
- <emphasis>default-wsrp.xml</emphasis> that contains this default producer. This file can be edited or removed if
- needed.</para>
+ are also exposed as remote portlets in the portal. The <emphasis>portal-wsrp.sar</emphasis> file contains the
+ file <emphasis>default-wsrp.xml</emphasis> that contains this default producer. This file can be edited or
+ removed if needed.
+ </para>
</sect1>
</chapter>
More information about the jboss-cvs-commits
mailing list