+

Search Tips   |   Advanced Search

Exchange required information between Producer and Consumer portals

The WSRP standard defines the interfaces and the protocol for communication between the Producer portal and the Consumer portal. The Producer portals provide WSRP services that can be called to invoke provided portlets. The Consumer portals request WSRP services to call the remote portlets.

Currently, there are two versions of the WSRP standard, WSRP 1.0 and WSRP 2.0. WebSphere Portal supports both versions of the WSRP standard.

The WSRP implementation of WebSphere Portal v8.5 is built on the JAX-WS based web service stack of IBM WebSphere Application Server. The WSRP implementation in earlier versions of WebSphere Portal was based on the web service stack based on the JAX-RPC standard. WSRP in WebSphere Portal v8.5 can interoperate with WSRP counterparts built on other web service stacks, such as JAX-RPC. In particular, WSRP in WebSphere Portal v8.5 can communicate and interoperate with WSRP counterparts in WebSphere Portal v8.0 and earlier versions.

WSRP defines a set of four web service interfaces...

Web service interface Supported by Producer Supported by Consumer
Service Description Yes Yes
Markup Yes Yes
Registration (optional) No Yes
Portlet Management (optional) Yes Yes

The producer implementation of the portal does not support the Registration interface of the WSRP specification. However, the Consumer implementation of the portal can interoperate with Producers that support WSRP Registration interfaces.

To set up communication with a Producer portal, the Consumer portal requires the following information from the Producer portal:

  • The Web Services Description Language (WSDL) service description document, which provides the following information:

    • Descriptions of the WSRP interfaces and WSRP services the Producer provides.
    • Technical information, such as the service endpoint addresses.

  • Information about the quality of service and security configuration of the WSRP services on the Producer portal.

When the Consumer has this information, the administrator of the Consumer portal can configure the Consumer portal accordingly. After this configuration, the Consumer can consume remote portlets from the Producer portal.

Depending on the overall WSRP setup, the Consumer might in turn provide information to the Producer. For example, if the Producer portal has security configured, the Consumer can send user IDs of Consumer portal users to the Producer. The Producer can then give these users access to the provided portlets. The Consumer portal users can then work with the portlets the Consumer portal consumes from the Producer.

An administrator of the producer must know which service providers the producer supports. An administrator of the consumer normally does not need to know about the implementation details of a producer.


Service providers of the producer

To comply with the JAX-WS standard, the producer of WebSphere Portal provides a set of service providers that implement the WSRP web service interfaces. The following table lists the supported service providers:

Web service interface WSRP 1.0 service provider WSRP 2.0 service provider WSRP 2.0 service provider for portal-internal WSRP communication
Service Description WSRPServiceDescriptionService WSRPServiceDescriptionService_v2 WSRPServiceDescriptionService_v2_internal
Markup WSRPBaseService WSRPBaseService_v2 WSRPBaseService_v2_internal
Portlet Management WSRPPortletManagementService WSRPPortletManagementService_v2 WSRPPortletManagementService_v2_internal

We can administer and configure each of the WSRP 1.0 and 2.0 service providers separately. We administer and configure them using the administration clients of WebSphere Application Server. For example, use the WAS admin console.

Do not change the configuration of the WSRP 2.0 service providers for portal-internal WSRP communication. These service providers are used internally by WebSphere Portal during client side aggregation. Remote consumer portals cannot access these service providers.


Service clients and references of the consumer

The consumer of WebSphere Portal provides a set of service clients and default service references. The set includes two service clients, one each to support WSRP 1.0 and WSRP 2.0 and the respective port types or web service interfaces. There is one default service reference per service client. We can configure and administer the service clients and service references using the WAS admin console. For example, use the WAS admin console to configure WSRP service providers and WSRP service clients by attaching policy sets. We can configure each service client and service reference separately.

The following table lists the supported service clients and service references:

WSRP 1.0 WSRP 2.0
Service client WSRPService WSRPService_v2
Service reference service/wsrp/WSRPService service/wsrp/WSRPService_v2

The service clients support all WSRP service interfaces: Service Description, Markup, Portlet Management, and Registration.

The configuration of the WSRP service clients is managed outside WebSphere Portal. The portal consumer supports all service client configurations configured in WebSphere Application Server. This support includes message level security, transport level security, and other quality of service configuration. However, the service client configuration of the consumer must be compatible with the web service configuration of the producer. Example: If the service providers of the Producer portal are configured for WS-Security, the service references of the Consumer portal must also be configured for WS-Security. Otherwise, the WSRP communication fails.


Parent Plan for WSRP

Related concepts:
Information the Producer exchanges with the Consumer
Information the Consumer exchanges with the Producer