A WSRP consumer is an intermediary system that communicates with producers and the portlets they offer on behalf of its client (typically a portal). It gathers markup delivered by the remote portlets to be used by the portal and manages the remote portlet providers. The portal then mediates the markup and interaction between end-users and the producer. The consumer provides comprehensive client-side support for the four WSRP interfaces (Service Description, Registration, Markup, and Manage Portlets).
Once a standard JSR168 portlet is deployed in ATG, it behaves like any other ATG portal gear. A gear manifest is generated which can be used for adding the portlet to the ATG Portal framework.
The ATG consumer is shipped as separate module responsible for communicating with a producer based on the standard WSRP interfaces. It also is responsible for managing the producer and its offered portlets using ATG repositories. All WSRP functionality is encapsulated within the WSRP-ProxyPortlet.
WSRP-ProxyPortlet
WSRP-ProxyPortlet acts as a proxy for the remotely running portlet. In the ATG portal framework, it behaves like any other ATG gear. It is provided in deployed form in the WSRP.consumer module, and can be added to the Portal Framework. Like any other portlet, the WSRP-ProxyPortlet can have multiple instances, and each instance can be configured to interact with a specific remote producer offered portlet.
WSRP-related configuration and management functionality is provided through the following two custom portlet modes of WSRP-ProxyPortlet:
Config. Corresponds to ATG’sinstallConfiggear mode and is primarily used to configure the proxy portlet in the framework, including:Registering with producers
Adding and removing the list of available remote portlets from each producer
Getting the latest WSRP
PortletDescriptionfor individual remote portletsModifying existing registrations
Deregistering with producers
Edit_defaults. Corresponds to ATG’sinstanceConfiggear mode. It is used to configure a particularProxyPortletinstance (or gear instance) to be associated with a particular portlet from any producers with which the consumer registered duringinstallConfigmode.
Consumer Portlet Modes
The WSRP-ProxyPortlet has a predefined set of portlet modes, which complements the set supported by the ATG consumer. The combined portlet modes supported by the ProxyPortlet fall into two categories:
Modes that are primarily handled by the proxy portlet itself. These modes are required for proxy portlet administration, and their handling is confined to the scope of the ATG proxy portlet. The modes are:
Edit_defaults
CONFIG
Modes whose handling is delegated to a remote WSRP portlet by the proxy portlet, and which are handled by the ATG consumer. These modes may not be present in the supported modes definition of the proxy portlet; instead their support is determined by the proxy portlet itself. The following remote portlet modes are supported by ATG proxy portlet:
VIEW
EDIT
HELP
When a JSR168 portlet is deployed to the ATG portal framework, the existing portlet modes for that portlet are mapped to the corresponding gear mode implementation in ATG, and further mapped to WSRP Portlet modes. The following table shows the mapping:
JSR168 Portlet Modes | ATG Gear Modes | WSRP Portlet Modes |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The portlet modes supported by the consumer can be passed in the RegistrationData; the portal administrator can select the view, edit, help, or preview portlet modes during registration.
Consumer Window States
A window state is an indicator of the amount of portal page space assigned to a portlet’s content; supported states are Normal, Maximized and Minimized. In the ATG portal framework, portlet window states are implemented in as gear display modes. Like Portlet modes, the window states supported by the consumer can be passed in the RegistrationData; the portal administrator can select a WSRP window state from Normal, Minimized, Maximized and Solo during the registration.
The Normal and Minimized window states correspond to Shared display mode.
The Maximized and Solo window states correspond to Full display mode.
Consumer UserProfile Items
The UserContext structure is a way for the consumer to provide end-user data to the producer, allowing the producer to perform end-user-specific handling. The UserContext data structure consists of the following members:
UserContextKey. A required token supplied by the consumer to uniquely identify the
UserContext, and which remains invariant for the duration of a consumer’s registration. The ATG consumer generates a uniqueUserContextKeybased on the registration context passed by it to the producer in theUserContextstructure. The producer can use this key as a reference to the user.UserCategories. An optional array of strings, each of which specifies a producer-defined user category in which the consumer places the end-user relative to the current operation, to be used for personalization. The ATG consumer does not support
UserCategories, and they are ignored if offered by a producer.UserProfile: An optional WSRP structure used to carry information about the end-user. Note that this structure does not carry any user credentials, such as ID or password. The portlet uses the
userProfileItemsin its metadata to describe the fields it uses to generate markup from this set and any others the consumer indicated were available when it registered. The ATG consumer provides a mapping between the WSRPUserProfileand ATG personalization’sUserProfileattributes. To modify the default mapping, change theuserProfileMapproperty in the/atg/wsrp/consumer/ConfigurationNucleus component. The default mapping is described in the table below.Profile Name
Field Name
ATG Profile Repository Property
name/prefixprefixContactInformation.prefixname/givengivenUser.firstNamename/familyfamilyUser.lastNamename/middlemiddleUser.middleNamename/suffixsuffixContactInformation.suffixname/nicknamenickname"Empty"bdatebdateUser.dateOfBirthGendergenderUser.genderemployerInfo/employeremployer"Empty"employerInfo/departmentdepartment"Empty"employerInfo/jobtitlejobtitleContactInformation.titlehomeInfo/postal/namenameContactInformation.address1homeInfo/postal/streetstreetContactInformation.address2homeInfo/postal/cityCityContactInformation.cityhomeInfo/postal/stateprovstateprovContactInformation.statehomeInfo/postal/postalcodepostalcodeContactInformation.postalCodehomeInfo/postal/countrycountryContactInformation.countryhomeInfo/postal/organizationorganizationContactInformation.companyNamehomeInfo/telecom/telephone/intcodeintcodeContactInformation.phoneNumberhomeInfo/telecom/telephone/loccodeloccodehomeInfo/telecom/telephone/numbernumberhomeInfo/telecom/telephone/extExt"Empty"homeInfo/telecom/telephone/commentcomment"Empty"homeInfo/telecom/fax/intcodeintcodeContactInformation.faxNumberhomeInfo/telecom/fax/loccodeloccodehomeInfo/telecom/fax/numbernumberhomeInfo/telecom/fax/extExt"Empty"homeInfo/telecom/fax/commentcomment"Empty"homeInfo/telecom/mobile/intcodeintcode"Empty"homeInfo/telecom/mobile/loccodeloccode"Empty"homeInfo/telecom/mobile/numbernumber"Empty"homeInfo/telecom/mobile/extExt"Empty"homeInfo/telecom/mobile/commentcomment"Empty"homeInfo/telecom/pager/intcodeintcode"Empty"homeInfo/telecom/pager/loccodeloccode"Empty"homeInfo/telecom/pager/numbernumber"Empty"homeInfo/telecom/pager/extExt"Empty"homeInfo/telecom/pager/commentcomment"Empty"homeInfo/online/emailemailUser.emailhomeInfo/online/uriUri"Empty"businessInfo/postal/namename"Empty"businessInfo/postal/streetstreet"Empty"businessInfo/postal/cityCity"Empty"businessInfo/postal/stateprovstateprov"Empty"businessInfo/postal/postalcodepostalcode"Empty"businessInfo/postal/countrycountry"Empty"businessInfo/postal/organizationorganization"Empty"businessInfo/telecom/telephone/intcodeintcode"Empty"businessInfo/telecom/telephone/loccodeloccode"Empty"businessInfo/telecom/telephone/numbernumber"Empty"businessInfo/telecom/telephone/extExt"Empty"businessInfo/telecom/telephone/commentcomment"Empty"businessInfo/telecom/fax/intcodeintcode"Empty"businessInfo/telecom/fax/loccodeloccode"Empty"businessInfo/telecom/fax/numbernumber"Empty"businessInfo/telecom/fax/extExt"Empty"businessInfo/telecom/fax/commentcomment"Empty"businessInfo/telecom/mobile/intcodeintcode"Empty"businessInfo/telecom/mobile/loccodeloccode"Empty"businessInfo/telecom/mobile/numbernumber"Empty"businessInfo/telecom/mobile/extExt"Empty"businessInfo/telecom/mobile/commentcomment"Empty"businessInfo/telecom/pager/intcodeintcode"Empty"businessInfo/telecom/pager/loccodeloccode"Empty"businessInfo/telecom/pager/numbernumber"Empty"businessInfo/telecom/pager/extExt"Empty"businessInfo/telecom/pager/commentcomment"Empty"businessInfo/online/emailemail"Empty"businessInfo/online/uriUri"Empty"
Inner Title Bar
In the ATG Portal implementation, the gear title template is responsible for displaying the gear title bar and optional links for Edit, About and Help. For the proxy portlet implementation, the gear title template is not sufficient, therefore the WSRP-ProxyPortlet itself generates HTML for the links for the supported Portlet Modes. The HTML is embedded in the markup obtained from the remote portlet. The inner title bar is based on the PortletDescription of the remote portlet for which the WSRP-ProxyPortlet instance is configured.
WSRP Remote Portlet – ProxyPortlet Relationship
To establish an association between the WSRP-ProxyPortlet instance and the actual remote WSRP portlet, the consumer uses Gear Instance parameters of the WSRP-ProxyPortlet. Whenever the proxy portlet instance is configured for linking with a specific remote portlet available to the consumer, the Gear Instance parameter of the current ProxyPortlet instance stores a unique consumer generated portletDescriptionID, which identifies a specific remote portlet and its associated PortletDescription. This way a given ProxyPortlet instance is able to reach the target PortletDescription and the producer for which it has been configured.
