Sun Java logo     Previous      Contents      Index      Next     

Sun logo
Sun Java System Portal Server 6 2004Q2 Administration Guide 

Chapter 6
Administering the Web Services for Remote Portlets (WSRP) Service

This chapter describes how to administer the Sun Java™ System Portal Server Web Services for Remote Portlets (WSRP) service.

This chapter contains these sections:


Overview of the WSRP Standard

WSRP 1.0 is an OASIS standard that simplifies integration of remote applications and content into portals. The WSRP standard defines presentation-oriented, interactive web services with a common, well-defined interface and protocol for processing user interactions and for providing presentation fragments suited for mediation and aggregation by portals as well as conventions for publishing, finding and binding such services.

Because the WSRP interfaces are common and well-defined, all web services that implement the WSRP standard plug into all WSRP compliant portals – a single, service-independent adapter on the portal side is sufficient to integrate any WSRP service. As a result, WSRP becomes the means for content and application providers to provide their services to organizations running portals with no programming effort required.

See the WSRP 1.0 standard for more information:

http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wsrp

The implementation of the WSRP 1.0 standard in Portal Server includes both the WSRP consumer and the WSRP producer. The WSRP producer implementation supports publishing JSR 168 portlets for use by a remote WSRP consumer (see Administering Portlets for more information on JSR 168 portlets).The JSR 168 portlets are deployed locally on a portal server. These portlets can be published by an instance of the WSRP producer. Another portal server, through its WSRP consumer can subscribe to these remote portlets. While local portlets can be expected to provide a large part of the base functionality for portals, remote portlets allow the potential to bind to a variety of remote portlets without any installation effort or code running locally on the consuming portal server.

Figure 6-1  Web Services for Remote Portlets

image


Administering the WSRP Producer

This section describes the tasks to administer a WSRP producer:

To Add a WSRP Producer Instance

  1. Log in to the Sun Java System Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and Organizations is selected in the Navigation pane.

  3. Navigate to the desired organization or suborganization and select Services from the View menu.
  4. All created organizations are displayed in the navigation pane.

  5. Click the properties arrow next to the WSRP Producer under Remote Portlets (WSRP).
  6. The WSRP Producer attributes appear in the data pane.


    Note

    Depending on your requirements and configuration, you may have the ability to create and enable multiple WSRP producers under the same organization or suborganization (or even different organizations or suborganizations). The constraint is that the name of the WSRP producer must be unique for the entire Portal Server system.


  7. Click New under Producer to add a producer instance.
  8. The Specify Basic Parameters page appears.

  9. Enter values for the following properties:
    • Name of the producer instance (must be unique for the entire Portal Server)
    • Registration is Required
    • When registration is required, all WSRP consumers must register with this producer instance before making requests. Requests from unregistered consumers will be denied.

  10. If you select Registration is Required, then the Specify Registration Properties appears. Specify whether:
    • inband registration is supported (when a WSRP consumer can register with the producer instance online).
    • Inband registration allows WSRP consumers to register programmatically. Otherwise, out-of-band registration is required with manual contact (such as e-mail or telephone) between the WSRP consumer administrator and the WSRP producer administrator to set up and exchange access to a registration handle.

    • registration property descriptions that a WSRP consumer will provide during registration.
    • Registration properties WSRP consumers must provide at the time that they register.


      Note

      A registration validator is a Java class that implements the Registration Validator interface. Depending on your needs, you can author your own registration validator class and apply any logic necessary to validate consumer registrations.


  11. Click Next.
  12. The Review Page page appears.

  13. Verify the information that you provided and click Finish.

To Edit a WSRP Producer Instance

  1. Log in to the Sun Java System Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and Organizations is selected in the Navigation pane.

  3. Navigate to the desired organization or suborganization and select Services from the View menu.
  4. All created organizations are displayed in the navigation pane.

  5. Click the properties arrow next to the WSRP Producer under Remote Portlets (WSRP).
  6. The WSRP Producer attributes appear in the data pane.

  7. Click the Edit Properties link beside the producer instance to be modified.
  8. Select the General Properties tab and modify the properties as needed:
    • Status of the producer instance—Enabled for an active WSRP producer, Disabled for an inactive producer instance).
    • A disabled producer instance will not accept requests from WSRP consumers. By default, a WSRP producer is disabled until one or more portlets are published.

    • Registration is Required—Checked if WSRP consumers need to register.
    • Inband Registration—Supported if a WSRP consumer can register with the producer instance programmatically, Unsupported if the only way a WSRP consumer can register with a WSRP producer is by manual means (out of band).
    • Inband registration allows the WSRP producer to be contacted and passed registration data programmatically, and the WSRP consumer receiving a registration handle from the WSRP producer. Out-of-band registration requires manual contact (such as e-mail or telephone) between the WSRP consumer administrator and the WSRP producer administrator to set up and exchange access to a registration handle.

    • Registration Validator Class—Java class used to validate a registration. When a consumer registers with a producer, it passes registration property values for each registration property that the producer has defined in its service description. The registration validator class is used by the producer to validate that the values sent by the consumer are acceptable for this producer instance.

    • Tip

      A registrator validator is a Java class that implements the Registrator Validator interface. Depending on your needs, you can author your own registrator validator class and apply any logic necessary to validate consumer registrations.


      .

  9. Click Save
  10. Select the Portlets Tab to modify the lists of deployed portlets that will be available to WSRP consumers, then click Save.
  11. If registration is supported, select the Registration Properties tab to add or delete a property that all WSRP consumers must provide to register with the producer instance, then click Save.

To Add a WSRP Consumer Registration

A consumer registration allows a WSRP consumer to describe its capabilities to a WSRP producer. A WSRP consumer is being added out of band (such as by e-mail or telephone). The information entered when adding a consumer registration must match the capabilities of the WSRP consumer that is given the registration handle. Consumer registrations allow a WSRP producer to scope artifacts (such as portlet preferences) that are created by a WSRP consumer on the WSRP producer.

  1. Log in to the Sun Java System Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and Organizations is selected in the Navigation pane.

  3. Navigate to the desired organization or suborganization and select Services from the View menu.
  4. All created organizations are displayed in the navigation pane.

  5. Click the properties arrow next to the WSRP Producer under Remote Portlets (WSRP).
  6. The WSRP Producer attributes appear in the data pane.

  7. Click the Edit Properties link beside the WSRP producer to be modified.
  8. Select the Consumer Registrations tab.
  9. Click New under Consumer Registrations.
  10. The Create New Consumer Registrations page appears.

  11. Specify basic properties as needed:
    • Name of the WSRP consumer.
    • Status of the consumer registration (Enabled for an active consumer registration, Disabled for an inactive consumer registration). If a consumer registration is inactive, the producer will not accept requests that include the registration handle for the disabled consumer registration.
    • Consumer Agent (an identifier for the application name and version).
    • The format of the identifier is productName.majorVersion.minorVersion such as Sun Java(tm) System Portal Server.6.3

    • Method= “get” (Supported if the WSRP consumer has implemented portlet URLs in a manner that supports HTML markup containing forms with method=get, otherwise Not Supported).
  12. Click Next.
  13. The Specify Registration Parameters page appears if the WSRP producer is configured to require registration.

  14. Specify values for the registration properties.
  15. Click Next.
  16. The Review Page page appears.

  17. Verify the information that you provided and click Finish.

To Edit a WSRP Consumer Registration

  1. Log in to the Sun Java System Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and Organizations is selected in the Navigation pane.

  3. Navigate to the desired organization or suborganization and select Services from the View menu.
  4. All created organizations are displayed in the navigation pane.

  5. Click the properties arrow next to the WSRP Producer under Remote Portlets (WSRP).
  6. The WSRP Producer attributes appear in the data pane.

  7. Click the Edit Properties link beside the WSRP producer to be modified.
  8. Select the Consumer Registrations tab.
  9. Click the Edit Properties link beside consumer registration to be modified.
  10. The Edit Consumer Registrations page appears.

  11. Modify the properties as needed:
    • Name of the WSRP consumer.
    • Status of the consumer registration (Enabled for an active consumer registration, Disabled for an inactive consumer registration). If a consumer registration is inactive, the producer will not accept requests that include the registration handle for the disabled consumer registration.
    • Consumer Agent (an identifier for the application name and version).
    • The format of the identifier is productName.majorVersion.minorVersion such as Sun Java(tm) System Portal Server.6.3

    • Method= “get” (Supported if the WSRP consumer has implemented portlet URLs in a manner that supports HTML markup containing forms with method=get, otherwise Not Supported).
    • Consumer Modes (An array of modes that the WSRP consumer is willing manage. See the WSRP 1.0 specification for more information).
    • Consumer Window States (An array of window states that the WSRP consumer is willing manage. See the WSRP 1.0 specification for more information).
    • Consumer User Scopes (The values that the WSRP consumer is willing to process for user context. See the WSRP 1.0 specification for more information).
    • Custom User Profile Data (An array of strings that name user profile extensions. See the WSRP 1.0 specification for more information).
    • Registration Properties (List of registration properties. See the WSRP 1.0 specification for more information).
  12. Click Save.

To Disable all WSRP Producers

  1. Select Service Configuration in the location pane.
  2. Click the properties arrow next to the WSRP Producers under Remote Portlets (WSRP).
  3. The WSRP Producers attributes appear in the data pane.

  4. Select Disable All WSRP Producers under Global.
  5. Click Save


Administering the WSRP Consumer

This section describes the tasks to administer the WSRP Consumer:

To Create a Remote Portlet Channel

  1. Log in to the Sun Java System Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and Organizations is selected in the Navigation pane.

  3. Navigate to the desired organization or suborganization and select Services from the View menu.
  4. All created organizations are displayed in the navigation pane.

  5. Click the properties arrow next to the Portal Desktop service.
  6. The Portal Desktop attributes appear in the data pane.

  7. Click the Channel and Container Management link.
  8. The Channels page appears. At the top is the container path. The defined channels appear in a list.

  9. Click New Remote (WSRP) Channel to add a remote channel.
  10. The New Channel page appears.

  11. Select a WSRP producer from the Producer list.
  12. Select a remote portlet from the Portlet list.
  13. Type the name of the remote channel in Channel Name.
  14. Click OK.

To Edit General Properties of the WSRP Consumer

  1. Log in to the Sun Java System Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and Organizations is selected in the Navigation pane.

  3. Navigate to the desired organization or suborganization and select Services from the View menu.
  4. All created organizations are displayed in the navigation pane.

  5. Click the properties arrow next to the WSRP Consumer under Remote Portlets (WSRP).
  6. The WSRP Consumer attributes appear in the data pane.

  7. Click the General tab.
  8. Modify the properties as needed:
    • Name—The WSRP consumer sends the consumer name to producers during registration.
  9. Click Save

To Add a Configured WSRP Producer

  1. Log in to the Sun Java System Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and Organizations is selected in the Navigation pane.

  3. Navigate to the desired organization or suborganization and select Services from the View menu.
  4. All created organizations are displayed in the navigation pane.

  5. Click the properties arrow next to the WSRP Consumer under Remote Portlets (WSRP).
  6. The WSRP Producer attributes appear in the data pane.

  7. Click the Configured Producers tab.
  8. Click New under Producer to add a configured WSRP Producer.
  9. The Specify Basic Parameters page appears.

  10. Specify the name of the new configured WSRP producer and the URL for the WSDL of the desired WSRP producer.
  11. Click Next.
  12. If the desired WSRP producer requires registration and supports inband registration, specify whether the WSRP consumer will:
    • register programmatically with the desired WSRP producer online
    • provide a registration handle that is obtained by manual means from the desired WSRP producer
    • Inband registration allows the WSRP producer to be contacted and passed registration data programmatically, and the WSRP consumer receiving a registration handle from the WSRP producer. Out-of-band registration requires manual contact (such as e-mail or telephone) between the WSRP consumer administrator and the WSRP producer administrator to set up and exchange access to a registration handle. If registration is required, but inband registration is not available, the registration handle that was obtained out of band would need to be entered.

  13. Click Next.
  14. Provide the information requested in Registration Properties.
  15. A WSRP producer may require that WSRP consumer who is registering return values for keys (or registration properties that the producer describes in its service description such as company name or postal code). If a producer defines registration properties, they will appear on this page and the values should be supplied.

  16. Click Next.
  17. The Review Page page appears.

  18. Verify the information that you provided and click Finish.

  19. Note

    You may need to edit the configured WSRP producer you added to set up the user categories to roles mapping. Otherwise, some portlets may not work properly.


To Edit a Configured WSRP Producer

  1. Log in to the Sun Java System Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and Organizations is selected in the Navigation pane.

  3. Navigate to the desired organization or suborganization and select Services from the View menu.
  4. All created organizations are displayed in the navigation pane.

  5. Click the properties arrow next to the WSRP Consumer under Remote Portlets (WSRP).
  6. The WSRP Producer attributes appear in the data pane.

  7. Click the Configured Producers tab.
  8. Click the Edit Properties link beside the configured WSRP producer to be modified.
  9. The Edit Basic Properties page appears.

  10. Modify the properties as needed:
    • Name of the WSRP producer
    • Status of the WSRP producer—Enabled for an active WSRP producer, Disabled for an inactive WSRP producer.
    • Remote portlet channels that target a disabled producer will not be visible on the Portal Desktop. Exercise caution when disabling WSRP producers.

    • Service Description—Click Update Service Description to get the latest service description of the WSRP producer.
  11. Click Save
  12. If displayed, click the User Categories to Roles Mapping link.
  13. The User Categories to Roles Mapping page appears.

  14. If displayed, assign a WSRP user category to a local Identity Server role.

  15. Note

    Not every WSRP producer supports WSRP user categories.


  16. Click Save.
  17. If displayed, click the Registration Properties link.
  18. The Registration Properties page appears.

  19. Modify the values of the registration properties as needed.
  20. Click Save.

To Disable all WSRP Consumers

  1. Select Service Configuration in the location pane.
  2. Click the properties arrow next to the WSRP Consumer under Remote Portlets (WSRP).
  3. The WSRP Consumer attributes appear in the data pane.

  4. Select Disable All WSRP Consumers under Global.
  5. Click Save.

To Edit the Standard User Profile Mapping

Portal Server maintains a standard set of end user attributes as a way to personalize behavior for the current user.

  1. Select Service Configuration in the location pane.
  2. Click the properties arrow next to the WSRP Consumer under Remote Portlets (WSRP).
  3. The WSRP Consumer attributes appear in the data pane.

  4. Modify the Standard User Profile Mapping value under Global using the following format:
  5. WSRP-defined profile|LDAP-attribute

    See the WSRP 1.0 specification for more information.

  6. Click Save.

To Specify the Consumer Name

The WSRP consumer sends the consumer name to producers during registration. The value specified for the consumer name is used as the default unless a value is specified for consumer name at the organization or suborganization level.

  1. Select Service Configuration in the location pane.
  2. Click the properties arrow next to the WSRP Consumer under Remote Portlets (WSRP).
  3. The WSRP Consumer attributes appear in the data pane.

  4. Enter a value in Consumer Name.
  5. Click Save



Previous      Contents      Index      Next     


Copyright 2004 Sun Microsystems, Inc. All rights reserved.