Skip to main content

OpenPortal WSRP Project
WSRP version 2.0 milestone 1 -  User Guide

If you have not installed the WSRP version 2.0 milestone 1 binary, please follow the instructions available in the install guide before you proceed.

If you would like to keep track of future announcements and additions to the OpenPortal WSRP Project, please subscribe to the alias.

If you have questions on how to use the Open Portal WSRP Project and other comments/suggestions/requests, we urge you to join the alias.

Please report any issues that you encounter while trying wsrp version 2.0 milestone 1


What is new in this release ?

The WSRP version 2.0 milestone 1 release is the first release from the OpenPortal WSRP Project that implements the OASIS WSRP version 2.0 specification , The main intent of this release is to provide a base platform for developers to build optional and additional features that are defined in the WSRP version 2.0 specification, and demonstrate to WSRP users the basic usescases of using both the versions.

Technically since all the major features of the WSRP version 2.0 specification are defined optional, we already have a WSRP v2 implementation,  by just porting the version 1.0 implementation to 2.0 schema's and claim version 2.0 compliance. However to have a meaningful version 2.0 implementation, the optional features are required to be implemented. The OpenPortal WSRP Project addresses/implements these optional features in the subsequent milestone. Please check the WSRP version 2.0 Project page for more details.

So what exactly is there in this release ?
  1. Provides a base v2 implementation by porting v1 implementation to v2 schema's.
  2. Provides both version 2.0 and version 1.0 WSRP Producer implementation.
  3. Supports sharing of resources like registration-handle/portlet-handle across v1 and v2 WSRP Producer services.
  4. Provides both version 1.0 and 2.0 implementation of Consumer.
  5. Provides the necessary administrative interface to create a v1 or v2 Consumer.
  6. Supports backward compatibility by supporting both v1 and v2 stacks.

Note : The code base uses OASIS WSRP public review 04 schema to demonstrate the above   

Stay tuned for future announcements on optional feature implementation, Please subscribe to


User Guide

Step 1: Creating WSRP Producer

    The WSRP Producer Admin portlet provides the necessary GUI for creating and managing WSRP Producers. There exists a default producer called "SampleProducer" which is disabled.
  1. To enable this producer. Edit the producer by clicking on the link.
  2. Publish some portlets i.e move the portlets from "Unpublished Portlets" list to "Published Portlets" list.
  3. Enable the producer.
  4. Click save to save the changes.
Note : By default the above created WSRP  exports both WSRP version 1.0 and WSRP version 2.0 service in the exported WSDL. Check the WSDL URL, it'll have both v1 and v2 service exported.

Step 2 : Creating WSRP Consumer

    You can create a WSRP Consumer by using the WSRP Consumer Admin Portlet. To create a consumer you'd need to have a producer URL. You can choose to use the "SampleProducer" which we created in the above step. To create a consumer
  1. Click "New" on the WSRP Consumer Portlet
  2. Provide the WSRP Producer WSDL URL and click "Get info"
  3. The WSRP Consumer automatically recognizes version 1.0, 2.0 or combined(1.0 and 2.0) WSDL and provides the user an option to choose a version.
  4. Choose version 2.0/v2 to create a WSRP version 2.0 Consumer.
  5. If the producer requires registration, provide the details
  6. Click finish to complete the Consumer creation.

Step 3: Creating Remote/WSRP Portlets.

    The WSRP Consumer Admin portlets provides a "Create" link in each of the available Consumers
  1. Click the "Create" to create a channel
  2. Choose a name for the portlet
  3. Choose the remote portlet handle which you want to consumer
  4. Click finish.

Step 4: Viewing Remote/WSRP Portlets

    Click the WSRP tab on the portlet container driver to view the remote portlet that we just created.

Please Confirm