Author: smumford Date: 2011-11-10 21:09:34 -0500 (Thu, 10 Nov 2011) New Revision: 8039 Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/WSRP.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml Log: Porting GateIn r8038 Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml 2011-11-10 22:34:44 UTC (rev 8038) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml 2011-11-11 02:09:34 UTC (rev 8039) @@ -3,1319 +3,1523 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent"> %BOOK_ENTITIES; ]> -<chapter id="chap-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP"> - <title>Web Services for Remote Portlets (WSRP)</title> - <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Introduction"> - <title>Introduction</title> - <para> + <chapter id="chap-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP"> + <title>Web Services for Remote Portlets (WSRP)</title> + + <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Introduction"> + <title>Introduction</title> + + <para> The Web Services for Remote Portlets (WSRP) specification defines a web service interface for accessing and interacting with interactive presentation-oriented web services. - </para> - <para> + </para> + + <para> 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 the proposals made to the committee. - </para> - <para> + </para> + + <para> Scenarios that motivate WSRP functionality include: - </para> - <itemizedlist> - <listitem> - <para> - Content hosts, such as portal servers, providing Portlets as presentation-oriented web services that can be used by aggregation engines. - </para> - </listitem> - <listitem> - <para> - Aggregating frameworks, including portal servers, consuming presentation-oriented web services offered by content providers and integrating them into the framework. - </para> - </listitem> - </itemizedlist> - - <para> + </para> + + <itemizedlist> + <listitem> + <para> + Content hosts, such as portal servers, providing Portlets as presentation-oriented web services that can be used by aggregation engines. + </para> + </listitem> + + <listitem> + <para> + Aggregating frameworks, including portal servers, consuming presentation-oriented web services offered by content providers and integrating them into the framework. + </para> + </listitem> + </itemizedlist> + + <para> More information on WSRP can be found on the official <ulink url="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wsrp...;. We suggest reading the <ulink url="http://www.oasis-open.org/committees/download.php/10539/wsrp-pr... for a good, albeit technical, overview of WSRP. - </para> - </section> - - - <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Level_of_Support"> - <title>Level of Support</title> - <para> + </para> + </section> + + <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Level_of_Support"> + <title>Level of Support</title> + + <para> The WSRP Technical Committee defined <ulink url="http://www.oasis-open.org/committees/download.php/3073">... Use Profiles</ulink> to help with WSRP interoperability. Terms defined in that document will be used in this section. - </para> - <para> + </para> + + <para> JBoss Enterprise Portal Platform provides a <emphasis>Simple</emphasis> level of support for the WSRP Producer, with the exception of out-of-band registration. In-band registration and persistent local state (which are defined at the <emphasis>Complex</emphasis> level) are supported. - </para> - <para> + </para> + + <para> JBoss Enterprise Portal Platform provides a <emphasis>Medium</emphasis> level of support for the Consumer, excepting HTML markup (as JBoss Enterprise Portal Platform itself does not handle other markup types). Explicit portlet cloning and the <literal>PortletManagement</literal> interface are supported. - </para> - <para> + </para> + + <para> The WSRP component has Level 1 Producer and Consumer caching. Cookie handling is supported properly on the Consumer. The Producer requires cookie initialization (as this improves interoperability with some consumers). - </para> - <para> + </para> + + <para> JBoss Enterprise Portal Platform does not support custom window states or modes, therefore neither does the WSRP component. It does, however, support CSS on both the Producer (although this is more a function of the portlets than an inherent Producer capability) and Consumer. - </para> - <para> + </para> + + <para> JBoss Enterprise Portal Platform &VY; includes implementations of WSRP 1.0 and 2.0. - </para> - <para> - All optional features in WSRP 2 are implemented in JBoss Enterprise Portal Platform &VY; except support for lifetimes and leasing support. - </para> - </section> - - - <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Deploying_WSRP"> - <title>Deploying WSRP</title> - <note> + </para> + + <para> + All optional features in WSRP 2 are implemented in JBoss Enterprise Portal Platform &VY; except support for lifetimes and leasing support. + </para> + + <note> + <para> + As of version &VZ; of Enterprise Portal Platform, WSRP is only activated and supported when deployed on JBoss Enterprise Application Server. + </para> + </note> + </section> + + <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Deploying_WSRP"> + <title>Deploying WSRP</title> + + <note> <title>Notational Devices</title> + <para> - The following list of support files uses the following notational devices: + The following list of support files uses the following notational devices: </para> - <variablelist> - <title>Notations:</title> - <varlistentry> - <term><replaceable>JBOSS_HOME</replaceable></term> + + <variablelist id="vari-Reference_Guide-Deploying_WSRP-Notations"> + <title>Notations:</title> + + <varlistentry> + <term><replaceable>JBOSS_HOME</replaceable></term> + <listitem> <para> <replaceable>JBOSS_HOME</replaceable> refers to the directory that your instance of JBoss Enterprise Portal Platform has been extracted/installed to. For example: <filename>/home/<replaceable>USERNAME</replaceable>/jboss-epp-<replaceable>&lt;VERSION&gt;</replaceable>/</filename> </para> </listitem> - </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable></term> + </varlistentry> + + <varlistentry> + <term><replaceable>WSRP_PATH</replaceable></term> + <listitem> <para> The WSRP files referred to in this section are found in the <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear</filename> directory. </para> + <para> For ease of reference this path will be represented by: <replaceable>WSRP_PATH</replaceable>. </para> </listitem> - </varlistentry> - <varlistentry> - <term><replaceable>WSRP_VERSION</replaceable></term> + </varlistentry> + + <varlistentry> + <term><replaceable>WSRP_VERSION</replaceable></term> + <listitem> <para> <replaceable>WSRP_VERSION</replaceable> represents the version of the WSRP component in use. </para> </listitem> - </varlistentry> - <varlistentry> - <term><replaceable>PORTAL_VERSION</replaceable></term> + </varlistentry> + + <varlistentry> + <term><replaceable>PORTAL_VERSION</replaceable></term> + <listitem> <para> <replaceable>PORTAL_VERSION</replaceable> represents the version of JBoss Enterprise Portal Platform in use. </para> </listitem> - </varlistentry> - </variablelist> - </note> - - <variablelist id="vari-Reference_Guide-Deploying_WSRP-WSRP_support_files"> + </varlistentry> + </variablelist> + </note> + + <para> + Starting with version 2.1.0-GA of the component, WSRP is packaged as a JBoss Enterprise Portal Platform extension and is now self-contained in an easy to install package named <filename>gatein-wsrp-integration.ear</filename>, deployed directly in the <filename>deploy</filename> directory of your JBoss Application Server configuration directory. + </para> + + <para> + The extension itself is composed of the following components: + </para> + + <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Deploying_WSRP-WSRP_support_files"> <title>WSRP support files</title> + <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/wsrp-admin-gui.war</term> - <listitem> - <para> - This file contains the WSRP Configuration portlet with which you can configure consumers to access remote servers and how the WSRP producer is configured. - </para> - </listitem> + <term><filename>META-INF/</filename></term> + + <listitem> + <para> + This directory contains files necessary for EAR packaging. The only file that is of interest from a user perspective is <filename>gatein-wsse-consumer.xml</filename> which allows you to configure WS-Security support for the consumer. !!!TODO mwringe please detail !!!! + </para> + </listitem> </varlistentry> + <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/wsrp-producer.war</term> - <listitem> - <para> - This file contains the WSRP producer web application. - </para> - </listitem> + <term><filename>extension-component-$PORTAL_VERSION.jar</filename></term> + + <listitem> + <para> + This archive which contains the components needed to integrate the WSRP component into JBoss Enterprise Portal Platform. It also includes the default configuration files for the WSRP producer and the default WSRP consumers. + </para> + </listitem> </varlistentry> + <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-common-<replaceable>WSRP_VERSION</replaceable>.jar</term> - <listitem> - <para> - This file contains common classes needed by the different WSRP libraries. - </para> - </listitem> + <term><filename>extension-config-$PORTAL_VERSION.jar</filename></term> + + <listitem> + <para> + This file contains the configuration file needed by the GateIn extension mechanism to properly register this EAR as an extension. + </para> + </listitem> </varlistentry> + <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-consumer-<replaceable>WSRP_VERSION</replaceable>.jar</term> - <listitem> - <para> - This file contains the WSRP consumer. - </para> - </listitem> + <term><filename>extension-war-$PORTAL_VERSION.war</filename></term> + + <listitem> + <para> + This file contains the configuration files needed by the GateIn extension mechanism to properly setup the WSRP service. It includes <filename>wsrp-configuration.xml</filename> which, in particular, configures several options for the <code> WSRPServiceIntegration </code> component at the heart of the WSRP integration in JBoss Enterprise Portal Platform. + </para> + </listitem> </varlistentry> + <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar</term> - <listitem> - <para> - This file contains the API classes needed to integrate the WSRP component into portals. - </para> - </listitem> + <term><filename>lib/</filename></term> + + <listitem> + <para> + This directory contains the different libraries needed by the WSRP service. + </para> + </listitem> </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-producer-lib-$WSRP_VERSION.jar</term> + + <varlistentry> + <term><filename>wsrp-admin-gui-$WSRP_VERSION.war</filename></term> + <listitem> - <para> - This file contains the classes needed by the WSRP producer. - </para> - </listitem> - </varlistentry> + <para> + This file contains the WSRP Configuration portlet with which you can configure consumers to access remote servers and how the WSRP producer is configured. + </para> + </listitem> + </varlistentry> + <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-wsrp1-ws-<replaceable>WSRP_VERSION</replaceable>.jar</term> - <listitem> - <para> - This file contains the generated JAX-WS classes for WSRP version 1. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-wsrp2-ws-<replaceable>WSRP_VERSION</replaceable>.jar</term> + <term><filename>wsrp-producer-jb5wsss-$WSRP_VERSION.war</filename></term> + <listitem> <para> - This file contains the JAX-WS classes for WSRP version 2. + This file contains the producer-side support for WS-Security. !!!!TODO mwringe: please detail if there are any user-modifiable configuration file there and how this files is different in AS 6 !!!! </para> </listitem> - </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/gatein.portal.component.wsrp-<replaceable>PORTAL_VERSION</replaceable>.jar</term> - <listitem> - <para> - This file contains the code to integrate the WSRP service into JBoss Enterprise Portal Platform. - </para> - </listitem> </varlistentry> - </variablelist> - - <section id="sect-Reference_Guide-Deploying_WSRP-Non_default_Ports_or_Hostnames"> + </variablelist> + + <section id="sect-Reference_Guide-Deploying_WSRP-Non_default_Ports_or_Hostnames"> <title>Non-default Ports or Hostnames</title> + <para> - JBoss WS (the web service stack that JBoss Enterprise Portal Platform uses) should update the port and host name used in WSDL. Refer to the JBoss WS <ulink url="http://community.jboss.org/wiki/JBossWS-UserGuide#Configuration... guide</ulink> for more information. + JBoss WS (the web service stack that JBoss Enterprise Portal Platform uses) should update the port and host name used in WSDL. Refer to the JBoss WS <ulink url="http://community.jboss.org/wiki/JBossWS-UserGuide#Configuration... guide</ulink> for more information. </para> + <para> - If the host name and port on which the server runs have been modified, the configuration for the Consumer used to consume JBoss Enterprise Portal Platform's "self" Producer will need to be updated. Refer to <xref linkend="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets" /> for directions on how to do this. + If the host name and port on which the server runs have been modified, the configuration for the Consumer used to consume JBoss Enterprise Portal Platform's "self" Producer will need to be updated. Refer to <xref linkend="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets" /> for directions on how to do this. </para> - </section> - - - <section id="sect-Reference_Guide-Deploying_WSRP-Using_WSRP_with_SSL"> + </section> + + <section id="sect-Reference_Guide-Deploying_WSRP-Using_WSRP_with_SSL"> <title>Using WSRP with SSL</title> + <para> - It is possible to use WSRP over SSL for secure exchange of data. Refer to these <ulink url="http://community.jboss.org/wiki/ConfiguringWSRPforuseoverSSL&qu... for how to do this. + It is possible to use WSRP over SSL for secure exchange of data. Refer to these <ulink url="http://community.jboss.org/wiki/ConfiguringWSRPforuseoverSSL&qu... for how to do this. </para> - </section> - </section> - - - <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Making_a_Portlet_Remotable"> - <title>Making a Portlet Remotable</title> - <note> + </section> + </section> + + <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Making_a_Portlet_Remotable"> + <title>Making a Portlet Remotable</title> + + <note> <para> - Only JSR-286 (Portlet 2.0) portlets can be made remotable as the mechanism to expose a portlet to WSRP relies on a JSR-286-only functionality. + Only JSR-286 (Portlet 2.0) portlets can be made remotable as the mechanism to expose a portlet to WSRP relies on a JSR-286-only functionality. </para> - </note> - <para> + </note> + + <para> JBoss Enterprise Portal Platform does <emphasis role="bold">not</emphasis>, by default, expose local portlets for consumption by remote WSRP consumers. - </para> - <para> + </para> + + <para> In order to make a portlet remotely available, it must be made "remotable" by marking it as such in the associated <filename>portlet.xml</filename>. - </para> - <para> + </para> + + <para> A specific <code>org.gatein.pc.remotable container-runtime-option</code> is used to accomplish this. Setting its value to <code>true</code> makes the portlet available for remote consumption, while setting its value to <code>false</code> will not publish it remotely. - </para> - <para> + </para> + + <para> As specifying the remotable status for a portlet is optional, nothing need be done if portlets do not need to be remotely available. - </para> - <para> + </para> + + <para> In the following example, the "BasicPortlet" portlet is specified as being remotable. - </para> - + </para> <programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default255.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> + <para> It is also possible to specify that all the portlets declared within a given portlet application be remotable by default. - </para> - <para> + </para> + + <para> This is done by specifying the <code>container-runtime-option</code> at the <code>portlet-app</code> element level. Individual portlets can override that value to not be remotely exposed. - </para> - <para> + </para> + + <para> For example: - </para> - + </para> <programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default256.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> + <para> This example defines two portlets. As the <code>org.gatein.pc.remotable container-runtime-option</code> is set to <code>true</code> at the <code>portlet-app</code> level, all portlets defined in this particular portlet application are exposed remotely by JBoss Enterprise Portal Platform's WSRP Producer. - </para> - <para> + </para> + + <para> It is possible to override this default behavior. Specifying a value for the <code>org.gatein.pc.remotable container-runtime-option</code> at the <code>portlet</code> level will take precedence over the default. - </para> - <para> - In the example above, the <varname>RemotelyExposedPortlet</varname> inherits the remotable status defined at the <code>portlet-app</code> level since it does not specify a value for the <code>org.gatein.pc.remotable container-runtime-option</code>. - </para> - <para> - The <varname>NotRemotelyExposedPortlet</varname>, however, overrides the default behavior and is not remotely exposed. - </para> - <note> + </para> + + <para> + In the example above, the + <varname> + RemotelyExposedPortlet + </varname> + inherits the remotable status defined at the <code>portlet-app</code> level since it does not specify a value for the <code>org.gatein.pc.remotable container-runtime-option</code>. + </para> + + <para> + The + <varname> + NotRemotelyExposedPortlet + </varname> + , however, overrides the default behavior and is not remotely exposed. + </para> + + <note> <para> - Portlets are not remotely exposed if no top-level <code>org.gatein.pc.remotable container-runtime-option</code> value is set to <code>true</code>. + Portlets are not remotely exposed if no top-level <code>org.gatein.pc.remotable container-runtime-option</code> value is set to <code>true</code>. </para> - </note> - </section> - - - <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_WSRP_portlets_from_a_remote_Consumer"> - <title>Consuming WSRP portlets from a remote Consumer</title> - <para> + </note> + </section> + + <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_WSRP_portlets_from_a_remote_Consumer"> + <title>Consuming WSRP portlets from a remote Consumer</title> + + <para> Configuration is extremely variable between different WSRP Consumers. Most, however, require a specification of the URL for the Producer's WSDL definition. If the JBoss Enterprise Portal Platform Consumer is not being used, refer to the documentation for the Consumer that is in use for specific instructions. - </para> - <para> + </para> + + <para> For instructions on how to specify this URL in JBoss Enterprise Portal Platform, refer to <xref linkend="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets" />. - </para> - <para> + </para> + + <para> JBoss Enterprise Portal Platform's Producer is automatically set up when a portal instance is deployed with the WSRP service. - </para> - <para> - The WSDL file can be accessed at: - </para> - <variablelist> - <title>File paths:</title> - <varlistentry> - <term>WSRP 1.0:</term> + </para> + + <para> + The WSDL file can be accessed at: + </para> + + <variablelist> + <title>File paths:</title> + + <varlistentry> + <term>WSRP 1.0:</term> + <listitem> <para> <filename>http://<replaceable>{hostname}</replaceable>:<replaceable>{port}</replaceable>/wsrp-producer/v1/MarkupService?wsdl</filename>. </para> </listitem> - </varlistentry> - <varlistentry> - <term>WSRP 2.0:</term> + </varlistentry> + + <varlistentry> + <term>WSRP 2.0:</term> + <listitem> <para> <filename>http://<replaceable>{hostname}</replaceable>:<replaceable>{port}</replaceable>/wsrp-producer/v2/MarkupService?wsdl</filename>. </para> </listitem> - </varlistentry> - </variablelist> - <para> - The default hostname is <literal>localhost</literal> and the default port is <literal>8080</literal>. - </para> - </section> - - - <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets"> - <title>Consuming Remote WSRP Portlets</title> - <section id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Overview"> + </varlistentry> + </variablelist> + + <para> + The default hostname is <literal>localhost</literal> and the default port is <literal>8080</literal>. + </para> + </section> + + <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets"> + <title>Consuming Remote WSRP Portlets</title> + + <section id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Overview"> <title>Overview</title> + <para> - To be able to consume WSRP portlets exposed by a remote producer, JBoss Enterprise Portal Platform's WSRP consumer must be configured to access that remote producer. + To be able to consume WSRP portlets exposed by a remote producer, JBoss Enterprise Portal Platform's WSRP consumer must be configured to access that remote producer. </para> + <para> - Access to a remote producer can be configured using WSRP Producer descriptors. Alternatively, a portlet is provided to configure remote producers. + Access to a remote producer can be configured using WSRP Producer descriptors. Alternatively, a portlet is provided to configure remote producers. </para> + <para> - Once a remote producer has been configured, the portlets that it exposes are then available in the Application Registry to be added to categories and then to pages. + Once a remote producer has been configured, the portlets that it exposes are then available in the Application Registry to be added to categories and then to pages. </para> <!-- Removed as out of date and not in Community version of doc. <para> A default consumer named <literal>self</literal>, that consumes the portlets exposed by JBoss Enterprise Portal Platform's producer, has been configured as a way to test the WSRP producer service and to check that portlets are correctly published via WSRP. </para> --> - </section> - - - <section id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Configuring_a_Remote_Producer"> + </section> + + <section id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Configuring_a_Remote_Producer"> <title>Configuring a Remote Producer</title> + <para> - Access to a remote producer needs to be defined so that portlets can be consumed within JBoss Enterprise Portal Platform. This section will show how to configure access to <emphasis role="bold">Oracle</emphasis>'s public WSRP producer. Firstly using the configuration portlet. Then how the same result can be accomplished with a producer descriptor, though it is far easier to do so via the configuration portlet. + Access to a remote producer needs to be defined so that portlets can be consumed within JBoss Enterprise Portal Platform. This section will show how to configure access to <emphasis role="bold">Oracle</emphasis>'s public WSRP producer. Firstly using the configuration portlet. Then how the same result can be accomplished with a producer descriptor, though it is far easier to do so via the configuration portlet. </para> + <important> - <title>Chunked Encoding</title> - <para> - Some WSRP producers, such as Oracle, do not support chunked encoding. If your producer does not support chunked encoding, it will not be able to properly connect to the producer. - </para> - <para> - This will manifest itself with the following error: - </para> + <title>Chunked Encoding</title> + + <para> + Some WSRP producers, such as Oracle, do not support chunked encoding. If your producer does not support chunked encoding, it will not be able to properly connect to the producer. + </para> + + <para> + This will manifest itself with the following error: + </para> <screen>Caused by: org.jboss.ws.WSException: Invalid HTTP server response [503] - Service Unavailable. </screen> - <para> - A workaround for this issue involves editing the <parameter>chunksize</parameter> setting in the <filename>standard-jaxws-client-config.xml</filename> file. - </para> - <para> - Refer to <ulink type="http" url="http://community.jboss.org/wiki/Workaroundwhenchunkedencodingis... for more information. - </para> + <para> + A workaround for this issue involves editing the <parameter>chunksize</parameter> setting in the <filename>standard-jaxws-client-config.xml</filename> file. + </para> + + <para> + Refer to <ulink type="http" url="http://community.jboss.org/wiki/Workaroundwhenchunkedencodingis... for more information. + </para> </important> + <section id="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet"> - <title>The Configuration Portlet</title> - <para> - JBoss Enterprise Portal Platform provides a graphical portlet to assist with configuring access to, and other facets of, remote WSRP Producers. - </para> - <para> - It is available at: <ulink type="http" url="http://localhost:8080/portal/login?initialURI=%2Fportal%2Fprivate%2Fclassic%2FwsrpConfiguration&amp;username=root&amp;password=gtn"></ulink>. - </para> - <para> - The portlet also is a group page for /platform/administrators - </para> - <para> - Although the Configuration Portlet is installed by default in JBoss Enterprise Portal Platform &VY;., installation instructions are included below should the portlet ever need to be re-installed: - </para> - <procedure> - <title><emphasis role="bold">Installing the configuration portlet:</emphasis></title> - <step> - <para> - 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> - <para> - Add the WSRP Configuration portlet to the Administration category. If the Import Applications functionality is used, the WSRP Configuration portlet will be automatically added to the Administration category. - </para> - </step> - <step> - <para> - Once the portlet is added to a category, it can be added to a page and used. It is recommended that it be added to the same page as the Application Registry (as other operations relating to WSRP and adding portlets to categories are somewhat related). Add the WSRP Configuration portlet to the page using the standard procedure. + <title>The Configuration Portlet</title> + + <para> + JBoss Enterprise Portal Platform provides a graphical portlet to assist with configuring access to, and other facets of, remote WSRP Producers. </para> - </step> - </procedure> - - <section id="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet-Using_the_Configuration_Portlet"> - <title><emphasis role="bold">Using the Configuration portlet</emphasis></title> + + <para> + It is available at: <ulink type="http" url="http://localhost:8080/portal/login?initialURI=%2Fportal%2Fprivate%2Fclassic%2FwsrpConfiguration&amp;username=root&amp;password=gtn"></ulink>. + </para> + + <para> + The portlet also is a group page for /platform/administrators + </para> + + <para> + Although the Configuration Portlet is installed by default in JBoss Enterprise Portal Platform &VY;., installation instructions are included below should the portlet ever need to be re-installed: + </para> + + <procedure> + <title><emphasis role="bold">Installing the configuration portlet:</emphasis></title> + + <step><para> + 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><para> + Add the WSRP Configuration portlet to the Administration category. If the Import Applications functionality is used, the WSRP Configuration portlet will be automatically added to the Administration category. + </para></step> + + <step><para> + Once the portlet is added to a category, it can be added to a page and used. It is recommended that it be added to the same page as the Application Registry (as other operations relating to WSRP and adding portlets to categories are somewhat related). Add the WSRP Configuration portlet to the page using the standard procedure. + </para></step> + </procedure> + + <section id="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet-Using_the_Configuration_Portlet"> + <title><emphasis role="bold">Using the Configuration portlet</emphasis></title> + <mediaobject> <imageobject role="html"> <imagedata align="center" fileref="images/WSRP/config_init.png" format="PNG" scale="120" /> </imageobject> + <imageobject role="fo"> <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_init.png" format="PNG" /> </imageobject> </mediaobject> + <para> This screen presents all the configured consumers associated with their status and possible actions on them. </para> + <para> A Consumer can be active or inactive. Activating a Consumer means that it is ready to act as a portlet provider. </para> + <para> Note also that a Consumer can be marked as requiring <emphasis>refresh</emphasis>, which means that the information held about it might not be up to date. Refreshing it from the remote Producer will update this information. </para> + <para> This can happen for several reasons: the service description for that remote Producer has not been fetched yet, the cached version has expired or modifications have been made to the configuration that could potentially invalidate it, thus requiring re-validation of the information. </para> + <para> To create a new Consumer: </para> + <procedure> <title><emphasis role="bold">Creating a Consumer</emphasis></title> - <step> - <para> + + <step><para> Type "<literal> oracle</literal>" into the "<emphasis role="bold">Create a consumer named:</emphasis>" field. - </para> - </step> - <step> - <para> + </para></step> + + <step><para> Click on "<emphasis role="bold">Create consumer</emphasis>" to create a new Consumer called <literal>oracle</literal>. - </para> - <mediaobject> + </para> <mediaobject> <imageobject role="html"> <imagedata align="center" fileref="images/WSRP/config_create.png" format="PNG" scale="100" /> </imageobject> + <imageobject role="fo"> <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_create.png" format="PNG" /> </imageobject> - </mediaobject> - </step> - <step> - <para> + </mediaobject></step> + + <step><para> In the next form, set the cache expiration value to <parameter>300</parameter> seconds. - </para> - </step> - <step> - <para> + </para></step> + + <step><para> Leave the default timeout value for web services (WS) operations. - </para> - </step> - <step> - <para> + </para></step> + + <step><para> Enter the WSDL URL for the producer in the text field. - </para> - </step> - <step> - <para> + </para></step> + + <step><para> Press the "Refresh &amp; Save" button: - </para> - <mediaobject> + </para> <mediaobject> <imageobject role="html"> <imagedata align="center" fileref="images/WSRP/config_wsdl.png" format="PNG" scale="120" /> </imageobject> + <imageobject role="fo"> <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_wsdl.png" format="PNG" /> </imageobject> - </mediaobject> - </step> + </mediaobject></step> </procedure> - + <para> This will retrieve the service description associated with the Producer which WSRP interface is described by the WSDL file found at the URL entered. </para> + <para> In this case, querying the service description will show that the Producer requires registration but did not request any registration property: </para> + <mediaobject> <imageobject role="html"> <imagedata align="center" fileref="images/WSRP/config_refresh.png" format="PNG" scale="120" /> </imageobject> + <imageobject role="fo"> <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_refresh.png" format="PNG" /> </imageobject> </mediaobject> + <para> The Consumer for the <literal>oracle</literal> Producer should now be available as a portlet provider and be ready to be used. </para> + <para> Assuming that the producer required a value for an <literal>email</literal> registration property, JBoss Enterprise Portal Platform's WSRP consumer will report that some information was missing: </para> + <mediaobject> <imageobject role="html"> <imagedata align="center" fileref="images/WSRP/config_missing.png" format="PNG" scale="120" /> </imageobject> + <imageobject role="fo"> <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_missing.png" format="PNG" /> </imageobject> </mediaobject> + <note> <title>Values</title> + <para> As at this release there is no automated way to learn about which possible values (if any) are expected by the remote Producer. Possible values may be indicated in the registration property description but this is not always the case. Refer to the specific Producer's documentation. </para> </note> + <para> Enter an address for the registration property (&quot;&lt;literal&gt;example(a)example.com&lt;/literal&gt;&quot;) and press "<emphasis role="bold">Save &amp; Refresh</emphasis>" once more: </para> + <mediaobject> <imageobject role="html"> <imagedata align="center" fileref="images/WSRP/config_end.png" format="PNG" scale="120" /> </imageobject> + <imageobject role="fo"> <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_end.png" format="PNG" /> </imageobject> </mediaobject> + </section> </section> - </section> - - + <section id="sect-Reference_Guide-Configuring_a_Remote_Producer-Using_XML"> - <title>Using XML</title> - <para> - Although using the WSRP Configuration portlet to configure Consumers is recommended, the WSRP component provides an alternative way to configure consumers. - </para> - <para> - This is done by editing the XML file located at <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-consumer-<replaceable>WSRP_VERSION</replaceable>.jar/conf/wsrp-consumers-config.xml</filename>. - </para> + <title>Using XML</title> + <para> + Although using the WSRP Configuration portlet to configure Consumers is recommended, the WSRP component provides an alternative way to configure consumers. + </para> + + <para> + This is done by editing the XML file located at <filename>extension-component-<replaceable>&lt;PORTAL_VERSION&gt;</replaceable>.jar/conf/wsrp-consumers-config.xml</filename> in your JBoss AS deploy directory. + </para> <programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default257.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - The file as shown above specifies access to two producers: <literal>self</literal>, which consumes JBoss Enterprise Portal Platform's own WSRP producer (albeit in a version that assumes that the producer requires a value for an <literal>email</literal> registration property), and <literal>oracle</literal>, which consumes Oracle's public producer, both in configurations as shown in the procedure above. - </para> - <note> - <para> - An XML Schema defining which elements are available to configure Consumers via XML can be found in <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_consumer_1_0.xsd </filename> - </para> - </note> + <para> + The file as shown above specifies access to two producers: <literal>self</literal>, which consumes JBoss Enterprise Portal Platform's own WSRP producer (albeit in a version that assumes that the producer requires a value for an <literal>email</literal> registration property), and <literal>oracle</literal>, which consumes Oracle's public producer, both in configurations as shown in the procedure above. + </para> + + <note> + <para> + An XML Schema defining which elements are available to configure Consumers via XML can be found in <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_consumer_1_0.xsd </filename> + </para> + </note> </section> - + <section id="sect-Reference_Guide-Configuring_a_Remote_Producer-Adding_remote_portlets_to_categories"> - <title>Adding remote portlets to categories</title> - <para> - Clicking on the Portlet link in the Application Registry will now show the remote portlets in the <emphasis role="bold">REMOTE</emphasis> tab in the left column: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/remote_portlets.png" format="PNG" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/remote_portlets.png" format="PNG" /> - </imageobject> - </mediaobject> - <para> - These portlets are available to be used as regular portlets: they can be used in categories and added to pages. Using the Import Applications functionality will also automatically import them into categories based on the keywords they define. - </para> - <para> - More specifically, to add a <emphasis>WSRP</emphasis> portlet to a category, select <literal>wsrp</literal> in the Application Type drop-down menu: - </para> - <mediaobject> - <imageobject> - <imagedata align="center" fileref="images/WSRP/remote_portlets_category.png" format="PNG" scalefit="1" valign="middle" /> - </imageobject> - </mediaobject> + <title>Adding remote portlets to categories</title> + + <para> + Clicking on the Portlet link in the Application Registry will now show the remote portlets in the <emphasis role="bold">REMOTE</emphasis> tab in the left column: + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/remote_portlets.png" format="PNG" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/remote_portlets.png" format="PNG" /> + </imageobject> + </mediaobject> + + <para> + These portlets are available to be used as regular portlets: they can be used in categories and added to pages. Using the Import Applications functionality will also automatically import them into categories based on the keywords they define. + </para> + + <para> + More specifically, to add a <emphasis>WSRP</emphasis> portlet to a category, select <literal>wsrp</literal> in the Application Type drop-down menu: + </para> + + <mediaobject> + <imageobject> + <imagedata align="center" fileref="images/WSRP/remote_portlets_category.png" format="PNG" scalefit="1" valign="middle" /> + </imageobject> + </mediaobject> </section> - - </section> - - <section id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Configuring_Access_to_Remote_Producers_via_XML"> + </section> + + <section id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Configuring_Access_to_Remote_Producers_via_XML"> <title>Configuring Access to Remote Producers via XML</title> + <para> - Again, configuring consumers via XML is done by editing <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-consumer-<replaceable>WSRP_VERSION</replaceable>.jar/conf/wsrp-consumers-config.xml</filename>. + Again, configuring consumers via XML is done by editing <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-consumer-<replaceable>WSRP_VERSION</replaceable>.jar/conf/wsrp-consumers-config.xml</filename>. </para> + <note> - <title>XML Elements</title> - <para> - An XML Schema defining which elements are available to configure Consumers via XML can be found in <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_consumer_1_0.xsd </filename> - </para> + <title>XML Elements</title> + + <para> + An XML Schema defining which elements are available to configure Consumers via XML can be found in <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_consumer_1_0.xsd </filename> + </para> </note> + <note> - <title>The Consumer Configuration file</title> - <para> - It is important to understand how the XML Consumers configuration file is processed. It is read the first time the WSRP service starts and the associated information is then put under control of the JCR (Java Content Repository). - </para> - <para> - Subsequent launches of the WSRP service will use the JCR-stored information for all producers that are already known to JBoss Enterprise Portal Platform. More specifically, the <filename>wsrp-consumers-config.xml</filename> file is scanned for producer identifiers. Any identifier that is already known will be bypassed and the JCR information associated with this remote producer will be used. - </para> - <para> - The information defined at the XML level is only processed for producer definition for which no information is already present in the JCR. - </para> - <para> - Therefore, to delete a Producer configuration, the associated information in the database must be deleted (this can be accomplished using the configuration portlet as shown in <xref linkend="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet" />). - </para> - <para> - The associated information in <filename>wsrp-consumers-config.xml</filename> (if such information exists) must also be removed, otherwise the producer will be re-created the next time the WSRP is launched. - </para> + <title>The Consumer Configuration file</title> + + <para> + It is important to understand how the XML Consumers configuration file is processed. It is read the first time the WSRP service starts and the associated information is then put under control of the JCR (Java Content Repository). + </para> + + <para> + Subsequent launches of the WSRP service will use the JCR-stored information for all producers that are already known to JBoss Enterprise Portal Platform. More specifically, the <filename>wsrp-consumers-config.xml</filename> file is scanned for producer identifiers. Any identifier that is already known will be bypassed and the JCR information associated with this remote producer will be used. + </para> + + <para> + The information defined at the XML level is only processed for producer definition for which no information is already present in the JCR. + </para> + + <para> + Therefore, to delete a Producer configuration, the associated information in the database must be deleted (this can be accomplished using the configuration portlet as shown in <xref linkend="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet" />). + </para> + + <para> + The associated information in <filename>wsrp-consumers-config.xml</filename> (if such information exists) must also be removed, otherwise the producer will be re-created the next time the WSRP is launched. + </para> </note> + <section id="sect-Reference_Guide-Configuring_Access_to_Remote_Producers_via_XML-Required_Configuration_Information"> - <title>Required Configuration Information</title> - <para> - The following information needs to be provided to configure access to a remote Producer: - </para> - <orderedlist> - <listitem> + <title>Required Configuration Information</title> + + <para> + The following information needs to be provided to configure access to a remote Producer: + </para> + + <orderedlist> + <listitem> + <para> + An identifier must be provided for the producer being configured so that it can be referred to later. This is done in the mandatory <literal>id</literal> attribute of the <literal>&#60;wsrp-producer&#62;</literal> element. + </para> + </listitem> + + <listitem> + <para> + JBoss Enterprise Portal Platform also needs to know about the remote Producer's endpoints to be able to connect to the remote web services and perform WSRP invocations. Use the <literal>&#60;endpoint-wsdl-url&#62;</literal> element to specify the URL for the WSDL description of the remote WSRP service. + </para> + </listitem> + </orderedlist> + + <para> + Both the <literal>id</literal> attribute and <literal>&#60;endpoint-wsdl-url&#62;</literal> elements are required for a functional remote producer configuration. + </para> + </section> + + <section id="sect-Reference_Guide-Configuring_Access_to_Remote_Producers_via_XML-Optional_Configuration"> + <title>Optional Configuration</title> + + <para> + It is also possible to provide additional configuration, which, in some cases, might be important to establish a proper connection to the remote producer. + </para> + + <variablelist id="vari-Reference_Guide-Optional_Configuration-Optional_Configurations"> + <title>Optional Configurations</title> + + <varlistentry> + <term>Caching</term> + + <listitem> <para> - An identifier must be provided for the producer being configured so that it can be referred to later. This is done in the mandatory <literal>id</literal> attribute of the <literal>&#60;wsrp-producer&#62;</literal> element. + To prevent unnecessary traffic between the local consumer and the remote producer, it is possible to cache some of the information sent by the producer (such as the list of offered portlets) for a given duration. </para> - </listitem> - <listitem> + <para> - JBoss Enterprise Portal Platform also needs to know about the remote Producer's endpoints to be able to connect to the remote web services and perform WSRP invocations. Use the <literal>&#60;endpoint-wsdl-url&#62;</literal> element to specify the URL for the WSDL description of the remote WSRP service. + The rate at which the information is refreshed is defined by the <literal>expiration-cache</literal> attribute of the <literal>&#60;wsrp-producer&#62;</literal> element (in seconds). </para> - </listitem> - </orderedlist> - <para> - Both the <literal>id</literal> attribute and <literal>&#60;endpoint-wsdl-url&#62;</literal> elements are required for a functional remote producer configuration. - </para> - </section> - - - <section id="sect-Reference_Guide-Configuring_Access_to_Remote_Producers_via_XML-Optional_Configuration"> - <title>Optional Configuration</title> - <para> - It is also possible to provide additional configuration, which, in some cases, might be important to establish a proper connection to the remote producer. - </para> - <variablelist id="vari-Reference_Guide-Optional_Configuration-Optional_Configurations"> - <title>Optional Configurations</title> - <varlistentry> - <term>Caching</term> - <listitem> - <para> - To prevent unnecessary traffic between the local consumer and the remote producer, it is possible to cache some of the information sent by the producer (such as the list of offered portlets) for a given duration. - </para> - <para> - The rate at which the information is refreshed is defined by the <literal>expiration-cache</literal> attribute of the <literal>&#60;wsrp-producer&#62;</literal> element (in seconds). - </para> - <para> - For example; providing a value of <literal>120</literal> for expiration-cache means that the producer information will not be refreshed for 2 minutes after it has been accessed. If no value is provided, JBoss Enterprise Portal Platform will always access the remote producer regardless of whether the remote information has changed or not. - </para> - <para> - Since, in most instances, the information provided by the producer does not change often, use of this caching facility to minimize bandwidth usage is recommended. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>WS Timeout</term> + + <para> + For example; providing a value of <literal>120</literal> for expiration-cache means that the producer information will not be refreshed for 2 minutes after it has been accessed. If no value is provided, JBoss Enterprise Portal Platform will always access the remote producer regardless of whether the remote information has changed or not. + </para> + + <para> + Since, in most instances, the information provided by the producer does not change often, use of this caching facility to minimize bandwidth usage is recommended. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>WS Timeout</term> + <listitem> <para> It is also possible to define a timeout after which WS operations are considered as failed. This is helpful to avoid blocking the WSRP service, as it waits on a service that does not answer. </para> + <para> Use the <literal>ws-timeout</literal> attribute of the <literal>&#60;wsrp-producer&#62;</literal> element to specify how many milliseconds the WSRP service will wait for a response from the remote producer before timing out. </para> </listitem> - </varlistentry> - <varlistentry> - <term>Pre-registration information</term> - <listitem> - <para> - Some producers require consumers to register with them before authorizing them to access their offered portlets. If known, some registration information can be provided in the producer configuration beforehand, so that the consumer can register with the remote producer when required. - </para> - <note> - <para> - Only simple String properties are supported. It is not possible to configure complex registration data. However, this should be sufficient for most cases. - </para> - </note> - <para> - This pre-registration configuration is done via the <literal>&#60;registration-data&#62;</literal> element. - </para> - <para> - If the remote producer does not require any registration properties, only an empty <literal>&#60;registration-data&#62;</literal> element need be provided, as JBoss Enterprise Portal Platform can generate the mandatory information. - </para> - <para> - Values for the registration properties required by the remote producer can be provided via <literal>&#60;property&#62;</literal> elements. Refer to the example below for more details. - </para> - <para> - Additionally, the default consumer name automatically provided by JBoss Enterprise Portal Platform can be overridden via the <literal>&#60;consumer-name&#62;</literal> element. When providing a consumer name, please remember that it should uniquely identify your consumer. - </para> - </listitem> - </varlistentry> - </variablelist> + </varlistentry> + + <varlistentry> + <term>Pre-registration information</term> + + <listitem> + <para> + Some producers require consumers to register with them before authorizing them to access their offered portlets. If known, some registration information can be provided in the producer configuration beforehand, so that the consumer can register with the remote producer when required. + </para> + + <note> + <para> + Only simple String properties are supported. It is not possible to configure complex registration data. However, this should be sufficient for most cases. + </para> + </note> + + <para> + This pre-registration configuration is done via the <literal>&#60;registration-data&#62;</literal> element. + </para> + + <para> + If the remote producer does not require any registration properties, only an empty <literal>&#60;registration-data&#62;</literal> element need be provided, as JBoss Enterprise Portal Platform can generate the mandatory information. + </para> + + <para> + Values for the registration properties required by the remote producer can be provided via <literal>&#60;property&#62;</literal> elements. Refer to the example below for more details. + </para> + + <para> + Additionally, the default consumer name automatically provided by JBoss Enterprise Portal Platform can be overridden via the <literal>&#60;consumer-name&#62;</literal> element. When providing a consumer name, please remember that it should uniquely identify your consumer. + </para> + </listitem> + </varlistentry> + </variablelist> </section> - - </section> - - - <section id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Examples"> + </section> + + <section id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Examples"> <title>Examples</title> + <para> - This is the configuration of the <literal>selfv1</literal> and <literal>selfv2</literal> consumers as found in <filename>default-wsrp.xml</filename> with a cache expiring every five minutes and with a 30 second timeout for web service operations: + This is the configuration of the <literal>selfv1</literal> and <literal>selfv2</literal> consumers as found in <filename>default-wsrp.xml</filename> with a cache expiring every five minutes and with a 30 second timeout for web service operations: </para> - <programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default258.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> - This is an example of a WSRP descriptor with registration data and cache expiring every minute: + This is an example of a WSRP descriptor with registration data and cache expiring every minute: </para> - <programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default259.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </section> - - </section> - - - <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consumers_Maintenance"> - <title>Consumers Maintenance</title> - <section id="sect-Reference_Guide-Consumers_Maintenance-Modifying_a_Currently_Held_Registration"> + </section> + </section> + + <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consumers_Maintenance"> + <title>Consumers Maintenance</title> + + <section id="sect-Reference_Guide-Consumers_Maintenance-Modifying_a_Currently_Held_Registration"> <title>Modifying a Currently Held Registration</title> + <section id="sect-Reference_Guide-Modifying_a_Currently_Held_Registration-Registration_Modification_for_Service_Upgrade"> - <title>Registration Modification for Service Upgrade</title> - <para> - Producers often offer several levels of service depending on consumers' subscription levels (for example). This is implemented at the WSRP level with the registration concept: producers can assert which level of service to provide to consumers based on the values of given registration properties. - </para> - <para> - There may also be cases where the registration information has changed and must be updated. For example, the producer required you to provide a valid email and the previous email address is not valid anymore and needs to be updated. - </para> - <para> - Therefore at times it may be necessary to modify the registration that sets the service agreement between a consumer and a producer. - </para> - <para> - For example; the producer requiring an email that was configured in <xref linkend="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet" />. In that case the producer was requiring registration and required a value to be provided for the <literal>email</literal> property. - </para> - <para> - To update the email address that was provided, the remote producer must be informed that some registration data has been modified. - </para> - <para> - The following procedure assumes access to the producer has been configured as previously described. - </para> - <procedure> - <step> - <para> - Go to the configuration screen for the <literal>self</literal> producer and change the value of <literal>email</literal> to <literal&gt;foo(a)example.com&lt;/literal&gt; instead of <literal&gt;example(a)example.com&lt;/literal&gt;: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/modify_reg_start.png" format="PNG" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_start.png" format="PNG" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - Click on "<emphasis role="bold">Update properties</emphasis>" to save the change. A "<emphasis role="bold">Modify registration</emphasis>" button should now appear to let you send this new data to the remote producer: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/modify_reg_modify.png" format="PNG" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_modify.png" format="PNG" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - Click on <emphasis role="bold">Modify registration</emphasis> and, if the updated registration details have been accepted by the remote producer the following should appear: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/modify_reg_end.png" format="PNG" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_end.png" format="PNG" /> - </imageobject> - </mediaobject> - </step> - </procedure> + <title>Registration Modification for Service Upgrade</title> + + <para> + Producers often offer several levels of service depending on consumers' subscription levels (for example). This is implemented at the WSRP level with the registration concept: producers can assert which level of service to provide to consumers based on the values of given registration properties. + </para> + + <para> + There may also be cases where the registration information has changed and must be updated. For example, the producer required you to provide a valid email and the previous email address is not valid anymore and needs to be updated. + </para> + + <para> + Therefore at times it may be necessary to modify the registration that sets the service agreement between a consumer and a producer. + </para> + + <para> + For example; the producer requiring an email that was configured in <xref linkend="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet" />. In that case the producer was requiring registration and required a value to be provided for the <literal>email</literal> property. + </para> + + <para> + To update the email address that was provided, the remote producer must be informed that some registration data has been modified. + </para> + + <para> + The following procedure assumes access to the producer has been configured as previously described. + </para> + + <procedure> + <step><para> + Go to the configuration screen for the <literal>self</literal> producer and change the value of <literal>email</literal> to <literal&gt;foo(a)example.com&lt;/literal&gt; instead of <literal&gt;example(a)example.com&lt;/literal&gt;: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/modify_reg_start.png" format="PNG" scale="100" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_start.png" format="PNG" /> + </imageobject> + </mediaobject></step> + + <step><para> + Click on "<emphasis role="bold">Update properties</emphasis>" to save the change. A "<emphasis role="bold">Modify registration</emphasis>" button should now appear to let you send this new data to the remote producer: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/modify_reg_modify.png" format="PNG" scale="100" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_modify.png" format="PNG" /> + </imageobject> + </mediaobject></step> + + <step><para> + Click on <emphasis role="bold">Modify registration</emphasis> and, if the updated registration details have been accepted by the remote producer the following should appear: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/modify_reg_end.png" format="PNG" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_end.png" format="PNG" /> + </imageobject> + </mediaobject></step> + </procedure> </section> - - + <section id="sect-Reference_Guide-Modifying_a_Currently_Held_Registration-Registration_Modification_on_Producer_Error"> - <title>Registration Modification on Producer Error</title> - <para> - If a Producer administrator changes the requirements for registered consumers, invoking operations on the producer may fail with an <exceptionname>OperationFailedFault</exceptionname>. JBoss Enterprise Portal Platform will attempt to assist in these cases. - </para> - <para> - This section will discuss an example using the <literal>self</literal> producer. - </para> - <para> - Assuming that the registration requires a valid value for an <literal>email</literal> registration property (as has been shown) the configuration screen for this producer should show: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/config_self.png" format="PNG" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_self.png" format="PNG" /> - </imageobject> - </mediaobject> - <para> - If the administrator of the producer now requires an additional value to be provided for a <literal>name</literal> registration property operations with this producer will fail. - </para> - <para> - If a registration modification is required, go to the configuration screen for this remote producer and refresh the information held by the consumer by pressing "<emphasis role="bold">Refresh &amp; Save</emphasis>": - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/modify_reg_self.png" format="PNG" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_self.png" format="PNG" /> - </imageobject> - </mediaobject> - <para> - The configuration screen now shows the currently held registration information and the expected information from the producer. - </para> - <para> - Enter a value for the <literal>name</literal> property and then click on "<emphasis role="bold">Modify registration</emphasis>". If the producer accepts the new registration data, the following screen will appear: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/modify_reg_self_end.png" format="PNG" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_self_end.png" format="PNG" /> - </imageobject> - </mediaobject> - <note> - <title><emphasis role="bold">JBoss Enterprise Portal Platform &VY; and WSRP 1 Exceptions</emphasis></title> - <para> - In WSRP 1, it can be difficult to ascertain what caused an <exceptionname>OperationFailedFault</exceptionname> as it is a generic exception returned by producers during a failed method invocation. - </para> - <para> - An <exceptionname>OperationFailedFault</exceptionname> failure can be caused by several different reasons, one of them being a request to modify the registration data. - </para> - <para> - In these instances examining the log files may assist in gathering more information about the problem. - </para> - <para> - WSRP 2 introduces an exception that is specific to a request to modify registrations which reduces the ambiguity that currently exists. - </para> - </note> + <title>Registration Modification on Producer Error</title> + + <para> + If a Producer administrator changes the requirements for registered consumers, invoking operations on the producer may fail with an + <exceptionname> + OperationFailedFault + </exceptionname> + . JBoss Enterprise Portal Platform will attempt to assist in these cases. + </para> + + <para> + This section will discuss an example using the <literal>self</literal> producer. + </para> + + <para> + Assuming that the registration requires a valid value for an <literal>email</literal> registration property (as has been shown) the configuration screen for this producer should show: + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/config_self.png" format="PNG" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_self.png" format="PNG" /> + </imageobject> + </mediaobject> + + <para> + If the administrator of the producer now requires an additional value to be provided for a <literal>name</literal> registration property operations with this producer will fail. + </para> + + <para> + If a registration modification is required, go to the configuration screen for this remote producer and refresh the information held by the consumer by pressing "<emphasis role="bold">Refresh &amp; Save</emphasis>": + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/modify_reg_self.png" format="PNG" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_self.png" format="PNG" /> + </imageobject> + </mediaobject> + + <para> + The configuration screen now shows the currently held registration information and the expected information from the producer. + </para> + + <para> + Enter a value for the <literal>name</literal> property and then click on "<emphasis role="bold">Modify registration</emphasis>". If the producer accepts the new registration data, the following screen will appear: + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/modify_reg_self_end.png" format="PNG" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_self_end.png" format="PNG" /> + </imageobject> + </mediaobject> + + <note> + <title><emphasis role="bold">JBoss Enterprise Portal Platform &VY; and WSRP 1 Exceptions</emphasis></title> + + <para> + In WSRP 1, it can be difficult to ascertain what caused an + <exceptionname> + OperationFailedFault + </exceptionname> + as it is a generic exception returned by producers during a failed method invocation. + </para> + + <para> + An + <exceptionname> + OperationFailedFault + </exceptionname> + failure can be caused by several different reasons, one of them being a request to modify the registration data. + </para> + + <para> + In these instances examining the log files may assist in gathering more information about the problem. + </para> + + <para> + WSRP 2 introduces an exception that is specific to a request to modify registrations which reduces the ambiguity that currently exists. + </para> + </note> </section> - - </section> - - - <section id="sect-Reference_Guide-Consumers_Maintenance-Consumer_Operations"> + </section> + + <section id="sect-Reference_Guide-Consumers_Maintenance-Consumer_Operations"> <title>Consumer Operations</title> + <para> - Several operations are available from the consumer list view of the WSRP configuration portlet: + Several operations are available from the consumer list view of the WSRP configuration portlet: </para> + <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/consumer_operations.png" format="PNG" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/consumer_operations.png" format="PNG" /> - </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/consumer_operations.png" format="PNG" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/consumer_operations.png" format="PNG" /> + </imageobject> </mediaobject> + <para> - The available operations are: + The available operations are: </para> + <variablelist> - <varlistentry> - <term>Configure</term> - <listitem> - <para> - Displays the consumer details and allows user to edit them. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Refresh</term> - <listitem> - <para> - Forces the consumer to retrieve the service description from the remote producer to refresh the local information (such as offered portlets, registration information). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Activate/Deactivate</term> - <listitem> - <para> - Activates or deactivates a consumer, governing whether it will be available to provide portlets and receive portlet invocations. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Register/De-register</term> - <listitem> - <para> - Registers or de-registers a consumer based on whether registration is required and/or acquired. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Delete</term> - <listitem> - <para> - Destroys the consumer, after de-registering it if it was registered. - </para> - </listitem> - </varlistentry> + <varlistentry> + <term>Configure</term> + + <listitem> + <para> + Displays the consumer details and allows user to edit them. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Refresh</term> + + <listitem> + <para> + Forces the consumer to retrieve the service description from the remote producer to refresh the local information (such as offered portlets, registration information). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Activate/Deactivate</term> + + <listitem> + <para> + Activates or deactivates a consumer, governing whether it will be available to provide portlets and receive portlet invocations. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Register/De-register</term> + + <listitem> + <para> + Registers or de-registers a consumer based on whether registration is required and/or acquired. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Delete</term> + + <listitem> + <para> + Destroys the consumer, after de-registering it if it was registered. + </para> + </listitem> + </varlistentry> </variablelist> - <formalpara> - <title><emphasis role="bold">Additional Functionalities in WSRP 2.0</emphasis></title> - <para> - In addition to those listed above, the WSRP 2.0 implementation in JBoss Enterprise Portal Platform &VY; also includes the following functions: - </para> - </formalpara> - <variablelist> - <title>Additional Functions:</title> - <varlistentry> - <term>Export</term> + + <formalpara> + <title><emphasis role="bold">Additional Functionalities in WSRP 2.0</emphasis></title> <para> + In addition to those listed above, the WSRP 2.0 implementation in JBoss Enterprise Portal Platform &VY; also includes the following functions: + </para> + </formalpara> + + <variablelist> + <title>Additional Functions:</title> + + <varlistentry> + <term>Export</term> + <listitem> <para> Exports some or all of the consumer's portlets to be able to later import them in a different context </para> </listitem> - </varlistentry> - <varlistentry> - <term>Import</term> + </varlistentry> + + <varlistentry> + <term>Import</term> + <listitem> <para> Imports some or all of previously exported portlets. </para> </listitem> - </varlistentry> - </variablelist> - <section> - <title><emphasis role="bold">Importing and Exporting Portlets</emphasis></title> + </varlistentry> + </variablelist> + + <section> + <title><emphasis role="bold">Importing and Exporting Portlets</emphasis></title> + <para> Import and export are new functionalities added in WSRP 2. </para> + <para> Exporting a portlet allows a consumer to get an opaque representation of the portlet which can then be use by the corresponding import operation to reconstitute it. </para> + <para> This is mostly used in migration scenarios during batch operations. Since JBoss Enterprise Portal Platform does not currently support automated migration of portal data, the functionality provided as part of WSRP 2 is necessarily less complete than it could be with full portal support. </para> + <para> The import/export implementation in JBoss Enterprise Portal Platform allows users to export portlets from a given consumer and then import them back to replace existing portlets assigned to windows on pages by the previously exported portlets. </para> + <procedure> <title></title> - <step> - <para> - Click on the "<guilabel>Export</guilabel>" action for a given consumer to display the list of portlets currently made available by this specific consumer. An example list is shown below: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/WSRP/export_portlet_list.png" format="PNG" align="center" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/WSRP/export_portlet_list.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - Once portlets have been selected, they can be exported by clicking on the "<guilabel>Export</guilabel>" button. This makes them available for later import: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/WSRP/export_done.png" format="PNG" align="center" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/WSRP/export_done.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - The portlets can be re-imported directly by pressing the "<guilabel>Use for import</guilabel>" button or, on the Consumers list page, using the "<guilabel>Import</guilabel>" action for a given consumer. - </para> - <para> - The example below assumes that the second option has been used and that several sets of previously exported portlets are available to import from. After clicking the action link, a screen similar to the one below should appear: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/WSRP/export_list.png" format="PNG" align="center" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/WSRP/export_list.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - <para> - This screen presents the list of available exports with available operations for each. - </para> - <variablelist> - <title>Operations:</title> - <varlistentry> - <term>View</term> - <listitem> - <para> - Displays the export details as previously seen when the export was first performed. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Delete</term> - <listitem> - <para> - Deletes the selected export, asking you for confirmation first. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Use for import</term> - <listitem> - <para> - Selects the export to import portlets from. - </para> - </listitem> - </varlistentry> - </variablelist> - </step> - <step> - <para> - Once you have selected an export to import from, you will see a screen similar to the one below: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/WSRP/import_start.png" format="PNG" align="center" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/WSRP/import_start.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - <para> - The screen displays the list of available exported portlets for the previously selected export. You can select which portlet you want to import by checking the checkbox next to its name. - </para> - </step> - <step> - <para> - Select the content of which window the imported portlet will replace. This process is done in three steps: - </para> - <para> - This example assumes that you have the following page called <literal>page1</literal> which contains two windows called <literal>NetUnity WSRP 2 Interop - Cache Markup (remote)</literal> and <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal>, as shown below: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/WSRP/import_original_page.png" format="PNG" align="center" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/WSRP/import_original_page.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - <para> - In this example, we want to replace the content of the <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> with the content of the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> portlet that was previously exported. - </para> - <procedure> - <title></title> - <step> - <para> - Check the box next to the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> portlet name to indicate that you want to import its data. - </para> - </step> - <step> - <para> - Select <literal>page1</literal> in the list of available pages. The screen will then refresh to display the list of available windows on that page, similar to the image below: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/WSRP/import_selected_page.png" format="PNG" align="center" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/WSRP/import_selected_page.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - <note> - <title>Note</title> - <para> - At this point, you still need to select which window content you want to replace before being able to complete the import operation - </para> - </note> - </step> - <step> - <para> - Select the <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> window, which enables the "<guilabel>Import</guilabel>" button. This indicates that all the necessary data to perform the import is available. - </para> - </step> - <step> - <para> - Click the "<guilabel>Import</guilabel>" button. A screen similar to the one below will appear: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/WSRP/import_success.png" format="PNG" align="center" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/WSRP/import_success.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </step> - </procedure> - </step> - <step> - <para> - The <literal>page1</literal> page should now show that the content of <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> window has been replaced by the content of the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> imported portlet and that the window has been renamed appropriately. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/WSRP/import_modified_page.png" format="PNG" align="center" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/WSRP/import_modified_page.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </step> + + <step><para> + Click on the "<guilabel>Export</guilabel>" action for a given consumer to display the list of portlets currently made available by this specific consumer. An example list is shown below: + </para> <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/export_portlet_list.png" format="PNG" align="center" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata fileref="images/WSRP/export_portlet_list.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject></step> + + <step><para> + Once portlets have been selected, they can be exported by clicking on the "<guilabel>Export</guilabel>" button. This makes them available for later import: + </para> <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/export_done.png" format="PNG" align="center" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata fileref="images/WSRP/export_done.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject></step> + + <step><para> + The portlets can be re-imported directly by pressing the "<guilabel>Use for import</guilabel>" button or, on the Consumers list page, using the "<guilabel>Import</guilabel>" action for a given consumer. + </para> <para> + The example below assumes that the second option has been used and that several sets of previously exported portlets are available to import from. After clicking the action link, a screen similar to the one below should appear: + </para> <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/export_list.png" format="PNG" align="center" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata fileref="images/WSRP/export_list.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> <para> + This screen presents the list of available exports with available operations for each. + </para> <variablelist> + <title>Operations:</title> + + <varlistentry> + <term>View</term> + + <listitem> + <para> + Displays the export details as previously seen when the export was first performed. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Delete</term> + + <listitem> + <para> + Deletes the selected export, asking you for confirmation first. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Use for import</term> + + <listitem> + <para> + Selects the export to import portlets from. + </para> + </listitem> + </varlistentry> + </variablelist></step> + + <step><para> + Once you have selected an export to import from, you will see a screen similar to the one below: + </para> <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/import_start.png" format="PNG" align="center" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata fileref="images/WSRP/import_start.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> <para> + The screen displays the list of available exported portlets for the previously selected export. You can select which portlet you want to import by checking the checkbox next to its name. + </para></step> + + <step><para> + Select the content of which window the imported portlet will replace. This process is done in three steps: + </para> <para> + This example assumes that you have the following page called <literal>page1</literal> which contains two windows called <literal>NetUnity WSRP 2 Interop - Cache Markup (remote)</literal> and <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal>, as shown below: + </para> <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/import_original_page.png" format="PNG" align="center" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata fileref="images/WSRP/import_original_page.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> <para> + In this example, we want to replace the content of the <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> with the content of the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> portlet that was previously exported. + </para> <procedure> + <title></title> + + <step><para> + Check the box next to the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> portlet name to indicate that you want to import its data. + </para></step> + + <step><para> + Select <literal>page1</literal> in the list of available pages. The screen will then refresh to display the list of available windows on that page, similar to the image below: + </para> <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/import_selected_page.png" format="PNG" align="center" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata fileref="images/WSRP/import_selected_page.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> <note> + <title>Note</title> + + <para> + At this point, you still need to select which window content you want to replace before being able to complete the import operation + </para> + </note></step> + + <step><para> + Select the <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> window, which enables the "<guilabel>Import</guilabel>" button. This indicates that all the necessary data to perform the import is available. + </para></step> + + <step><para> + Click the "<guilabel>Import</guilabel>" button. A screen similar to the one below will appear: + </para> <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/import_success.png" format="PNG" align="center" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata fileref="images/WSRP/import_success.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject></step> + </procedure></step> + + <step><para> + The <literal>page1</literal> page should now show that the content of <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> window has been replaced by the content of the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> imported portlet and that the window has been renamed appropriately. + </para> <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/import_modified_page.png" format="PNG" align="center" scale="120" /> + </imageobject> + + <imageobject role="fo"> + <imagedata fileref="images/WSRP/import_modified_page.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject></step> </procedure> - </section> - </section> - - <section id="sect-Reference_Guide-Consumers_Maintenance-Erasing_Local_Registration_Data"> + </section> + </section> + + <section id="sect-Reference_Guide-Consumers_Maintenance-Erasing_Local_Registration_Data"> <title>Erasing Local Registration Data</title> + <para> - In rare cases, it may be necessary to erase the local data without being able to de-register first. + In rare cases, it may be necessary to erase the local data without being able to de-register first. </para> + <para> - This can occur when a consumer is registered with a producer that has been modified by its administrator to not require registration any longer. + This can occur when a consumer is registered with a producer that has been modified by its administrator to not require registration any longer. </para> + <para> - In this scenario, local registration information can be erased from the consumer to allow it to resume interacting with the remote producer. + In this scenario, local registration information can be erased from the consumer to allow it to resume interacting with the remote producer. </para> + <para> - To do this click on the "<emphasis role="bold">Erase local registration</emphasis>" button next to the registration context information on the consumer configuration screen: + To do this click on the "<emphasis role="bold">Erase local registration</emphasis>" button next to the registration context information on the consumer configuration screen: </para> + <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/erase_registration.png" format="PNG" scale="80" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/erase_registration.png" format="PNG" /> - </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/erase_registration.png" format="PNG" scale="80" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/erase_registration.png" format="PNG" /> + </imageobject> </mediaobject> + <warning> - <para> - This operation is dangerous as it can result in inability to interact with the remote producer if invoked when not required. The warning message below will be displayed before any data is erased. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/erase_registration_warning.png" format="PNG" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/erase_registration_warning.png" format="PNG" /> - </imageobject> - </mediaobject> + <para> + This operation is dangerous as it can result in inability to interact with the remote producer if invoked when not required. The warning message below will be displayed before any data is erased. + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/erase_registration_warning.png" format="PNG" scale="100" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/erase_registration_warning.png" format="PNG" /> + </imageobject> + </mediaobject> </warning> - </section> - - </section> - - - <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Configuring_the_WSRP_Producer"> - <title>Configuring the WSRP Producer</title> - <section id="sect-Reference_Guide-Configuring_the_WSRP_Producer-Overview"> - <title>Overview</title> + </section> + </section> + + <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Configuring_the_WSRP_Producer"> + <title>Configuring the WSRP Producer</title> + + <section id="sect-Reference_Guide-Configuring_the_WSRP_Producer-Overview"> + <title>Overview</title> + <para> - The behavior of the Portal's WSRP Producer can be configured using the WSRP administration interface, (this is the recommended method), or by editing the <filename><replaceable>WSRP_PATH</replaceable>/lib/gatein.portal.component.wsrp-<replaceable>&lt;VERSION&gt;</replaceable>-epp-GA.jar/conf/wsrp-producer-config.xml</filename> file. + The behavior of the Portal's WSRP Producer can be configured using the WSRP administration interface, (this is the recommended method), or by editing the <filename><replaceable>WSRP_PATH</replaceable>/lib/gatein.portal.component.wsrp-<replaceable>&lt;VERSION&gt;</replaceable>-epp-GA.jar/conf/wsrp-producer-config.xml</filename> file. </para> + <para> - Several aspects can be modified with respect to whether registration is required for consumers to access the Producer's services. An XML Schema for the configuration format is available at <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_producer_1_0.xsd </filename>. + Several aspects can be modified with respect to whether registration is required for consumers to access the Producer's services. An XML Schema for the configuration format is available at <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_producer_1_0.xsd </filename>. </para> - <para> - An alternative to editing the default <filename>wsrp-producer-config.xml</filename> file is to make a custom copy containing the required configuration options. - </para> - <para> - If a copy is used in place of the original, however, the <filename><replaceable>WSRP_PATH</replaceable>/02portal.war/WEB-INF/conf/wsrp/wsrp-configuration.xml</filename> <emphasis role="bold">must</emphasis> be updated to reference the custom file (this file defines the component <literal>WSRPServiceIntegration</literal> and contains a producer and consumer configuration location). - </para> - </section> - - <section id="sect-Reference_Guide-Configuring_the_WSRP_Producer-Default_Configuration"> + + <para> + An alternative to editing the default <filename>wsrp-producer-config.xml</filename> file is to make a custom copy containing the required configuration options. + </para> + + <para> + If a copy is used in place of the original, however, the <filename><replaceable>WSRP_PATH</replaceable>/02portal.war/WEB-INF/conf/wsrp/wsrp-configuration.xml</filename> <emphasis role="bold">must</emphasis> be updated to reference the custom file (this file defines the component <literal>WSRPServiceIntegration</literal> and contains a producer and consumer configuration location). + </para> + </section> + + <section id="sect-Reference_Guide-Configuring_the_WSRP_Producer-Default_Configuration"> <title>Default Configuration</title> + <para> - The default producer configuration requires that consumers register with it before providing access to its services. However it does not require any specific registration properties (excepting those mandated by the WSRP standard). + The default producer configuration requires that consumers register with it before providing access to its services. However it does not require any specific registration properties (excepting those mandated by the WSRP standard). </para> + <para> - It does, however, require consumers to be registered before sending them a full service description. This means that the WSRP producer will not provide the list of offered portlets and other capabilities to unregistered consumers. + It does, however, require consumers to be registered before sending them a full service description. This means that the WSRP producer will not provide the list of offered portlets and other capabilities to unregistered consumers. </para> + <para> - The producer also uses the default <classname>RegistrationPolicy</classname> paired with the default <classname>RegistrationPropertyValidator</classname>. + The producer also uses the default <classname>RegistrationPolicy</classname> paired with the default <classname>RegistrationPropertyValidator</classname>. </para> + <para> - This allows users to customize how Portal's WSRP Producer decides whether a given registration property is valid or not (however property validators are discussed in greater detail in <xref linkend="sect-Reference_Guide-Configuring_the_WSRP_Producer-Registration_Configuration" />). + This allows users to customize how Portal's WSRP Producer decides whether a given registration property is valid or not (however property validators are discussed in greater detail in <xref linkend="sect-Reference_Guide-Configuring_the_WSRP_Producer-Registration_Configuration" />). </para> + <para> - JBoss Enterprise Portal Platform provides a web interface to configure the producer's behavior. It can be accessed by clicking on the "<emphasis role="bold">Producer Configuration</emphasis>" tab of the "<emphasis role="bold">WSRP</emphasis>" page of the "<emphasis role="bold">admin</emphasis>" portal. + JBoss Enterprise Portal Platform provides a web interface to configure the producer's behavior. It can be accessed by clicking on the "<emphasis role="bold">Producer Configuration</emphasis>" tab of the "<emphasis role="bold">WSRP</emphasis>" page of the "<emphasis role="bold">admin</emphasis>" portal. </para> + <para> - The default configuration should show: + The default configuration should show: </para> + <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/producer_default.png" format="PNG" scale="110" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_default.png" format="PNG" /> - </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/producer_default.png" format="PNG" scale="110" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_default.png" format="PNG" /> + </imageobject> </mediaobject> + <para> - You can specify whether or not the producer will send the full service description to unregistered consumers, and, if it requires registration, which <literal>RegistrationPolicy</literal> to use (and, if needed, which <literal>RegistrationPropertyValidator</literal>), along with required registration property description for which consumers must provide acceptable values to successfully register. + You can specify whether or not the producer will send the full service description to unregistered consumers, and, if it requires registration, which <literal>RegistrationPolicy</literal> to use (and, if needed, which <literal>RegistrationPropertyValidator</literal>), along with required registration property description for which consumers must provide acceptable values to successfully register. </para> - <para> - WSDL URLs to access JBoss Enterprise Portal Platform's WSRP producer are now displayed in either in WSRP 1 or WSRP 2 mode.</para> - </section> - - - <section id="sect-Reference_Guide-Configuring_the_WSRP_Producer-Registration_Configuration"> + + <para> + WSDL URLs to access JBoss Enterprise Portal Platform's WSRP producer are now displayed in either in WSRP 1 or WSRP 2 mode. + </para> + </section> + + <section id="sect-Reference_Guide-Configuring_the_WSRP_Producer-Registration_Configuration"> <title>Registration Configuration</title> + <para> - In order to have consumers register with Portal's producer the Portal's behavior with respect to registration must be configured. + In order to have consumers register with Portal's producer the Portal's behavior with respect to registration must be configured. </para> + <para> - Registration is optional, as are registration properties. The producer can require registration without requiring consumers to pass any registration properties as is the case in the default configuration. + Registration is optional, as are registration properties. The producer can require registration without requiring consumers to pass any registration properties as is the case in the default configuration. </para> + <para> - The following section discusses configuring a producer's registration behavior from a blank state: + The following section discusses configuring a producer's registration behavior from a blank state: </para> + <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/producer_blank.png" format="PNG" width="700" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_blank.png" format="PNG" /> - </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/producer_blank.png" format="PNG" width="700" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_blank.png" format="PNG" /> + </imageobject> </mediaobject> + <procedure> - <step> - <para> - To allow unregistered consumers to see the list of offered portlets, leave the first checkbox ("<emphasis role="bold">Access to full service description requires consumers to be registered.</emphasis>") unchecked. - </para> - </step> - <step> - <para> - To specify, however, that consumers will need to be registered to be able to interact with the producer, check the second box ("<emphasis role="bold">Requires registration. Modifying this information will trigger invalidation of consumer registrations."</emphasis>). - </para> - <para> - The screen will refresh and display: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/producer_registration.png" format="PNG" width="700" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_registration.png" format="PNG" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - The fully-qualified name for the <classname>RegistrationPolicy</classname> and <classname>RegistrationPropertyValidator</classname> can be specified here. The default values are acceptable. Refer to <xref linkend="sect-Reference_Guide-Registration_Configuration-Customization_of_Registration_Handling_Behavior" /> for more information. - </para> - </step> - <step> - <para> - To add a registration property called <literal>email</literal> click "<emphasis role="bold">Add property</emphasis>" and enter the appropriate information in the fields, providing a description for the registration property that can be used by consumers to determine its purpose: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/producer_email.png" format="PNG" width="700" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_email.png" format="PNG" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - Press "Save" to record the modifications. - </para> - </step> + <step><para> + To allow unregistered consumers to see the list of offered portlets, leave the first checkbox ("<emphasis role="bold">Access to full service description requires consumers to be registered.</emphasis>") unchecked. + </para></step> + + <step><para> + To specify, however, that consumers will need to be registered to be able to interact with the producer, check the second box ("<emphasis role="bold">Requires registration. Modifying this information will trigger invalidation of consumer registrations."</emphasis>). + </para> <para> + The screen will refresh and display: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/producer_registration.png" format="PNG" width="700" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_registration.png" format="PNG" /> + </imageobject> + </mediaobject></step> + + <step><para> + The fully-qualified name for the <classname>RegistrationPolicy</classname> and <classname>RegistrationPropertyValidator</classname> can be specified here. The default values are acceptable. Refer to <xref linkend="sect-Reference_Guide-Registration_Configuration-Customization_of_Registration_Handling_Behavior" /> for more information. + </para></step> + + <step><para> + To add a registration property called <literal>email</literal> click "<emphasis role="bold">Add property</emphasis>" and enter the appropriate information in the fields, providing a description for the registration property that can be used by consumers to determine its purpose: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/producer_email.png" format="PNG" width="700" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_email.png" format="PNG" /> + </imageobject> + </mediaobject></step> + + <step><para> + Press "Save" to record the modifications. + </para></step> </procedure> - + <note> - <para> - At this time, only String (<literal>xsd:string</literal>) properties are supported. - </para> + <para> + At this time, only String (<literal>xsd:string</literal>) properties are supported. + </para> </note> + <note> - <para> - If consumers are already registered with the producer, modifying the configuration of required registration information will trigger the invalidation of held registrations, requiring consumers to modify their registration before being able to access the producer again. The consumer side of that process is documented in <xref linkend="sect-Reference_Guide-Modifying_a_Currently_Held_Registration-Registration_Modification_on_Producer_Error" />. - </para> + <para> + If consumers are already registered with the producer, modifying the configuration of required registration information will trigger the invalidation of held registrations, requiring consumers to modify their registration before being able to access the producer again. The consumer side of that process is documented in <xref linkend="sect-Reference_Guide-Modifying_a_Currently_Held_Registration-Registration_Modification_on_Producer_Error" />. + </para> </note> + <section id="sect-Reference_Guide-Registration_Configuration-Customization_of_Registration_Handling_Behavior"> - <title>Customization of Registration Handling Behavior</title> - <para> - Registration handling behavior can be customized by users to suit their Producer needs. This is done with an implementation of the <classname>RegistrationPolicy</classname> interface. - </para> - <para> - This interface defines methods that are called by Portal's Registration service so that decisions can be made appropriately. A default registration policy that provides basic behavior is provided and should be enough for most user needs. - </para> - <para> - While the default registration policy provides default behavior for most registration-related aspects, one aspect requires specific configuration: whether a given value for a registration property is acceptable by the WSRP Producer. - </para> - <para> - This is done by plugging a <classname>RegistrationPropertyValidator</classname> into the default registration policy. This allows users to define their own validation mechanism. - </para> - <para> - Refer to the <trademark class="trade">Javadoc</trademark> for <classname>org.gatein.registration.RegistrationPolicy</classname> and <classname>org.gatein.registration.policies.RegistrationPropertyValidator</classname> for more details on what is expected of each method. - </para> - <para> - A defined registration policy is required for the producer to be correctly configured. Do this by specifying the qualified class name of the registration policy. - </para> - <para> - As it is anticipated that most users will use the default registration policy, it is possible to provide the class name of a custom property validator instead to customize the default registration policy behavior. Note that property validators are only used by the default policy. - </para> - <note> - <para> - Since the policy or the validator are defined via their class name and dynamically loaded, it is important to ensure that the identified class is available to the application server. + <title>Customization of Registration Handling Behavior</title> + + <para> + Registration handling behavior can be customized by users to suit their Producer needs. This is done with an implementation of the <classname>RegistrationPolicy</classname> interface. </para> + <para> - One way to accomplish that is to deploy the policy implementation as a JAR file in the AS instance deploy directory. + This interface defines methods that are called by Portal's Registration service so that decisions can be made appropriately. A default registration policy that provides basic behavior is provided and should be enough for most user needs. </para> + <para> - Note also that, since both policies and validators are dynamically instantiated, they must provide a default, no-argument constructor. - </para> - </note> + While the default registration policy provides default behavior for most registration-related aspects, one aspect requires specific configuration: whether a given value for a registration property is acceptable by the WSRP Producer. + </para> + + <para> + This is done by plugging a <classname>RegistrationPropertyValidator</classname> into the default registration policy. This allows users to define their own validation mechanism. + </para> + + <para> + Refer to the <trademark class="trade">Javadoc</trademark> for <classname>org.gatein.registration.RegistrationPolicy</classname> and <classname>org.gatein.registration.policies.RegistrationPropertyValidator</classname> for more details on what is expected of each method. + </para> + + <para> + A defined registration policy is required for the producer to be correctly configured. Do this by specifying the qualified class name of the registration policy. + </para> + + <para> + As it is anticipated that most users will use the default registration policy, it is possible to provide the class name of a custom property validator instead to customize the default registration policy behavior. Note that property validators are only used by the default policy. + </para> + + <note> + <para> + Since the policy or the validator are defined via their class name and dynamically loaded, it is important to ensure that the identified class is available to the application server. + </para> + + <para> + One way to accomplish that is to deploy the policy implementation as a JAR file in the AS instance deploy directory. + </para> + + <para> + Note also that, since both policies and validators are dynamically instantiated, they must provide a default, no-argument constructor. + </para> + </note> </section> - - </section> - - - <section id="sect-Reference_Guide-Configuring_the_WSRP_Producer-WSRP_Validation_Mode"> + </section> + + <section id="sect-Reference_Guide-Configuring_the_WSRP_Producer-WSRP_Validation_Mode"> <title>WSRP Validation Mode</title> + <para> - The lack of conformance kit and the wording of the WSRP specification leaves room for differing interpretations, resulting in interoperability issues. It is therefore possible to encounter issues when using consumers from different vendors. - </para> - <para> - Experience of these issues has produced a way to relax the validation that the WSRP producer performs on the data provided by consumers to help with interoperability by accepting data that would normally be invalid. - </para> - <para> - Note that the our validation algorithm is only relaxed on aspects of the specification that are deemed harmless such as invalid language codes. + The lack of conformance kit and the wording of the WSRP specification leaves room for differing interpretations, resulting in interoperability issues. It is therefore possible to encounter issues when using consumers from different vendors. </para> + <para> - By default, the WSRP producer is configured in strict mode. If you experience issues with a given consumer, you may attempt to relax the validation mode. Un-checking the "Use strict WSRP compliance" checkbox on the Producer configuration screen to do this. + Experience of these issues has produced a way to relax the validation that the WSRP producer performs on the data provided by consumers to help with interoperability by accepting data that would normally be invalid. </para> - </section> - </section> - - <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Removing_WSRP"> - <title>Removing WSRP</title> + <para> - If you are not going to use WSRP in your JBoss Enterprise Portal Platform instance, the WSRP configuration files may be left in place. They will not adversely affect your installation. + Note that the our validation algorithm is only relaxed on aspects of the specification that are deemed harmless such as invalid language codes. </para> + <para> + By default, the WSRP producer is configured in strict mode. If you experience issues with a given consumer, you may attempt to relax the validation mode. Un-checking the "Use strict WSRP compliance" checkbox on the Producer configuration screen to do this. + </para> + </section> + </section> + + <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Removing_WSRP"> + <title>Removing WSRP</title> + + <para> + If you are not going to use WSRP in your JBoss Enterprise Portal Platform instance, the WSRP configuration files may be left in place. They will not adversely affect your installation. + </para> + + <para> + However, if you wish to completely remove WSRP from your portal installation, remove the <filename>gatein-wsrp-integration.ear</filename> file from your application server deploy directory. + </para> +<!--<para> However, if you wish to completely remove WSRP from your portal installation, follow this procedure: </para> <procedure> @@ -1507,7 +1711,7 @@ <para> Open the <filename>repository-configuration.xml</filename> and remove the <emphasis role="bold">WSRP</emphasis> workspace: </para> -<programlisting language="XML" role="XML"><![CDATA[<!-- WSRP --> +<programlisting language="XML" role="XML"><![CDATA[<!DOUBELDASH WSRP DOUBELDASH> <workspace name="wsrp-system"> <container> <properties> @@ -1600,6 +1804,6 @@ </listitem> </itemizedlist> </step> - </procedure> + </procedure> --> </section> -</chapter> + </chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/WSRP.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/WSRP.xml 2011-11-10 22:34:44 UTC (rev 8038) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/WSRP.xml 2011-11-11 02:09:34 UTC (rev 8039) @@ -3,1486 +3,1505 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP"> - <title>Web Services for Remote Portlets (WSRP)</title> - <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Introduction"> - <title>Introduction</title> + <chapter id="chap-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP"> + <title>Web Services for Remote Portlets (WSRP)</title> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Introduction"> + <title>Introduction</title> + <para> The Web Services for Remote Portlets (WSRP) specification defines a web service interface for accessing and interacting with interactive presentation-oriented web services. - </para> + </para> + <para> 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 the proposals made to the committee. - </para> + </para> + <para> Scenarios that motivate WSRP functionality include: - </para> + </para> + <itemizedlist> <listitem> - <para> - Content hosts, such as portal servers, providing Portlets as presentation-oriented web services that can be used by aggregation engines. - </para> - + <para> + Content hosts, such as portal servers, providing Portlets as presentation-oriented web services that can be used by aggregation engines. + </para> </listitem> - <listitem> - <para> - Aggregating frameworks, including portal servers, consuming presentation-oriented web services offered by content providers and integrating them into the framework. - </para> - + + <listitem> + <para> + Aggregating frameworks, including portal servers, consuming presentation-oriented web services offered by content providers and integrating them into the framework. + </para> </listitem> - - </itemizedlist> + </itemizedlist> + <para> More information on WSRP can be found on the official <ulink url="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wsrp...;. We suggest reading the <ulink url="http://www.oasis-open.org/committees/download.php/10539/wsrp-pr... for a good, albeit technical, overview of WSRP. - </para> - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Level_of_Support"> - <title>Level of Support</title> + </para> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Level_of_Support"> + <title>Level of Support</title> + <para> The WSRP Technical Committee defined <ulink url="http://www.oasis-open.org/committees/download.php/3073">... Use Profiles</ulink> to help with WSRP interoperability. Terms defined in that document will be used in this section. - </para> + </para> + <para> JBoss Enterprise Portal Platform provides a <emphasis>Simple</emphasis> level of support for the WSRP Producer, with the exception of out-of-band registration. In-band registration and persistent local state (which are defined at the <emphasis>Complex</emphasis> level) are supported. - </para> + </para> + <para> JBoss Enterprise Portal Platform provides a <emphasis>Medium</emphasis> level of support for the Consumer, excepting HTML markup (as JBoss Enterprise Portal Platform itself does not handle other markup types). Explicit portlet cloning and the <literal>PortletManagement</literal> interface are supported. - </para> + </para> + <para> The WSRP component has Level 1 Producer and Consumer caching. Cookie handling is supported properly on the Consumer. The Producer requires cookie initialization (as this improves interoperability with some consumers). - </para> + </para> + <para> JBoss Enterprise Portal Platform does not support custom window states or modes, therefore neither does the WSRP component. It does, however, support CSS on both the Producer (although this is more a function of the portlets than an inherent Producer capability) and Consumer. - </para> + </para> + <para> JBoss Enterprise Portal Platform &VY; includes implementations of WSRP 1.0 and 2.0. - </para> + </para> + <para> All optional features in WSRP 2 are implemented in JBoss Enterprise Portal Platform &VY; except support for lifetimes and leasing support. - </para> - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Deploying_WSRP"> - <title>Deploying WSRP</title> + </para> + <note> + <para> + As of version &VZ; of Enterprise Portal Platform, WSRP is only activated and supported when deployed on JBoss Enterprise Application Server. + </para> + </note> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Deploying_WSRP"> + <title>Deploying WSRP</title> + + <note> <title>Notational Devices</title> - <para> - The following list of support files uses the following notational devices: + + <para> + The following list of support files uses the following notational devices: </para> - <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Deploying_WSRP-Notations"> - <title>Notations:</title> - <varlistentry> - <term><replaceable>JBOSS_HOME</replaceable></term> - <listitem> - <para> - <replaceable>JBOSS_HOME</replaceable> refers to the directory that your instance of JBoss Enterprise Portal Platform has been extracted/installed to. For example: <filename>/home/<replaceable>USERNAME</replaceable>/jboss-epp-<replaceable>&lt;VERSION&gt;</replaceable>/</filename> - </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable></term> - <listitem> - <para> - The WSRP files referred to in this section are found in the <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear</filename> directory. - </para> - <para> - For ease of reference this path will be represented by: <replaceable>WSRP_PATH</replaceable>. - </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term><replaceable>WSRP_VERSION</replaceable></term> - <listitem> - <para> - <replaceable>WSRP_VERSION</replaceable> represents the version of the WSRP component in use. - </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term><replaceable>PORTAL_VERSION</replaceable></term> - <listitem> - <para> - <replaceable>PORTAL_VERSION</replaceable> represents the version of JBoss Enterprise Portal Platform in use. - </para> - - </listitem> - - </varlistentry> - + + <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Deploying_WSRP-Notations"> + <title>Notations:</title> + + <varlistentry> + <term><replaceable>JBOSS_HOME</replaceable></term> + + <listitem> + <para> + <replaceable>JBOSS_HOME</replaceable> refers to the directory that your instance of JBoss Enterprise Portal Platform has been extracted/installed to. For example: <filename>/home/<replaceable>USERNAME</replaceable>/jboss-epp-<replaceable>&lt;VERSION&gt;</replaceable>/</filename> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable>WSRP_PATH</replaceable></term> + + <listitem> + <para> + The WSRP files referred to in this section are found in the <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear</filename> directory. + </para> + + <para> + For ease of reference this path will be represented by: <replaceable>WSRP_PATH</replaceable>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable>WSRP_VERSION</replaceable></term> + + <listitem> + <para> + <replaceable>WSRP_VERSION</replaceable> represents the version of the WSRP component in use. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable>PORTAL_VERSION</replaceable></term> + + <listitem> + <para> + <replaceable>PORTAL_VERSION</replaceable> represents the version of JBoss Enterprise Portal Platform in use. + </para> + </listitem> + </varlistentry> </variablelist> - - </note> + </note> + + <para> + Starting with version 2.1.0-GA of the component, WSRP is packaged as a JBoss Enterprise Portal Platform extension and is now self-contained in an easy to install package named <filename>gatein-wsrp-integration.ear</filename>, deployed directly in the <filename>deploy</filename> directory of your JBoss Application Server configuration directory. + </para> + + <para> + The extension itself is composed of the following components: + </para> + <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Deploying_WSRP-WSRP_support_files"> <title>WSRP support files</title> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/wsrp-admin-gui.war</term> - <listitem> - <para> - This file contains the WSRP Configuration portlet with which you can configure consumers to access remote servers and how the WSRP producer is configured. - </para> - - </listitem> - + + <varlistentry> + <term><filename>META-INF/</filename></term> + + <listitem> + <para> + This directory contains files necessary for EAR packaging. The only file that is of interest from a user perspective is <filename>gatein-wsse-consumer.xml</filename> which allows you to configure WS-Security support for the consumer. !!!TODO mwringe please detail !!!! + </para> + </listitem> </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/wsrp-producer.war</term> - <listitem> - <para> - This file contains the WSRP producer web application. - </para> - - </listitem> - + + <varlistentry> + <term><filename>extension-component-$PORTAL_VERSION.jar</filename></term> + + <listitem> + <para> + This archive which contains the components needed to integrate the WSRP component into JBoss Enterprise Portal Platform. It also includes the default configuration files for the WSRP producer and the default WSRP consumers. + </para> + </listitem> </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-common-<replaceable>WSRP_VERSION</replaceable>.jar</term> - <listitem> - <para> - This file contains common classes needed by the different WSRP libraries. - </para> - - </listitem> - + + <varlistentry> + <term><filename>extension-config-$PORTAL_VERSION.jar</filename></term> + + <listitem> + <para> + This file contains the configuration file needed by the GateIn extension mechanism to properly register this EAR as an extension. + </para> + </listitem> </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-consumer-<replaceable>WSRP_VERSION</replaceable>.jar</term> - <listitem> - <para> - This file contains the WSRP consumer. - </para> - - </listitem> - + + <varlistentry> + <term><filename>extension-war-$PORTAL_VERSION.war</filename></term> + + <listitem> + <para> + This file contains the configuration files needed by the GateIn extension mechanism to properly setup the WSRP service. It includes <filename>wsrp-configuration.xml</filename> which, in particular, configures several options for the <code> WSRPServiceIntegration </code> component at the heart of the WSRP integration in JBoss Enterprise Portal Platform. + </para> + </listitem> </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar</term> - <listitem> - <para> - This file contains the API classes needed to integrate the WSRP component into portals. - </para> - - </listitem> - + + <varlistentry> + <term><filename>lib/</filename></term> + + <listitem> + <para> + This directory contains the different libraries needed by the WSRP service. + </para> + </listitem> </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-producer-lib-$WSRP_VERSION.jar</term> - <listitem> - <para> - This file contains the classes needed by the WSRP producer. - </para> - - </listitem> - + + <varlistentry> + <term><filename>wsrp-admin-gui-$WSRP_VERSION.war</filename></term> + + <listitem> + <para> + This file contains the WSRP Configuration portlet with which you can configure consumers to access remote servers and how the WSRP producer is configured. + </para> + </listitem> </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-wsrp1-ws-<replaceable>WSRP_VERSION</replaceable>.jar</term> - <listitem> - <para> - This file contains the generated JAX-WS classes for WSRP version 1. - </para> - - </listitem> - + + <varlistentry> + <term><filename>wsrp-producer-jb5wsss-$WSRP_VERSION.war</filename></term> + + <listitem> + <para> + This file contains the producer-side support for WS-Security. !!!!TODO mwringe: please detail if there are any user-modifiable configuration file there and how this files is different in AS 6 !!!! + </para> + </listitem> </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/wsrp-wsrp2-ws-<replaceable>WSRP_VERSION</replaceable>.jar</term> - <listitem> - <para> - This file contains the JAX-WS classes for WSRP version 2. - </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term><replaceable>WSRP_PATH</replaceable>/lib/gatein.portal.component.wsrp-<replaceable>PORTAL_VERSION</replaceable>.jar</term> - <listitem> - <para> - This file contains the code to integrate the WSRP service into JBoss Enterprise Portal Platform. - </para> - - </listitem> - - </varlistentry> - - </variablelist> + </variablelist> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Deploying_WSRP-Non_default_Ports_or_Hostnames"> <title>Non-default Ports or Hostnames</title> - <para> - JBoss WS (the web service stack that JBoss Enterprise Portal Platform uses) should update the port and host name used in WSDL. Refer to the JBoss WS <ulink url="http://community.jboss.org/wiki/JBossWS-UserGuide#Configuration... guide</ulink> for more information. + + <para> + JBoss WS (the web service stack that JBoss Enterprise Portal Platform uses) should update the port and host name used in WSDL. Refer to the JBoss WS <ulink url="http://community.jboss.org/wiki/JBossWS-UserGuide#Configuration... guide</ulink> for more information. </para> - <para> - If the host name and port on which the server runs have been modified, the configuration for the Consumer used to consume JBoss Enterprise Portal Platform's "self" Producer will need to be updated. Refer to <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets" /> for directions on how to do this. + + <para> + If the host name and port on which the server runs have been modified, the configuration for the Consumer used to consume JBoss Enterprise Portal Platform's "self" Producer will need to be updated. Refer to <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets" /> for directions on how to do this. </para> - - </section> - + </section> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Deploying_WSRP-Using_WSRP_with_SSL"> <title>Using WSRP with SSL</title> - <para> - It is possible to use WSRP over SSL for secure exchange of data. Refer to these <ulink url="http://community.jboss.org/wiki/ConfiguringWSRPforuseoverSSL&qu... for how to do this. + + <para> + It is possible to use WSRP over SSL for secure exchange of data. Refer to these <ulink url="http://community.jboss.org/wiki/ConfiguringWSRPforuseoverSSL&qu... for how to do this. </para> - - </section> - - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Making_a_Portlet_Remotable"> - <title>Making a Portlet Remotable</title> + </section> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Making_a_Portlet_Remotable"> + <title>Making a Portlet Remotable</title> + <note> <para> - Only JSR-286 (Portlet 2.0) portlets can be made remotable as the mechanism to expose a portlet to WSRP relies on a JSR-286-only functionality. + Only JSR-286 (Portlet 2.0) portlets can be made remotable as the mechanism to expose a portlet to WSRP relies on a JSR-286-only functionality. </para> - - </note> + </note> + <para> JBoss Enterprise Portal Platform does <emphasis role="bold">not</emphasis>, by default, expose local portlets for consumption by remote WSRP consumers. - </para> + </para> + <para> In order to make a portlet remotely available, it must be made "remotable" by marking it as such in the associated <filename>portlet.xml</filename>. - </para> + </para> + <para> A specific <code>org.gatein.pc.remotable container-runtime-option</code> is used to accomplish this. Setting its value to <code>true</code> makes the portlet available for remote consumption, while setting its value to <code>false</code> will not publish it remotely. - </para> + </para> + <para> As specifying the remotable status for a portlet is optional, nothing need be done if portlets do not need to be remotely available. - </para> + </para> + <para> In the following example, the "BasicPortlet" portlet is specified as being remotable. - </para> - + </para> <programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default255.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> It is also possible to specify that all the portlets declared within a given portlet application be remotable by default. - </para> + </para> + <para> This is done by specifying the <code>container-runtime-option</code> at the <code>portlet-app</code> element level. Individual portlets can override that value to not be remotely exposed. - </para> + </para> + <para> For example: - </para> - + </para> <programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default256.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> This example defines two portlets. As the <code>org.gatein.pc.remotable container-runtime-option</code> is set to <code>true</code> at the <code>portlet-app</code> level, all portlets defined in this particular portlet application are exposed remotely by JBoss Enterprise Portal Platform's WSRP Producer. - </para> + </para> + <para> It is possible to override this default behavior. Specifying a value for the <code>org.gatein.pc.remotable container-runtime-option</code> at the <code>portlet</code> level will take precedence over the default. - </para> + </para> + <para> - In the example above, the <varname>RemotelyExposedPortlet</varname> inherits the remotable status defined at the <code>portlet-app</code> level since it does not specify a value for the <code>org.gatein.pc.remotable container-runtime-option</code>. - </para> + In the example above, the <literal>RemotelyExposedPortlet</literal> inherits the remotable status defined at the <code>portlet-app</code> level since it does not specify a value for the <code>org.gatein.pc.remotable container-runtime-option</code>. + </para> + <para> - The <varname>NotRemotelyExposedPortlet</varname>, however, overrides the default behavior and is not remotely exposed. - </para> + The <literal>NotRemotelyExposedPortlet</literal>, however, overrides the default behavior and is not remotely exposed. + </para> + <note> + <title>Note</title> + <para> - Portlets are not remotely exposed if no top-level <code>org.gatein.pc.remotable container-runtime-option</code> value is set to <code>true</code>. + Portlets are not remotely exposed if no top-level <code>org.gatein.pc.remotable container-runtime-option</code> value is set to <code>true</code>. </para> - - </note> - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_WSRP_portlets_from_a_remote_Consumer"> - <title>Consuming WSRP portlets from a remote Consumer</title> + </note> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_WSRP_portlets_from_a_remote_Consumer"> + <title>Consuming WSRP portlets from a remote Consumer</title> + <para> Configuration is extremely variable between different WSRP Consumers. Most, however, require a specification of the URL for the Producer's WSDL definition. If the JBoss Enterprise Portal Platform Consumer is not being used, refer to the documentation for the Consumer that is in use for specific instructions. - </para> + </para> + <para> - For instructions on how to specify this URL in JBoss Enterprise Portal Platform, refer to <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets" />. - </para> + For instructions on how to specify this URL in JBoss Enterprise Portal Platform, refer to <xref linkend="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets" />. + </para> + <para> JBoss Enterprise Portal Platform's Producer is automatically set up when a portal instance is deployed with the WSRP service. - </para> + </para> + <para> The WSDL file can be accessed at: - </para> + </para> + <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Consuming_WSRP_portlets_from_a_remote_Consumer-File_paths"> <title>File paths:</title> - <varlistentry> - <term>WSRP 1.0:</term> - <listitem> - <para> - <filename>http://<replaceable>{hostname}</replaceable>:<replaceable>{port}</replaceable>/wsrp-producer/v1/MarkupService?wsdl</filename>. - </para> - - </listitem> - + + <varlistentry> + <term>WSRP 1.0:</term> + + <listitem> + <para> + <filename>http://<replaceable>{hostname}</replaceable>:<replaceable>{port}</replaceable>/wsrp-producer/v1/MarkupService?wsdl</filename>. + </para> + </listitem> </varlistentry> - <varlistentry> - <term>WSRP 2.0:</term> - <listitem> - <para> - <filename>http://<replaceable>{hostname}</replaceable>:<replaceable>{port}</replaceable>/wsrp-producer/v2/MarkupService?wsdl</filename>. - </para> - - </listitem> - + + <varlistentry> + <term>WSRP 2.0:</term> + + <listitem> + <para> + <filename>http://<replaceable>{hostname}</replaceable>:<replaceable>{port}</replaceable>/wsrp-producer/v2/MarkupService?wsdl</filename>. + </para> + </listitem> </varlistentry> - - </variablelist> + </variablelist> + <para> The default hostname is <literal>localhost</literal> and the default port is <literal>8080</literal>. - </para> - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets"> - <title>Consuming Remote WSRP Portlets</title> + </para> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets"> + <title>Consuming Remote WSRP Portlets</title> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Consuming_Remote_WSRP_Portlets-Overview"> <title>Overview</title> - <para> - To be able to consume WSRP portlets exposed by a remote producer, JBoss Enterprise Portal Platform's WSRP consumer must be configured to access that remote producer. + + <para> + To be able to consume WSRP portlets exposed by a remote producer, JBoss Enterprise Portal Platform's WSRP consumer must be configured to access that remote producer. </para> - <para> - Access to a remote producer can be configured using WSRP Producer descriptors. Alternatively, a portlet is provided to configure remote producers. + + <para> + Access to a remote producer can be configured using WSRP Producer descriptors. Alternatively, a portlet is provided to configure remote producers. </para> - <para> - Once a remote producer has been configured, the portlets that it exposes are then available in the Application Registry to be added to categories and then to pages. + + <para> + Once a remote producer has been configured, the portlets that it exposes are then available in the Application Registry to be added to categories and then to pages. </para> - <!-- Removed as out of date and not in Community version of doc. +<!-- Removed as out of date and not in Community version of doc. <para> A default consumer named <literal>self</literal>, that consumes the portlets exposed by JBoss Enterprise Portal Platform's producer, has been configured as a way to test the WSRP producer service and to check that portlets are correctly published via WSRP. </para> --> - </section> - + </section> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Consuming_Remote_WSRP_Portlets-Configuring_a_Remote_Producer"> <title>Configuring a Remote Producer</title> - <para> - Access to a remote producer needs to be defined so that portlets can be consumed within JBoss Enterprise Portal Platform. This section will show how to configure access to <emphasis role="bold">Oracle</emphasis>'s public WSRP producer. Firstly using the configuration portlet. Then how the same result can be accomplished with a producer descriptor, though it is far easier to do so via the configuration portlet. + + <para> + Access to a remote producer needs to be defined so that portlets can be consumed within JBoss Enterprise Portal Platform. This section will show how to configure access to <emphasis role="bold">Oracle</emphasis>'s public WSRP producer. Firstly using the configuration portlet. Then how the same result can be accomplished with a producer descriptor, though it is far easier to do so via the configuration portlet. </para> - <important> - <title>Chunked Encoding</title> - <para> - Some WSRP producers, such as Oracle, do not support chunked encoding. If your producer does not support chunked encoding, it will not be able to properly connect to the producer. - </para> - <para> - This will manifest itself with the following error: - </para> - + + <important> + <title>Chunked Encoding</title> + + <para> + Some WSRP producers, such as Oracle, do not support chunked encoding. If your producer does not support chunked encoding, it will not be able to properly connect to the producer. + </para> + + <para> + This will manifest itself with the following error: + </para> <screen>Caused by: org.jboss.ws.WSException: Invalid HTTP server response [503] - Service Unavailable. </screen> - <para> - A workaround for this issue involves editing the <parameter>chunksize</parameter> setting in the <filename>standard-jaxws-client-config.xml</filename> file. - </para> - <para> - Refer to <ulink type="http" url="http://community.jboss.org/wiki/Workaroundwhenchunkedencodingis... for more information. - </para> - + <para> + A workaround for this issue involves editing the <parameter>chunksize</parameter> setting in the <filename>standard-jaxws-client-config.xml</filename> file. + </para> + + <para> + Refer to <ulink type="http" url="http://community.jboss.org/wiki/Workaroundwhenchunkedencodingis... for more information. + </para> </important> - <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-The_Configuration_Portlet"> - <title>The Configuration Portlet</title> - <para> - JBoss Enterprise Portal Platform provides a graphical portlet to assist with configuring access to, and other facets of, remote WSRP Producers. - </para> - <para> - It is available at: <ulink type="http" url="http://localhost:8080/portal/login?initialURI=%2Fportal%2Fprivate%2Fclassic%2FwsrpConfiguration&amp;username=root&amp;password=gtn" />. - </para> - <para> - The portlet also is a group page for /platform/administrators - </para> - <para> - Although the Configuration Portlet is installed by default in JBoss Enterprise Portal Platform &VY;., installation instructions are included below should the portlet ever need to be re-installed: - </para> - <procedure id="proc-Reference_Guide_eXo_JCR_1.14-The_Configuration_Portlet-Installing_the_configuration_portlet"> - <title><emphasis role="bold">Installing the configuration portlet:</emphasis></title> - <step> - <para> - 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> - <para> - Add the WSRP Configuration portlet to the Administration category. If the Import Applications functionality is used, the WSRP Configuration portlet will be automatically added to the Administration category. - </para> - - </step> - <step> - <para> - Once the portlet is added to a category, it can be added to a page and used. It is recommended that it be added to the same page as the Application Registry (as other operations relating to WSRP and adding portlets to categories are somewhat related). Add the WSRP Configuration portlet to the page using the standard procedure. - </para> - - </step> - - </procedure> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-The_Configuration_Portlet"> + <title>The Configuration Portlet</title> - <section id="sect-Reference_Guide_eXo_JCR_1.14-The_Configuration_Portlet-Using_the_Configuration_portlet"> - <title><emphasis role="bold">Using the Configuration portlet</emphasis></title> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/config_init.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_init.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> + <para> + JBoss Enterprise Portal Platform provides a graphical portlet to assist with configuring access to, and other facets of, remote WSRP Producers. + </para> + + <para> + It is available at: <ulink type="http" url="http://localhost:8080/portal/login?initialURI=%2Fportal%2Fprivate%2Fclassic%2FwsrpConfiguration&amp;username=root&amp;password=gtn" />. + </para> + + <para> + The portlet also is a group page for /platform/administrators + </para> + + <para> + Although the Configuration Portlet is installed by default in JBoss Enterprise Portal Platform &VY;., installation instructions are included below should the portlet ever need to be re-installed: + </para> + + <procedure id="proc-Reference_Guide_eXo_JCR_1.14-The_Configuration_Portlet-Installing_the_configuration_portlet"> + <title><emphasis role="bold">Installing the configuration portlet:</emphasis></title> + + <step><para> + 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><para> + Add the WSRP Configuration portlet to the Administration category. If the Import Applications functionality is used, the WSRP Configuration portlet will be automatically added to the Administration category. + </para></step> + + <step><para> + Once the portlet is added to a category, it can be added to a page and used. It is recommended that it be added to the same page as the Application Registry (as other operations relating to WSRP and adding portlets to categories are somewhat related). Add the WSRP Configuration portlet to the page using the standard procedure. + </para></step> + </procedure> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-The_Configuration_Portlet-Using_the_Configuration_portlet"> + <title><emphasis role="bold">Using the Configuration portlet</emphasis></title> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/config_init.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_init.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + + <para> + This screen presents all the configured consumers associated with their status and possible actions on them. + </para> + + <para> + A Consumer can be active or inactive. Activating a Consumer means that it is ready to act as a portlet provider. + </para> + + <para> + Note also that a Consumer can be marked as requiring <emphasis>refresh</emphasis>, which means that the information held about it might not be up to date. Refreshing it from the remote Producer will update this information. + </para> + + <para> + This can happen for several reasons: the service description for that remote Producer has not been fetched yet, the cached version has expired or modifications have been made to the configuration that could potentially invalidate it, thus requiring re-validation of the information. + </para> + + <para> + To create a new Consumer: + </para> + + <procedure id="proc-Reference_Guide_eXo_JCR_1.14-Using_the_Configuration_portlet-Creating_a_Consumer"> + <title><emphasis role="bold">Creating a Consumer</emphasis></title> + + <step><para> + Type "<literal> oracle</literal>" into the "<emphasis role="bold">Create a consumer named:</emphasis>" field. + </para></step> + + <step><para> + Click on "<emphasis role="bold">Create consumer</emphasis>" to create a new Consumer called <literal>oracle</literal>. + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/config_create.png" format="PNG" scale="100" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_create.png" format="PNG" width="444" /> + </imageobject> + </mediaobject></step> + + <step><para> + In the next form, set the cache expiration value to <parameter>300</parameter> seconds. + </para></step> + + <step><para> + Leave the default timeout value for web services (WS) operations. + </para></step> + + <step><para> + Enter the WSDL URL for the producer in the text field. + </para></step> + + <step><para> + Press the "Refresh &amp; Save" button: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/config_wsdl.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_wsdl.png" format="PNG" width="444" /> + </imageobject> + </mediaobject></step> + </procedure> + + <para> + This will retrieve the service description associated with the Producer which WSRP interface is described by the WSDL file found at the URL entered. + </para> + + <para> + In this case, querying the service description will show that the Producer requires registration but did not request any registration property: + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/config_refresh.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_refresh.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + + <para> + The Consumer for the <literal>oracle</literal> Producer should now be available as a portlet provider and be ready to be used. + </para> + + <para> + Assuming that the producer required a value for an <literal>email</literal> registration property, JBoss Enterprise Portal Platform's WSRP consumer will report that some information was missing: + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/config_missing.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_missing.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + + <note> + <title>Values</title> + <para> - This screen presents all the configured consumers associated with their status and possible actions on them. - </para> - <para> - A Consumer can be active or inactive. Activating a Consumer means that it is ready to act as a portlet provider. - </para> - <para> - Note also that a Consumer can be marked as requiring <emphasis>refresh</emphasis>, which means that the information held about it might not be up to date. Refreshing it from the remote Producer will update this information. - </para> - <para> - This can happen for several reasons: the service description for that remote Producer has not been fetched yet, the cached version has expired or modifications have been made to the configuration that could potentially invalidate it, thus requiring re-validation of the information. - </para> - <para> - To create a new Consumer: - </para> - <procedure id="proc-Reference_Guide_eXo_JCR_1.14-Using_the_Configuration_portlet-Creating_a_Consumer"> - <title><emphasis role="bold">Creating a Consumer</emphasis></title> - <step> - <para> - Type "<literal> oracle</literal>" into the "<emphasis role="bold">Create a consumer named:</emphasis>" field. - </para> - - </step> - <step> - <para> - Click on "<emphasis role="bold">Create consumer</emphasis>" to create a new Consumer called <literal>oracle</literal>. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/config_create.png" format="PNG" scale="100" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_create.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </step> - <step> - <para> - In the next form, set the cache expiration value to <parameter>300</parameter> seconds. - </para> - - </step> - <step> - <para> - Leave the default timeout value for web services (WS) operations. - </para> - - </step> - <step> - <para> - Enter the WSDL URL for the producer in the text field. - </para> - - </step> - <step> - <para> - Press the "Refresh &amp; Save" button: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/config_wsdl.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_wsdl.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </step> - - </procedure> - - <para> - This will retrieve the service description associated with the Producer which WSRP interface is described by the WSDL file found at the URL entered. - </para> - <para> - In this case, querying the service description will show that the Producer requires registration but did not request any registration property: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/config_refresh.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_refresh.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <para> - The Consumer for the <literal>oracle</literal> Producer should now be available as a portlet provider and be ready to be used. - </para> - <para> - Assuming that the producer required a value for an <literal>email</literal> registration property, JBoss Enterprise Portal Platform's WSRP consumer will report that some information was missing: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/config_missing.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_missing.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <note> - <title>Values</title> - <para> - As at this release there is no automated way to learn about which possible values (if any) are expected by the remote Producer. Possible values may be indicated in the registration property description but this is not always the case. Refer to the specific Producer's documentation. - </para> - - </note> - <para> - Enter an address for the registration property (&quot;&lt;literal&gt;example(a)example.com&lt;/literal&gt;&quot;) and press "<emphasis role="bold">Save &amp; Refresh</emphasis>" once more: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/config_end.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_end.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </section> + As at this release there is no automated way to learn about which possible values (if any) are expected by the remote Producer. Possible values may be indicated in the registration property description but this is not always the case. Refer to the specific Producer's documentation. + </para> + </note> + + <para> + Enter an address for the registration property (&quot;&lt;literal&gt;example(a)example.com&lt;/literal&gt;&quot;) and press "<emphasis role="bold">Save &amp; Refresh</emphasis>" once more: + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/config_end.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_end.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + </section> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-Using_XML"> + <title>Using XML</title> - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-Using_XML"> - <title>Using XML</title> - <para> - Although using the WSRP Configuration portlet to configure Consumers is recommended, the WSRP component provides an alternative way to configure consumers. - </para> - <para> - This is done by editing the XML file located at <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-consumer-<replaceable>WSRP_VERSION</replaceable>.jar/conf/wsrp-consumers-config.xml</filename>. - </para> - + <para> + Although using the WSRP Configuration portlet to configure Consumers is recommended, the WSRP component provides an alternative way to configure consumers. + </para> + + <para> + This is done by editing the XML file located at <filename>extension-component-<replaceable>&lt;PORTAL_VERSION&gt;</replaceable>.jar/conf/wsrp-consumers-config.xml</filename> in your JBoss AS deploy directory. + </para> <programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default257.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - The file as shown above specifies access to two producers: <literal>self</literal>, which consumes JBoss Enterprise Portal Platform's own WSRP producer (albeit in a version that assumes that the producer requires a value for an <literal>email</literal> registration property), and <literal>oracle</literal>, which consumes Oracle's public producer, both in configurations as shown in the procedure above. - </para> - <note> - <para> - An XML Schema defining which elements are available to configure Consumers via XML can be found in <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_consumer_1_0.xsd </filename> - </para> - - </note> - + <para> + The file as shown above specifies access to two producers: <literal>self</literal>, which consumes JBoss Enterprise Portal Platform's own WSRP producer (albeit in a version that assumes that the producer requires a value for an <literal>email</literal> registration property), and <literal>oracle</literal>, which consumes Oracle's public producer, both in configurations as shown in the procedure above. + </para> + + <note> + <para> + An XML Schema defining which elements are available to configure Consumers via XML can be found in <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_consumer_1_0.xsd </filename> + </para> + </note> </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-Adding_remote_portlets_to_categories"> - <title>Adding remote portlets to categories</title> - <para> - Clicking on the Portlet link in the Application Registry will now show the remote portlets in the <emphasis role="bold">REMOTE</emphasis> tab in the left column: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/remote_portlets.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/remote_portlets.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <para> - These portlets are available to be used as regular portlets: they can be used in categories and added to pages. Using the Import Applications functionality will also automatically import them into categories based on the keywords they define. - </para> - <para> - More specifically, to add a <emphasis>WSRP</emphasis> portlet to a category, select <literal>wsrp</literal> in the Application Type drop-down menu: - </para> - <mediaobject> - <imageobject> - <imagedata align="center" fileref="images/WSRP/remote_portlets_category.png" format="PNG" scalefit="1" valign="middle" /> - </imageobject> - - </mediaobject> - + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-Adding_remote_portlets_to_categories"> + <title>Adding remote portlets to categories</title> + + <para> + Clicking on the Portlet link in the Application Registry will now show the remote portlets in the <emphasis role="bold">REMOTE</emphasis> tab in the left column: + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/remote_portlets.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/remote_portlets.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + + <para> + These portlets are available to be used as regular portlets: they can be used in categories and added to pages. Using the Import Applications functionality will also automatically import them into categories based on the keywords they define. + </para> + + <para> + More specifically, to add a <emphasis>WSRP</emphasis> portlet to a category, select <literal>wsrp</literal> in the Application Type drop-down menu: + </para> + + <mediaobject> + <imageobject> + <imagedata align="center" fileref="images/WSRP/remote_portlets_category.png" format="PNG" scalefit="1" valign="middle" /> + </imageobject> + </mediaobject> </section> - - - </section> - + </section> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Consuming_Remote_WSRP_Portlets-Configuring_Access_to_Remote_Producers_via_XML"> <title>Configuring Access to Remote Producers via XML</title> - <para> - Again, configuring consumers via XML is done by editing <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-consumer-<replaceable>WSRP_VERSION</replaceable>.jar/conf/wsrp-consumers-config.xml</filename>. + + <para> + Again, configuring consumers via XML is done by editing <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-consumer-<replaceable>WSRP_VERSION</replaceable>.jar/conf/wsrp-consumers-config.xml</filename>. </para> - <note> - <title>XML Elements</title> - <para> - An XML Schema defining which elements are available to configure Consumers via XML can be found in <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_consumer_1_0.xsd </filename> - </para> - + + <note> + <title>XML Elements</title> + + <para> + An XML Schema defining which elements are available to configure Consumers via XML can be found in <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_consumer_1_0.xsd </filename> + </para> </note> - <note> - <title>The Consumer Configuration file</title> - <para> - It is important to understand how the XML Consumers configuration file is processed. It is read the first time the WSRP service starts and the associated information is then put under control of the JCR (Java Content Repository). - </para> - <para> - Subsequent launches of the WSRP service will use the JCR-stored information for all producers that are already known to JBoss Enterprise Portal Platform. More specifically, the <filename>wsrp-consumers-config.xml</filename> file is scanned for producer identifiers. Any identifier that is already known will be bypassed and the JCR information associated with this remote producer will be used. - </para> - <para> - The information defined at the XML level is only processed for producer definition for which no information is already present in the JCR. - </para> - <para> - Therefore, to delete a Producer configuration, the associated information in the database must be deleted (this can be accomplished using the configuration portlet as shown in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-The_Configuration_Portlet" />). - </para> - <para> - The associated information in <filename>wsrp-consumers-config.xml</filename> (if such information exists) must also be removed, otherwise the producer will be re-created the next time the WSRP is launched. - </para> - + + <note> + <title>The Consumer Configuration file</title> + + <para> + It is important to understand how the XML Consumers configuration file is processed. It is read the first time the WSRP service starts and the associated information is then put under control of the JCR (Java Content Repository). + </para> + + <para> + Subsequent launches of the WSRP service will use the JCR-stored information for all producers that are already known to JBoss Enterprise Portal Platform. More specifically, the <filename>wsrp-consumers-config.xml</filename> file is scanned for producer identifiers. Any identifier that is already known will be bypassed and the JCR information associated with this remote producer will be used. + </para> + + <para> + The information defined at the XML level is only processed for producer definition for which no information is already present in the JCR. + </para> + + <para> + Therefore, to delete a Producer configuration, the associated information in the database must be deleted (this can be accomplished using the configuration portlet as shown in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-The_Configuration_Portlet" /> ). + </para> + + <para> + The associated information in <filename>wsrp-consumers-config.xml</filename> (if such information exists) must also be removed, otherwise the producer will be re-created the next time the WSRP is launched. + </para> </note> - <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_Access_to_Remote_Producers_via_XML-Required_Configuration_Information"> - <title>Required Configuration Information</title> - <para> - The following information needs to be provided to configure access to a remote Producer: - </para> - <orderedlist> - <listitem> - <para> - An identifier must be provided for the producer being configured so that it can be referred to later. This is done in the mandatory <literal>id</literal> attribute of the <literal>&lt;wsrp-producer&gt;</literal> element. - </para> - - </listitem> - <listitem> - <para> - JBoss Enterprise Portal Platform also needs to know about the remote Producer's endpoints to be able to connect to the remote web services and perform WSRP invocations. Use the <literal>&lt;endpoint-wsdl-url&gt;</literal> element to specify the URL for the WSDL description of the remote WSRP service. - </para> - - </listitem> - - </orderedlist> - <para> - Both the <literal>id</literal> attribute and <literal>&lt;endpoint-wsdl-url&gt;</literal> elements are required for a functional remote producer configuration. - </para> - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_Access_to_Remote_Producers_via_XML-Optional_Configuration"> - <title>Optional Configuration</title> - <para> - It is also possible to provide additional configuration, which, in some cases, might be important to establish a proper connection to the remote producer. - </para> - <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Optional_Configuration-Optional_Configurations"> - <title>Optional Configurations</title> - <varlistentry> - <term>Caching</term> - <listitem> - <para> - To prevent unnecessary traffic between the local consumer and the remote producer, it is possible to cache some of the information sent by the producer (such as the list of offered portlets) for a given duration. - </para> - <para> - The rate at which the information is refreshed is defined by the <literal>expiration-cache</literal> attribute of the <literal>&lt;wsrp-producer&gt;</literal> element (in seconds). - </para> - <para> - For example; providing a value of <literal>120</literal> for expiration-cache means that the producer information will not be refreshed for 2 minutes after it has been accessed. If no value is provided, JBoss Enterprise Portal Platform will always access the remote producer regardless of whether the remote information has changed or not. - </para> - <para> - Since, in most instances, the information provided by the producer does not change often, use of this caching facility to minimize bandwidth usage is recommended. - </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>WS Timeout</term> - <listitem> - <para> - It is also possible to define a timeout after which WS operations are considered as failed. This is helpful to avoid blocking the WSRP service, as it waits on a service that does not answer. - </para> - <para> - Use the <literal>ws-timeout</literal> attribute of the <literal>&lt;wsrp-producer&gt;</literal> element to specify how many milliseconds the WSRP service will wait for a response from the remote producer before timing out. - </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Pre-registration information</term> - <listitem> - <para> - Some producers require consumers to register with them before authorizing them to access their offered portlets. If known, some registration information can be provided in the producer configuration beforehand, so that the consumer can register with the remote producer when required. - </para> - <note> - <para> - Only simple String properties are supported. It is not possible to configure complex registration data. However, this should be sufficient for most cases. - </para> - - </note> - <para> - This pre-registration configuration is done via the <literal>&lt;registration-data&gt;</literal> element. - </para> - <para> - If the remote producer does not require any registration properties, only an empty <literal>&lt;registration-data&gt;</literal> element need be provided, as JBoss Enterprise Portal Platform can generate the mandatory information. - </para> - <para> - Values for the registration properties required by the remote producer can be provided via <literal>&lt;property&gt;</literal> elements. Refer to the example below for more details. - </para> - <para> - Additionally, the default consumer name automatically provided by JBoss Enterprise Portal Platform can be overridden via the <literal>&lt;consumer-name&gt;</literal> element. When providing a consumer name, please remember that it should uniquely identify your consumer. - </para> - - </listitem> - - </varlistentry> - - </variablelist> - - </section> - - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Consuming_Remote_WSRP_Portlets-Examples"> - <title>Examples</title> - <para> - This is the configuration of the <literal>selfv1</literal> and <literal>selfv2</literal> consumers as found in <filename>default-wsrp.xml</filename> with a cache expiring every five minutes and with a 30 second timeout for web service operations: - </para> -<programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default258.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - This is an example of a WSRP descriptor with registration data and cache expiring every minute: - </para> - -<programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default259.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - - </section> - - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consumers_Maintenance"> - <title>Consumers Maintenance</title> - <section id="sect-Reference_Guide_eXo_JCR_1.14-Consumers_Maintenance-Modifying_a_Currently_Held_Registration"> - <title>Modifying a Currently Held Registration</title> - <section id="sect-Reference_Guide_eXo_JCR_1.14-Modifying_a_Currently_Held_Registration-Registration_Modification_for_Service_Upgrade"> - <title>Registration Modification for Service Upgrade</title> - <para> - Producers often offer several levels of service depending on consumers' subscription levels (for example). This is implemented at the WSRP level with the registration concept: producers can assert which level of service to provide to consumers based on the values of given registration properties. - </para> - <para> - There may also be cases where the registration information has changed and must be updated. For example, the producer required you to provide a valid email and the previous email address is not valid anymore and needs to be updated. - </para> - <para> - Therefore at times it may be necessary to modify the registration that sets the service agreement between a consumer and a producer. - </para> - <para> - For example; the producer requiring an email that was configured in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-The_Configuration_Portlet" />. In that case the producer was requiring registration and required a value to be provided for the <literal>email</literal> property. - </para> - <para> - To update the email address that was provided, the remote producer must be informed that some registration data has been modified. - </para> - <para> - The following procedure assumes access to the producer has been configured as previously described. - </para> - <procedure> - <step> - <para> - Go to the configuration screen for the <literal>self</literal> producer and change the value of <literal>email</literal> to <literal&gt;foo(a)example.com&lt;/literal&gt; instead of <literal&gt;example(a)example.com&lt;/literal&gt;: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/modify_reg_start.png" format="PNG" scale="100" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_start.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </step> - <step> - <para> - Click on "<emphasis role="bold">Update properties</emphasis>" to save the change. A "<emphasis role="bold">Modify registration</emphasis>" button should now appear to let you send this new data to the remote producer: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/modify_reg_modify.png" format="PNG" scale="100" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_modify.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </step> - <step> - <para> - Click on <emphasis role="bold">Modify registration</emphasis> and, if the updated registration details have been accepted by the remote producer the following should appear: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/modify_reg_end.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_end.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </step> - - </procedure> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_Access_to_Remote_Producers_via_XML-Required_Configuration_Information"> + <title>Required Configuration Information</title> - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Modifying_a_Currently_Held_Registration-Registration_Modification_on_Producer_Error"> - <title>Registration Modification on Producer Error</title> - <para> - If a Producer administrator changes the requirements for registered consumers, invoking operations on the producer may fail with an <exceptionname>OperationFailedFault</exceptionname>. JBoss Enterprise Portal Platform will attempt to assist in these cases. - </para> - <para> - This section will discuss an example using the <literal>self</literal> producer. - </para> - <para> - Assuming that the registration requires a valid value for an <literal>email</literal> registration property (as has been shown) the configuration screen for this producer should show: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/config_self.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_self.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <para> - If the administrator of the producer now requires an additional value to be provided for a <literal>name</literal> registration property operations with this producer will fail. - </para> - <para> - If a registration modification is required, go to the configuration screen for this remote producer and refresh the information held by the consumer by pressing "<emphasis role="bold">Refresh &amp; Save</emphasis>": - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/modify_reg_self.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_self.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <para> - The configuration screen now shows the currently held registration information and the expected information from the producer. - </para> - <para> - Enter a value for the <literal>name</literal> property and then click on "<emphasis role="bold">Modify registration</emphasis>". If the producer accepts the new registration data, the following screen will appear: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/modify_reg_self_end.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_self_end.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <note> - <title><emphasis role="bold">JBoss Enterprise Portal Platform &VY; and WSRP 1 Exceptions</emphasis></title> + <para> + The following information needs to be provided to configure access to a remote Producer: + </para> + + <orderedlist> + <listitem> <para> - In WSRP 1, it can be difficult to ascertain what caused an <exceptionname>OperationFailedFault</exceptionname> as it is a generic exception returned by producers during a failed method invocation. - </para> + An identifier must be provided for the producer being configured so that it can be referred to later. This is done in the mandatory <literal>id</literal> attribute of the <literal>&lt;wsrp-producer&gt;</literal> element. + </para> + </listitem> + + <listitem> <para> - An <exceptionname>OperationFailedFault</exceptionname> failure can be caused by several different reasons, one of them being a request to modify the registration data. - </para> - <para> - In these instances examining the log files may assist in gathering more information about the problem. - </para> - <para> - WSRP 2 introduces an exception that is specific to a request to modify registrations which reduces the ambiguity that currently exists. - </para> - - </note> - + JBoss Enterprise Portal Platform also needs to know about the remote Producer's endpoints to be able to connect to the remote web services and perform WSRP invocations. Use the <literal>&lt;endpoint-wsdl-url&gt;</literal> element to specify the URL for the WSDL description of the remote WSRP service. + </para> + </listitem> + </orderedlist> + + <para> + Both the <literal>id</literal> attribute and <literal>&lt;endpoint-wsdl-url&gt;</literal> elements are required for a functional remote producer configuration. + </para> </section> - - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Consumers_Maintenance-Consumer_Operations"> - <title>Consumer Operations</title> - <para> - Several operations are available from the consumer list view of the WSRP configuration portlet: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/consumer_operations.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/consumer_operations.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <para> - The available operations are: - </para> - <variablelist> - <varlistentry> - <term>Configure</term> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_Access_to_Remote_Producers_via_XML-Optional_Configuration"> + <title>Optional Configuration</title> + + <para> + It is also possible to provide additional configuration, which, in some cases, might be important to establish a proper connection to the remote producer. + </para> + + <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Optional_Configuration-Optional_Configurations"> + <title>Optional Configurations</title> + + <varlistentry> + <term>Caching</term> + <listitem> <para> - Displays the consumer details and allows user to edit them. + To prevent unnecessary traffic between the local consumer and the remote producer, it is possible to cache some of the information sent by the producer (such as the list of offered portlets) for a given duration. </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Refresh</term> - <listitem> + <para> - Forces the consumer to retrieve the service description from the remote producer to refresh the local information (such as offered portlets, registration information). + The rate at which the information is refreshed is defined by the <literal>expiration-cache</literal> attribute of the <literal>&lt;wsrp-producer&gt;</literal> element (in seconds). </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Activate/Deactivate</term> - <listitem> + <para> - Activates or deactivates a consumer, governing whether it will be available to provide portlets and receive portlet invocations. + For example; providing a value of <literal>120</literal> for expiration-cache means that the producer information will not be refreshed for 2 minutes after it has been accessed. If no value is provided, JBoss Enterprise Portal Platform will always access the remote producer regardless of whether the remote information has changed or not. </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Register/De-register</term> - <listitem> + <para> - Registers or de-registers a consumer based on whether registration is required and/or acquired. + Since, in most instances, the information provided by the producer does not change often, use of this caching facility to minimize bandwidth usage is recommended. </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Delete</term> + </listitem> + </varlistentry> + + <varlistentry> + <term>WS Timeout</term> + <listitem> <para> - Destroys the consumer, after de-registering it if it was registered. + It is also possible to define a timeout after which WS operations are considered as failed. This is helpful to avoid blocking the WSRP service, as it waits on a service that does not answer. </para> - - </listitem> - - </varlistentry> - - </variablelist> - <formalpara id="form-Reference_Guide_eXo_JCR_1.14-Consumer_Operations-Additional_Functionalities_in_WSRP_2.0"> - <title><emphasis role="bold">Additional Functionalities in WSRP 2.0</emphasis></title> - <para> - In addition to those listed above, the WSRP 2.0 implementation in JBoss Enterprise Portal Platform &VY; also includes the following functions: - </para> - - </formalpara> - <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Consumer_Operations-Additional_Functions"> - <title>Additional Functions:</title> - <varlistentry> - <term>Export</term> - <listitem> + <para> - Exports some or all of the consumer's portlets to be able to later import them in a different context + Use the <literal>ws-timeout</literal> attribute of the <literal>&lt;wsrp-producer&gt;</literal> element to specify how many milliseconds the WSRP service will wait for a response from the remote producer before timing out. </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Import</term> + </listitem> + </varlistentry> + + <varlistentry> + <term>Pre-registration information</term> + <listitem> <para> - Imports some or all of previously exported portlets. + Some producers require consumers to register with them before authorizing them to access their offered portlets. If known, some registration information can be provided in the producer configuration beforehand, so that the consumer can register with the remote producer when required. </para> - - </listitem> - - </varlistentry> - - </variablelist> - <section id="sect-Reference_Guide_eXo_JCR_1.14-Consumer_Operations-Importing_and_Exporting_Portlets"> - <title><emphasis role="bold">Importing and Exporting Portlets</emphasis></title> - <para> - Import and export are new functionalities added in WSRP 2. - </para> - <para> - Exporting a portlet allows a consumer to get an opaque representation of the portlet which can then be use by the corresponding import operation to reconstitute it. - </para> - <para> - This is mostly used in migration scenarios during batch operations. Since JBoss Enterprise Portal Platform does not currently support automated migration of portal data, the functionality provided as part of WSRP 2 is necessarily less complete than it could be with full portal support. - </para> - <para> - The import/export implementation in JBoss Enterprise Portal Platform allows users to export portlets from a given consumer and then import them back to replace existing portlets assigned to windows on pages by the previously exported portlets. - </para> - <procedure> - <title></title> - <step> + + <note> + <para> + Only simple String properties are supported. It is not possible to configure complex registration data. However, this should be sufficient for most cases. + </para> + </note> + <para> - Click on the "<guilabel>Export</guilabel>" action for a given consumer to display the list of portlets currently made available by this specific consumer. An example list is shown below: + This pre-registration configuration is done via the <literal>&lt;registration-data&gt;</literal> element. </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/export_portlet_list.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/export_portlet_list.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </step> - <step> + <para> - Once portlets have been selected, they can be exported by clicking on the "<guilabel>Export</guilabel>" button. This makes them available for later import: + If the remote producer does not require any registration properties, only an empty <literal>&lt;registration-data&gt;</literal> element need be provided, as JBoss Enterprise Portal Platform can generate the mandatory information. </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/export_done.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/export_done.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </step> - <step> + <para> - The portlets can be re-imported directly by pressing the "<guilabel>Use for import</guilabel>" button or, on the Consumers list page, using the "<guilabel>Import</guilabel>" action for a given consumer. + Values for the registration properties required by the remote producer can be provided via <literal>&lt;property&gt;</literal> elements. Refer to the example below for more details. </para> - <para> - The example below assumes that the second option has been used and that several sets of previously exported portlets are available to import from. After clicking the action link, a screen similar to the one below should appear: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/export_list.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/export_list.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <para> - This screen presents the list of available exports with available operations for each. - </para> - <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Importing_and_Exporting_Portlets-Operations"> - <title>Operations:</title> - <varlistentry> - <term>View</term> - <listitem> - <para> - Displays the export details as previously seen when the export was first performed. - </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Delete</term> - <listitem> - <para> - Deletes the selected export, asking you for confirmation first. - </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Use for import</term> - <listitem> - <para> - Selects the export to import portlets from. - </para> - - </listitem> - - </varlistentry> - - </variablelist> - - </step> - <step> + <para> - Once you have selected an export to import from, you will see a screen similar to the one below: + Additionally, the default consumer name automatically provided by JBoss Enterprise Portal Platform can be overridden via the <literal>&lt;consumer-name&gt;</literal> element. When providing a consumer name, please remember that it should uniquely identify your consumer. </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/import_start.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/import_start.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <para> - The screen displays the list of available exported portlets for the previously selected export. You can select which portlet you want to import by checking the checkbox next to its name. - </para> - - </step> - <step> - <para> - Select the content of which window the imported portlet will replace. This process is done in three steps: - </para> - <para> - This example assumes that you have the following page called <literal>page1</literal> which contains two windows called <literal>NetUnity WSRP 2 Interop - Cache Markup (remote)</literal> and <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal>, as shown below: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/import_original_page.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/import_original_page.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <para> - In this example, we want to replace the content of the <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> with the content of the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> portlet that was previously exported. - </para> - <procedure> - <title></title> - <step> - <para> - Check the box next to the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> portlet name to indicate that you want to import its data. - </para> - - </step> - <step> - <para> - Select <literal>page1</literal> in the list of available pages. The screen will then refresh to display the list of available windows on that page, similar to the image below: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/import_selected_page.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/import_selected_page.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <note> - <title>Note</title> - <para> - At this point, you still need to select which window content you want to replace before being able to complete the import operation - </para> - - </note> - - </step> - <step> - <para> - Select the <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> window, which enables the "<guilabel>Import</guilabel>" button. This indicates that all the necessary data to perform the import is available. - </para> - - </step> - <step> - <para> - Click the "<guilabel>Import</guilabel>" button. A screen similar to the one below will appear: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/import_success.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/import_success.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </step> - - </procedure> - - - </step> - <step> - <para> - The <literal>page1</literal> page should now show that the content of <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> window has been replaced by the content of the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> imported portlet and that the window has been renamed appropriately. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/import_modified_page.png" format="PNG" scale="120" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/import_modified_page.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </step> - - </procedure> + </listitem> + </varlistentry> + </variablelist> + </section> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Consuming_Remote_WSRP_Portlets-Examples"> + <title>Examples</title> + + <para> + This is the configuration of the <literal>selfv1</literal> and <literal>selfv2</literal> consumers as found in <filename>default-wsrp.xml</filename> with a cache expiring every five minutes and with a 30 second timeout for web service operations: + </para> +<programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default258.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + This is an example of a WSRP descriptor with registration data and cache expiring every minute: + </para> +<programlisting language="XML" role="XML"><xi:include href="../extras/WSRP/default259.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </section> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consumers_Maintenance"> + <title>Consumers Maintenance</title> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Consumers_Maintenance-Modifying_a_Currently_Held_Registration"> + <title>Modifying a Currently Held Registration</title> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Modifying_a_Currently_Held_Registration-Registration_Modification_for_Service_Upgrade"> + <title>Registration Modification for Service Upgrade</title> - + <para> + Producers often offer several levels of service depending on consumers' subscription levels (for example). This is implemented at the WSRP level with the registration concept: producers can assert which level of service to provide to consumers based on the values of given registration properties. + </para> + + <para> + There may also be cases where the registration information has changed and must be updated. For example, the producer required you to provide a valid email and the previous email address is not valid anymore and needs to be updated. + </para> + + <para> + Therefore at times it may be necessary to modify the registration that sets the service agreement between a consumer and a producer. + </para> + + <para> + For example; the producer requiring an email that was configured in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-The_Configuration_Portlet" /> . In that case the producer was requiring registration and required a value to be provided for the <literal>email</literal> property. + </para> + + <para> + To update the email address that was provided, the remote producer must be informed that some registration data has been modified. + </para> + + <para> + The following procedure assumes access to the producer has been configured as previously described. + </para> + + <procedure> + <step><para> + Go to the configuration screen for the <literal>self</literal> producer and change the value of <literal>email</literal> to <literal&gt;foo(a)example.com&lt;/literal&gt; instead of <literal&gt;example(a)example.com&lt;/literal&gt;: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/modify_reg_start.png" format="PNG" scale="100" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_start.png" format="PNG" width="444" /> + </imageobject> + </mediaobject></step> + + <step><para> + Click on "<emphasis role="bold">Update properties</emphasis>" to save the change. A "<emphasis role="bold">Modify registration</emphasis>" button should now appear to let you send this new data to the remote producer: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/modify_reg_modify.png" format="PNG" scale="100" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_modify.png" format="PNG" width="444" /> + </imageobject> + </mediaobject></step> + + <step><para> + Click on <emphasis role="bold">Modify registration</emphasis> and, if the updated registration details have been accepted by the remote producer the following should appear: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/modify_reg_end.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_end.png" format="PNG" width="444" /> + </imageobject> + </mediaobject></step> + </procedure> </section> - - - </section> - + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Modifying_a_Currently_Held_Registration-Registration_Modification_on_Producer_Error"> + <title>Registration Modification on Producer Error</title> + + <para> + If a Producer administrator changes the requirements for registered consumers, invoking operations on the producer may fail with an <literal>OperationFailedFault</literal>. JBoss Enterprise Portal Platform will attempt to assist in these cases. + </para> + + <para> + This section will discuss an example using the <literal>self</literal> producer. + </para> + + <para> + Assuming that the registration requires a valid value for an <literal>email</literal> registration property (as has been shown) the configuration screen for this producer should show: + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/config_self.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_self.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + + <para> + If the administrator of the producer now requires an additional value to be provided for a <literal>name</literal> registration property operations with this producer will fail. + </para> + + <para> + If a registration modification is required, go to the configuration screen for this remote producer and refresh the information held by the consumer by pressing "<emphasis role="bold">Refresh &amp; Save</emphasis>": + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/modify_reg_self.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_self.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + + <para> + The configuration screen now shows the currently held registration information and the expected information from the producer. + </para> + + <para> + Enter a value for the <literal>name</literal> property and then click on "<emphasis role="bold">Modify registration</emphasis>". If the producer accepts the new registration data, the following screen will appear: + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/modify_reg_self_end.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/modify_reg_self_end.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + + <note> + <title><emphasis role="bold">JBoss Enterprise Portal Platform &VY; and WSRP 1 Exceptions</emphasis></title> + + <para> + In WSRP 1, it can be difficult to ascertain what caused an <literal> OperationFailedFault </literal> as it is a generic exception returned by producers during a failed method invocation. + </para> + + <para> + An <literal>OperationFailedFault</literal> failure can be caused by several different reasons, one of them being a request to modify the registration data. + </para> + + <para> + In these instances examining the log files may assist in gathering more information about the problem. + </para> + + <para> + WSRP 2 introduces an exception that is specific to a request to modify registrations which reduces the ambiguity that currently exists. + </para> + </note> + </section> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Consumers_Maintenance-Consumer_Operations"> + <title>Consumer Operations</title> + + <para> + Several operations are available from the consumer list view of the WSRP configuration portlet: + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/consumer_operations.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/consumer_operations.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + + <para> + The available operations are: + </para> + + <variablelist> + <varlistentry> + <term>Configure</term> + + <listitem> + <para> + Displays the consumer details and allows user to edit them. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Refresh</term> + + <listitem> + <para> + Forces the consumer to retrieve the service description from the remote producer to refresh the local information (such as offered portlets, registration information). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Activate/Deactivate</term> + + <listitem> + <para> + Activates or deactivates a consumer, governing whether it will be available to provide portlets and receive portlet invocations. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Register/De-register</term> + + <listitem> + <para> + Registers or de-registers a consumer based on whether registration is required and/or acquired. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Delete</term> + + <listitem> + <para> + Destroys the consumer, after de-registering it if it was registered. + </para> + </listitem> + </varlistentry> + </variablelist> + + <formalpara id="form-Reference_Guide_eXo_JCR_1.14-Consumer_Operations-Additional_Functionalities_in_WSRP_2.0"> + <title><emphasis role="bold">Additional Functionalities in WSRP 2.0</emphasis></title> <para> + In addition to those listed above, the WSRP 2.0 implementation in JBoss Enterprise Portal Platform &VY; also includes the following functions: + </para> + </formalpara> + + <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Consumer_Operations-Additional_Functions"> + <title>Additional Functions:</title> + + <varlistentry> + <term>Export</term> + + <listitem> + <para> + Exports some or all of the consumer's portlets to be able to later import them in a different context + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Import</term> + + <listitem> + <para> + Imports some or all of previously exported portlets. + </para> + </listitem> + </varlistentry> + </variablelist> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Consumer_Operations-Importing_and_Exporting_Portlets"> + <title><emphasis role="bold">Importing and Exporting Portlets</emphasis></title> + + <para> + Import and export are new functionalities added in WSRP 2. + </para> + + <para> + Exporting a portlet allows a consumer to get an opaque representation of the portlet which can then be use by the corresponding import operation to reconstitute it. + </para> + + <para> + This is mostly used in migration scenarios during batch operations. Since JBoss Enterprise Portal Platform does not currently support automated migration of portal data, the functionality provided as part of WSRP 2 is necessarily less complete than it could be with full portal support. + </para> + + <para> + The import/export implementation in JBoss Enterprise Portal Platform allows users to export portlets from a given consumer and then import them back to replace existing portlets assigned to windows on pages by the previously exported portlets. + </para> + + <procedure> + <title></title> + + <step><para> + Click on the "<guilabel>Export</guilabel>" action for a given consumer to display the list of portlets currently made available by this specific consumer. An example list is shown below: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/export_portlet_list.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/export_portlet_list.png" format="PNG" width="444" /> + </imageobject> + </mediaobject></step> + + <step><para> + Once portlets have been selected, they can be exported by clicking on the "<guilabel>Export</guilabel>" button. This makes them available for later import: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/export_done.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/export_done.png" format="PNG" width="444" /> + </imageobject> + </mediaobject></step> + + <step><para> + The portlets can be re-imported directly by pressing the "<guilabel>Use for import</guilabel>" button or, on the Consumers list page, using the "<guilabel>Import</guilabel>" action for a given consumer. + </para> <para> + The example below assumes that the second option has been used and that several sets of previously exported portlets are available to import from. After clicking the action link, a screen similar to the one below should appear: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/export_list.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/export_list.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> <para> + This screen presents the list of available exports with available operations for each. + </para> <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Importing_and_Exporting_Portlets-Operations"> + <title>Operations:</title> + + <varlistentry> + <term>View</term> + + <listitem> + <para> + Displays the export details as previously seen when the export was first performed. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Delete</term> + + <listitem> + <para> + Deletes the selected export, asking you for confirmation first. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Use for import</term> + + <listitem> + <para> + Selects the export to import portlets from. + </para> + </listitem> + </varlistentry> + </variablelist></step> + + <step><para> + Once you have selected an export to import from, you will see a screen similar to the one below: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/import_start.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/import_start.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> <para> + The screen displays the list of available exported portlets for the previously selected export. You can select which portlet you want to import by checking the checkbox next to its name. + </para></step> + + <step><para> + Select the content of which window the imported portlet will replace. This process is done in three steps: + </para> <para> + This example assumes that you have the following page called <literal>page1</literal> which contains two windows called <literal>NetUnity WSRP 2 Interop - Cache Markup (remote)</literal> and <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal>, as shown below: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/import_original_page.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/import_original_page.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> <para> + In this example, we want to replace the content of the <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> with the content of the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> portlet that was previously exported. + </para> <procedure> + <title></title> + + <step><para> + Check the box next to the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> portlet name to indicate that you want to import its data. + </para></step> + + <step><para> + Select <literal>page1</literal> in the list of available pages. The screen will then refresh to display the list of available windows on that page, similar to the image below: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/import_selected_page.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/import_selected_page.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> <note> + <title>Note</title> + + <para> + At this point, you still need to select which window content you want to replace before being able to complete the import operation + </para> + </note></step> + + <step><para> + Select the <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> window, which enables the "<guilabel>Import</guilabel>" button. This indicates that all the necessary data to perform the import is available. + </para></step> + + <step><para> + Click the "<guilabel>Import</guilabel>" button. A screen similar to the one below will appear: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/import_success.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/import_success.png" format="PNG" width="444" /> + </imageobject> + </mediaobject></step> + </procedure></step> + + <step><para> + The <literal>page1</literal> page should now show that the content of <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> window has been replaced by the content of the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> imported portlet and that the window has been renamed appropriately. + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/import_modified_page.png" format="PNG" scale="120" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="150mm" fileref="images/WSRP/import_modified_page.png" format="PNG" width="444" /> + </imageobject> + </mediaobject></step> + </procedure> + </section> + </section> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Consumers_Maintenance-Erasing_Local_Registration_Data"> <title>Erasing Local Registration Data</title> - <para> - In rare cases, it may be necessary to erase the local data without being able to de-register first. + + <para> + In rare cases, it may be necessary to erase the local data without being able to de-register first. </para> - <para> - This can occur when a consumer is registered with a producer that has been modified by its administrator to not require registration any longer. + + <para> + This can occur when a consumer is registered with a producer that has been modified by its administrator to not require registration any longer. </para> - <para> - In this scenario, local registration information can be erased from the consumer to allow it to resume interacting with the remote producer. + + <para> + In this scenario, local registration information can be erased from the consumer to allow it to resume interacting with the remote producer. </para> - <para> - To do this click on the "<emphasis role="bold">Erase local registration</emphasis>" button next to the registration context information on the consumer configuration screen: + + <para> + To do this click on the "<emphasis role="bold">Erase local registration</emphasis>" button next to the registration context information on the consumer configuration screen: </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/erase_registration.png" format="PNG" scale="80" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/erase_registration.png" format="PNG" width="444" /> - </imageobject> - + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/erase_registration.png" format="PNG" scale="80" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/erase_registration.png" format="PNG" width="444" /> + </imageobject> </mediaobject> - <warning> - <para> - This operation is dangerous as it can result in inability to interact with the remote producer if invoked when not required. The warning message below will be displayed before any data is erased. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/erase_registration_warning.png" format="PNG" scale="100" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/erase_registration_warning.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - + + <warning> + <para> + This operation is dangerous as it can result in inability to interact with the remote producer if invoked when not required. The warning message below will be displayed before any data is erased. + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/erase_registration_warning.png" format="PNG" scale="100" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/erase_registration_warning.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> </warning> - - </section> - - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Configuring_the_WSRP_Producer"> - <title>Configuring the WSRP Producer</title> + </section> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Configuring_the_WSRP_Producer"> + <title>Configuring the WSRP Producer</title> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_the_WSRP_Producer-Overview"> <title>Overview</title> - <para> - The behavior of the Portal's WSRP Producer can be configured using the WSRP administration interface, (this is the recommended method), or by editing the <filename><replaceable>WSRP_PATH</replaceable>/lib/gatein.portal.component.wsrp-<replaceable>&lt;VERSION&gt;</replaceable>-epp-GA.jar/conf/wsrp-producer-config.xml</filename> file. + + <para> + The behavior of the Portal's WSRP Producer can be configured using the WSRP administration interface, (this is the recommended method), or by editing the <filename><replaceable>WSRP_PATH</replaceable>/lib/gatein.portal.component.wsrp-<replaceable>&lt;VERSION&gt;</replaceable>-epp-GA.jar/conf/wsrp-producer-config.xml</filename> file. </para> - <para> - Several aspects can be modified with respect to whether registration is required for consumers to access the Producer's services. An XML Schema for the configuration format is available at <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_producer_1_0.xsd </filename>. + + <para> + Several aspects can be modified with respect to whether registration is required for consumers to access the Producer's services. An XML Schema for the configuration format is available at <filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-integration-api-<replaceable>WSRP_VERSION</replaceable>.jar/xsd/gatein_wsrp_producer_1_0.xsd </filename>. </para> - <para> - An alternative to editing the default <filename>wsrp-producer-config.xml</filename> file is to make a custom copy containing the required configuration options. + + <para> + An alternative to editing the default <filename>wsrp-producer-config.xml</filename> file is to make a custom copy containing the required configuration options. </para> - <para> - If a copy is used in place of the original, however, the <filename><replaceable>WSRP_PATH</replaceable>/02portal.war/WEB-INF/conf/wsrp/wsrp-configuration.xml</filename> <emphasis role="bold">must</emphasis> be updated to reference the custom file (this file defines the component <literal>WSRPServiceIntegration</literal> and contains a producer and consumer configuration location). + + <para> + If a copy is used in place of the original, however, the <filename><replaceable>WSRP_PATH</replaceable>/02portal.war/WEB-INF/conf/wsrp/wsrp-configuration.xml</filename> <emphasis role="bold">must</emphasis> be updated to reference the custom file (this file defines the component <literal>WSRPServiceIntegration</literal> and contains a producer and consumer configuration location). </para> - - </section> - + </section> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_the_WSRP_Producer-Default_Configuration"> <title>Default Configuration</title> - <para> - The default producer configuration requires that consumers register with it before providing access to its services. However it does not require any specific registration properties (excepting those mandated by the WSRP standard). + + <para> + The default producer configuration requires that consumers register with it before providing access to its services. However it does not require any specific registration properties (excepting those mandated by the WSRP standard). </para> - <para> - It does, however, require consumers to be registered before sending them a full service description. This means that the WSRP producer will not provide the list of offered portlets and other capabilities to unregistered consumers. + + <para> + It does, however, require consumers to be registered before sending them a full service description. This means that the WSRP producer will not provide the list of offered portlets and other capabilities to unregistered consumers. </para> - <para> - The producer also uses the default <classname>RegistrationPolicy</classname> paired with the default <classname>RegistrationPropertyValidator</classname>. + + <para> + The producer also uses the default <classname>RegistrationPolicy</classname> paired with the default <classname>RegistrationPropertyValidator</classname>. </para> - <para> - This allows users to customize how Portal's WSRP Producer decides whether a given registration property is valid or not (however property validators are discussed in greater detail in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Configuring_the_WSRP_Producer-Registration_Configuration" />). + + <para> + This allows users to customize how Portal's WSRP Producer decides whether a given registration property is valid or not (however property validators are discussed in greater detail in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Configuring_the_WSRP_Producer-Registration_Configuration" /> ). </para> - <para> - JBoss Enterprise Portal Platform provides a web interface to configure the producer's behavior. It can be accessed by clicking on the "<emphasis role="bold">Producer Configuration</emphasis>" tab of the "<emphasis role="bold">WSRP</emphasis>" page of the "<emphasis role="bold">admin</emphasis>" portal. + + <para> + JBoss Enterprise Portal Platform provides a web interface to configure the producer's behavior. It can be accessed by clicking on the "<emphasis role="bold">Producer Configuration</emphasis>" tab of the "<emphasis role="bold">WSRP</emphasis>" page of the "<emphasis role="bold">admin</emphasis>" portal. </para> - <para> - The default configuration should show: + + <para> + The default configuration should show: </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/producer_default.png" format="PNG" scale="110" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_default.png" format="PNG" width="444" /> - </imageobject> - + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/producer_default.png" format="PNG" scale="110" width="444" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_default.png" format="PNG" width="444" /> + </imageobject> </mediaobject> - <para> - You can specify whether or not the producer will send the full service description to unregistered consumers, and, if it requires registration, which <literal>RegistrationPolicy</literal> to use (and, if needed, which <literal>RegistrationPropertyValidator</literal>), along with required registration property description for which consumers must provide acceptable values to successfully register. + + <para> + You can specify whether or not the producer will send the full service description to unregistered consumers, and, if it requires registration, which <literal>RegistrationPolicy</literal> to use (and, if needed, which <literal>RegistrationPropertyValidator</literal>), along with required registration property description for which consumers must provide acceptable values to successfully register. </para> - <para> - WSDL URLs to access JBoss Enterprise Portal Platform's WSRP producer are now displayed in either in WSRP 1 or WSRP 2 mode. + + <para> + WSDL URLs to access JBoss Enterprise Portal Platform's WSRP producer are now displayed in either in WSRP 1 or WSRP 2 mode. </para> - - </section> - + </section> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_the_WSRP_Producer-Registration_Configuration"> <title>Registration Configuration</title> - <para> - In order to have consumers register with Portal's producer the Portal's behavior with respect to registration must be configured. + + <para> + In order to have consumers register with Portal's producer the Portal's behavior with respect to registration must be configured. </para> - <para> - Registration is optional, as are registration properties. The producer can require registration without requiring consumers to pass any registration properties as is the case in the default configuration. + + <para> + Registration is optional, as are registration properties. The producer can require registration without requiring consumers to pass any registration properties as is the case in the default configuration. </para> - <para> - The following section discusses configuring a producer's registration behavior from a blank state: + + <para> + The following section discusses configuring a producer's registration behavior from a blank state: </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/producer_blank.png" format="PNG" width="700" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_blank.png" format="PNG" width="444" /> - </imageobject> - + + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/producer_blank.png" format="PNG" width="700" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_blank.png" format="PNG" width="444" /> + </imageobject> </mediaobject> - <procedure> - <step> - <para> - To allow unregistered consumers to see the list of offered portlets, leave the first checkbox ("<emphasis role="bold">Access to full service description requires consumers to be registered.</emphasis>") unchecked. - </para> - - </step> - <step> - <para> - To specify, however, that consumers will need to be registered to be able to interact with the producer, check the second box ("<emphasis role="bold">Requires registration. Modifying this information will trigger invalidation of consumer registrations."</emphasis>). - </para> - <para> - The screen will refresh and display: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/producer_registration.png" format="PNG" width="700" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_registration.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </step> - <step> - <para> - The fully-qualified name for the <classname>RegistrationPolicy</classname> and <classname>RegistrationPropertyValidator</classname> can be specified here. The default values are acceptable. Refer to <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Registration_Configuration-Customization_of_Registration_Handling_Behavior" /> for more information. - </para> - - </step> - <step> - <para> - To add a registration property called <literal>email</literal> click "<emphasis role="bold">Add property</emphasis>" and enter the appropriate information in the fields, providing a description for the registration property that can be used by consumers to determine its purpose: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/WSRP/producer_email.png" format="PNG" width="700" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_email.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </step> - <step> - <para> - Press "Save" to record the modifications. - </para> - - </step> - + + <procedure> + <step><para> + To allow unregistered consumers to see the list of offered portlets, leave the first checkbox ("<emphasis role="bold">Access to full service description requires consumers to be registered.</emphasis>") unchecked. + </para></step> + + <step><para> + To specify, however, that consumers will need to be registered to be able to interact with the producer, check the second box ("<emphasis role="bold">Requires registration. Modifying this information will trigger invalidation of consumer registrations."</emphasis>). + </para> <para> + The screen will refresh and display: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/producer_registration.png" format="PNG" width="700" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_registration.png" format="PNG" width="444" /> + </imageobject> + </mediaobject></step> + + <step><para> + The fully-qualified name for the <classname>RegistrationPolicy</classname> and <classname>RegistrationPropertyValidator</classname> can be specified here. The default values are acceptable. Refer to <xref linkend="sect-Reference_Guide-Registration_Configuration-Customization_of_Registration_Handling_Behavior" /> for more information. + </para></step> + + <step><para> + To add a registration property called <literal>email</literal> click "<emphasis role="bold">Add property</emphasis>" and enter the appropriate information in the fields, providing a description for the registration property that can be used by consumers to determine its purpose: + </para> <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/WSRP/producer_email.png" format="PNG" width="700" /> + </imageobject> + + <imageobject role="fo"> + <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/producer_email.png" format="PNG" width="444" /> + </imageobject> + </mediaobject></step> + + <step><para> + Press "Save" to record the modifications. + </para></step> </procedure> - - <note> - <para> - At this time, only String (<literal>xsd:string</literal>) properties are supported. - </para> - + + <note> + <para> + At this time, only String (<literal>xsd:string</literal>) properties are supported. + </para> </note> - <note> - <para> - If consumers are already registered with the producer, modifying the configuration of required registration information will trigger the invalidation of held registrations, requiring consumers to modify their registration before being able to access the producer again. The consumer side of that process is documented in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Modifying_a_Currently_Held_Registration-Registration_Modification_on_Producer_Error" />. - </para> - + + <note> + <para> + If consumers are already registered with the producer, modifying the configuration of required registration information will trigger the invalidation of held registrations, requiring consumers to modify their registration before being able to access the producer again. The consumer side of that process is documented in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Modifying_a_Currently_Held_Registration-Registration_Modification_on_Producer_Error" /> . + </para> </note> - <section id="sect-Reference_Guide_eXo_JCR_1.14-Registration_Configuration-Customization_of_Registration_Handling_Behavior"> - <title>Customization of Registration Handling Behavior</title> - <para> - Registration handling behavior can be customized by users to suit their Producer needs. This is done with an implementation of the <classname>RegistrationPolicy</classname> interface. - </para> - <para> - This interface defines methods that are called by Portal's Registration service so that decisions can be made appropriately. A default registration policy that provides basic behavior is provided and should be enough for most user needs. - </para> - <para> - While the default registration policy provides default behavior for most registration-related aspects, one aspect requires specific configuration: whether a given value for a registration property is acceptable by the WSRP Producer. - </para> - <para> - This is done by plugging a <classname>RegistrationPropertyValidator</classname> into the default registration policy. This allows users to define their own validation mechanism. - </para> - <para> - Refer to the <trademark class="trade">Javadoc</trademark> for <classname>org.gatein.registration.RegistrationPolicy</classname> and <classname>org.gatein.registration.policies.RegistrationPropertyValidator</classname> for more details on what is expected of each method. - </para> - <para> - A defined registration policy is required for the producer to be correctly configured. Do this by specifying the qualified class name of the registration policy. - </para> - <para> - As it is anticipated that most users will use the default registration policy, it is possible to provide the class name of a custom property validator instead to customize the default registration policy behavior. Note that property validators are only used by the default policy. - </para> - <note> - <para> - Since the policy or the validator are defined via their class name and dynamically loaded, it is important to ensure that the identified class is available to the application server. - </para> - <para> - One way to accomplish that is to deploy the policy implementation as a JAR file in the AS instance deploy directory. - </para> - <para> - Note also that, since both policies and validators are dynamically instantiated, they must provide a default, no-argument constructor. - </para> - - </note> - + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Registration_Configuration-Customization_of_Registration_Handling_Behavior"> + <title>Customization of Registration Handling Behavior</title> + + <para> + Registration handling behavior can be customized by users to suit their Producer needs. This is done with an implementation of the <classname>RegistrationPolicy</classname> interface. + </para> + + <para> + This interface defines methods that are called by Portal's Registration service so that decisions can be made appropriately. A default registration policy that provides basic behavior is provided and should be enough for most user needs. + </para> + + <para> + While the default registration policy provides default behavior for most registration-related aspects, one aspect requires specific configuration: whether a given value for a registration property is acceptable by the WSRP Producer. + </para> + + <para> + This is done by plugging a <classname>RegistrationPropertyValidator</classname> into the default registration policy. This allows users to define their own validation mechanism. + </para> + + <para> + Refer to the <trademark class="trade">Javadoc</trademark> for <classname>org.gatein.registration.RegistrationPolicy</classname> and <classname>org.gatein.registration.policies.RegistrationPropertyValidator</classname> for more details on what is expected of each method. + </para> + + <para> + A defined registration policy is required for the producer to be correctly configured. Do this by specifying the qualified class name of the registration policy. + </para> + + <para> + As it is anticipated that most users will use the default registration policy, it is possible to provide the class name of a custom property validator instead to customize the default registration policy behavior. Note that property validators are only used by the default policy. + </para> + + <note> + <para> + Since the policy or the validator are defined via their class name and dynamically loaded, it is important to ensure that the identified class is available to the application server. + </para> + + <para> + One way to accomplish that is to deploy the policy implementation as a JAR file in the AS instance deploy directory. + </para> + + <para> + Note also that, since both policies and validators are dynamically instantiated, they must provide a default, no-argument constructor. + </para> + </note> </section> - - - </section> - + </section> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_the_WSRP_Producer-WSRP_Validation_Mode"> <title>WSRP Validation Mode</title> - <para> - The lack of conformance kit and the wording of the WSRP specification leaves room for differing interpretations, resulting in interoperability issues. It is therefore possible to encounter issues when using consumers from different vendors. + + <para> + The lack of conformance kit and the wording of the WSRP specification leaves room for differing interpretations, resulting in interoperability issues. It is therefore possible to encounter issues when using consumers from different vendors. </para> - <para> - Experience of these issues has produced a way to relax the validation that the WSRP producer performs on the data provided by consumers to help with interoperability by accepting data that would normally be invalid. + + <para> + Experience of these issues has produced a way to relax the validation that the WSRP producer performs on the data provided by consumers to help with interoperability by accepting data that would normally be invalid. </para> - <para> - Note that the our validation algorithm is only relaxed on aspects of the specification that are deemed harmless such as invalid language codes. + + <para> + Note that the our validation algorithm is only relaxed on aspects of the specification that are deemed harmless such as invalid language codes. </para> - <para> - By default, the WSRP producer is configured in strict mode. If you experience issues with a given consumer, you may attempt to relax the validation mode. Un-checking the "Use strict WSRP compliance" checkbox on the Producer configuration screen to do this. + + <para> + By default, the WSRP producer is configured in strict mode. If you experience issues with a given consumer, you may attempt to relax the validation mode. Un-checking the "Use strict WSRP compliance" checkbox on the Producer configuration screen to do this. </para> - - </section> - - - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Removing_WSRP"> - <title>Removing WSRP</title> + </section> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Removing_WSRP"> + <title>Removing WSRP</title> + <para> If you are not going to use WSRP in your JBoss Enterprise Portal Platform instance, the WSRP configuration files may be left in place. They will not adversely affect your installation. - </para> + </para> + <para> + However, if you wish to completely remove WSRP from your portal installation, remove the <filename>gatein-wsrp-integration.ear</filename> file from your application server deploy directory. + </para> +<!--<para> However, if you wish to completely remove WSRP from your portal installation, follow this procedure: </para> <procedure> @@ -1714,7 +1733,7 @@ Open the <filename>repository-configuration.xml</filename> and remove the <emphasis role="bold">WSRP</emphasis> workspace: </para> -<programlisting language="XML" role="XML">&lt;!-- WSRP --&gt; +<programlisting language="XML" role="XML"> &lt;workspace name="wsrp-system"&gt; &lt;container&gt; &lt;properties&gt; @@ -1816,11 +1835,6 @@ </step> - </procedure> - - - </section> - - -</chapter> - + </procedure> --> + </section> + </chapter>