Web Services for Remote Portlets Specification v2.0

llspacing=0 width=100%>Yahoo! is not affiliated with the authors of this page or responsible for its content.
Web Services for Remote Portlets Specification v2.0
WSRP v2.0 Specification

Web Services for Remote Portlets
Specification v2.0
Committee Specification 02
28 January 2008
Specification URIs:
This version:
http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec-cs-02.html
http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec-cs-02.pdf
Previous Version:
http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec-cs-01.html
http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec-cs-01.pdf
Latest Version:
http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec.html
http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec.pdf
Latest Approved Version:
http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec-cs-02.html
http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec-cs-02.pdf
Technical Committee:
OASIS Web Services for Remote Portlets TC

Chair(s):
Rich Thompson, IBM Corporation <
richt2@us.ibm.com
>
Editor:
Rich Thompson, IBM Corporation <
richt2@us.ibm.com
>
file:///C|/Projects/WSRP/V2_Documents/wsrp-2.0-spec-cs-02.html (1 of 144)02/13/08 10:08:48 AM WSRP v2.0 Specification
Related Work:
This specification replaces or supercedes:
WSRP v1.0 specification
Declared XML Namespace(s):
urn:oasis:names:tc:wsrp:v2:types
urn:oasis:names:tc:wsrp:v2:intf
urn:oasis:names:tc:wsrp:v2:bind
urn:oasis:names:tc:wsrp:extra
Abstract:
Integration of remote content and application logic into an End-User presentation has been a task requiring
significant custom programming effort. Typically, vendors of aggregating applications, such as a portal, write
special adapters for applications and content providers to accommodate the variety of different interfaces and
protocols those providers use. The goal of this specification is to enable an application designer or administrator
to pick from a rich choice of compliant remote content and application providers, and integrate them with just a
few mouse clicks and no programming effort. This revision of the specification adds Consumer managed
coordination, additional lifecycle management and a set of related aggregation enhancements.
This specification is the effort of the OASIS Web Services for Remote Portlets (WSRP) Technical Committee
which aims to simplify the effort required of integrating applications to quickly exploit new web services as they
become available.
This standard layers on top of the existing web services stack, utilizing existing web services standards and will
leverage emerging web service standards (such as policy) as they become available. The interfaces defined by
this specification use the Web Services Description Language (WSDL).
Status:
This document was last revised or approved by the WSRP TC on the above date. The level of approval is also
listed above. Check the "Latest Version" or "Latest Approved Version" location noted above for possible later
revisions of this document.
Technical Committee members should send comments on this specification to the Technical Committees email
list. Others should send comments to the Technical Committee by using the Send A Comment button on the
Technical Committees web page at
http://www.oasis-open.org/committees/wsrp
.
For information on whether any patents have been disclosed that may be essential to implementing this
specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of
the Technical Committee web page (
http://www.oasis-open.org/committees/wsrp/ipr.php
).
The non-normative errata page for this specification is located at
http://www.oasis-open.org/committees/wsrp
.
file:///C|/Projects/WSRP/V2_Documents/wsrp-2.0-spec-cs-02.html (2 of 144)02/13/08 10:08:48 AM WSRP v2.0 Specification
Notices
Copyright © OASIS® 19932007. All Rights Reserved. OASIS trademark, IPR and other policies apply.
All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property
Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.
This document and translations of it may be copied and furnished to others, and derivative works that comment on
or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole
or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all
such copies and derivative works. However, this document itself may not be modified in any way, including by
removing the copyright notice or references to OASIS, except as needed for the purpose of developing any
document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to
copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other
than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE
OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be
infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC
Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner
consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.
OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent
claims that would necessarily be infringed by implementations of this specification by a patent holder that is not
willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical
Committee that produced this specification. OASIS may include such claims on its website, but disclaims any
obligation to do so.
OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be
claimed to pertain to the implementation or use of the technology described in this document or the extent to which
any license under such rights might or might not be available; neither does it represent that it has made any effort to
identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable
produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made
available for publication and any assurances of licenses to be made available, or the result of an attempt made to
obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS
Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no
representation that any information or list of intellectual property rights will at any time be complete, or that any
claims in such list are, in fact, Essential Claims.
The name "OASIS" is a trademark of
OASIS
, the owner and developer of this specification, and should be used only
to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of,
specifications, while reserving the right to enforce its marks against misleading uses. Please see
http://www.oasis-
open.org/who/trademark.php
for above guidance.
file:///C|/Projects/WSRP/V2_Documents/wsrp-2.0-spec-cs-02.html (3 of 144)02/13/08 10:08:48 AM WSRP v2.0 Specification
Short Table of Contents
1 Introduction
2 General Considerations
3 Interface Overview
4 Service Description Interface
5 Markup Interface
6 Registration Interface
7 Portlet Management Interface

8 Security
9 Markup
10 User Information
11 Well Known Extensions
12 Constants
13 Fault Messages
14 WSDL Interface Definition
15 Conformance Statements
Appendix A. Glossary (Non-Normative)
Appendix B. Common Values (Non-Normative)
Appendix C. Types of state (Non-Normative)
Appendix D. Coordination mechanisms (Non-Normative)
Appendix E. Data Structures List (Non-Normative)
Appendix F. Acknowledgments (Non-Normative)
Table of Contents
1 Introduction
1.1 Terminology
1.2 Normative References
1.3 Non-Normative References
1.4 Motivation
file:///C|/Projects/WSRP/V2_Documents/wsrp-2.0-spec-cs-02.html (4 of 144)02/13/08 10:08:48 AM WSRP v2.0 Specification
1.5
Actors
1.5.1 Portlet
1.5.2 Producer
1.5.3 Consumer
1.5.4 End-User
1.6 Typical Process Flow
2 General Considerations
2.1 Related Standards
2.1.1 Existing Standards
2.1.2 Emerging Standards
2.2 Foundations
2.3 Data Objects
2.4 Lifecycles
2.5 Scopes
2.6 Leasing
2.7 Types of Stateful Information
2.8 Statefulness
2.9 Producer Mediated Data Sharing
2.10 Consumer Mediated Coordination
2.11 Information Passing Mechanisms
3.12 Three-step protocol
2.13 Transport Issues
2.14 Load Balancing
3 Interface Overview
3.1 Service Description Operations
3.2 Markup Operations
3.3 Registration Operations
3.4 Portlet Management Operations
4 Service Description Interface
file:///C|/Projects/WSRP/V2_Documents/wsrp-2.0-spec-cs-02.html (5 of 144)02/13/08 10:08:48 AM WSRP v2.