test

Sun Java System Portal Server 7.1 Administration Guide

Administering the Producer

This section discusses the following topics:

Create a producer if you want to offer locally deployed portlets remotely to other portals that act as WSRP consumers. A portal can host multiple producers. The consumer can import remote portlets offered by a producer. Based on the portlets that you want to provide to WSRP consumers, you may create one or more producers. A producer can support registration or it does not require registration. If a producer supports registration, then consumers must register to work with the producer.

Creating a Producer That Supports Registration

Registration is used to build a technical or business relationship between the consumer and the producer. While creating a producer, you can define any one of the following registration mechanisms: in-band registration or out-of-band registration:

If the producer requires registration and enabled in-band registration: the consumer can provide the details through WSRP interface and register with the producer. Consumer is also provided an option to register through out-of-band communication. That is, consumer can provide the registration handle obtained through out-of-band communication.

If the producer requires registration and enabled out-of-band registration: the consumer should obtain the registration handle through out-of-band communication and provide the registration handle during registration. Out-of-band registration happens with manual intervention such as phone calls, email, and so on. For a producer that supports out-of-band registration, the producer gets the details about the consumer through out-of-band communication, and it creates a registration handle for the consumer. The registration handle is communicated to the consumer through out-of-band communication.

ProcedureTo Create a Producer That Supports Registration

  1. Log in to the Portal Server management console.

  2. Select the Portals tab.

  3. Select a portal server from Portals.

  4. Click the WSRP tab.

  5. From the Select DN drop-down menu select any DN, and click the Producer tab.

    The WSRP Producers table displays all producers that are created.

    Note –

    Organizations are created in Sun Java System Identity Server. Select the DN of an organization or suborganization based on the availability of portlets.

  6. Click New to create a new producer.

  7. Type the name to identify the producer.

  8. Select Required for Registration.

  9. Select Supported for Inband Registration if you wish the consumer to enter the details, while adding the configured producer, using Sun Java System Portal Server application interface.

  10. To add a registration property, click Add Row. Enter the values. Enter the name of the registration property and description.

    Note –

    Registration properties are the details that you want to get from the consumer while the consumer registers to a specific producer. The registration properties entered by the consumer can be validated through the Registration Validation class.

  11. Select Supported for out-of-band Registration if you wish the consumer to provide the details through out-of-band communication, such as phone calls, email, and so on.

  12. Click Next.

    The Review screen displays the details that you entered. Review details. You can click Previous and change the details you entered.

  13. Click Finish.

Equivalent psadmin Command

psadmin create-producer

Creating a Producer That Does Not Support Registration

For a producer that does not require registration, consumer is not required to enter any information or get any information through out-of-band communication. In this case, the consumer can not customize (or edit) the portlets offered by the producer. The producer that does not support registration provides Read-Only portals to the consumers.

ProcedureTo Create a Producer That Does Not Support Registration

  1. Log in to the Portal Server management console.

  2. Select the Portals tab.

  3. Select a portal server from Portals.

  4. Click the WSRP tab.

  5. Select DN.

    The Configured Producers table displays all producers that are already configured.

  6. Click New.

  7. Type the name of the producer.

  8. Select Registration not required.

  9. Click Finish.

Equivalent psadmin Command

psadmin create-producer

Enabling and Editing WSRP Producer Properties

A newly created Producer should be enabled for a consumer to register. A producer can be enabled by adding one or more portlets.

A producer can be disabled. But, all the consumers registered with the disabled producer will not be able to access the portlets offered by the producer.

ProcedureTo Enable and Edit the Producer's Properties

  1. In the Producer tab, click the producer name link.

    The Edit Properties screen appears. The screen displays WSDL (Web Services Definition Language) URL. WSDL URL is a unique URL for a specific producer through which the consumer accesses the producer.

  2. Add one or more published portlets to the producer.

    Note –

    The producer must have at least one published portlet to enable it. The screen displays all published portlets associated with the portal in which the producer is created.

  3. Select a portlet, and click Add.

  4. Edit the Registration Validation Class field if required.

    Registration Validator is used to validate the registration properties that are entered by the consumer. You can also customize this class based on the needs.

  5. Click Save. Now, the Enable check box displayed in the screen can be edited. Select Enable and click Save.

    Note –

    You can also edit other properties of the producer.

Equivalent psadmin Command

psadmin set-attribute

Customizing Registration Validation Class

You can customize the RegistrationValidator class. Using this class, you can process the registration properties. For example, verifying the zip code of the customer. RegistrationValidator is the SPI for registration validation in the WSRP producer. For more information on customizing the validation class, see http://portalID/portal/javadocs/desktop. You can also refer to WSRP: Validating Registration Data in Sun Java System Portal Server 7.1 Developer’s Guide.

Generating a Registration Handle

For a producer that supports registration, a registration handle needs to be generated for a specific consumer. After generating the registration handle, it needs to be communicated to the consumer to register with the producer through out-of-band communication. Consumer needs to enter the registration handle, while registering with the producer.

ProcedureTo Generate a Registration Handle

  1. Click the Consumer Registration tab.

    The screen displays all consumers that are already registered to the specific producer.

  2. Click New.

  3. Type details, such as name, status, consumer agent, and method.

    Consumer name

    A unique name to identify the consumer.

    Status

    Can be Enabled or Disabled.

    Consumer Agent

    Specifies the name and version of the consumer's vendor. Consumer Agent Name should be ProductName.MajorVersion.MinorVersion, where ProductName identifies the product the consumer installed for its deployment, and majorVersion and minorVersion are vendor-defined indications of the version of its product. This string can then contain any additional characters/words the product or consumer wishes to supply.

    Method

    Specifies whether the Consumer has implemented portlet URLs in a manner that supports HTML markup containing forms with method, get.

  4. Click Next.

    The screen displays the registration property values that are specified while creating the producer.

  5. Enter the values, and click Next. Click Finish.

Publishing Producer Details to ebXML Registry

Publishing a producer stores producer details in any one of the repositories, such as Sun Java System Service Registry Server or an ebXML Registry server. After a producer is published, you can search for the details of the producer using the application interface or using the command-line interface. For details on setting up Sun Java System Service Registry Server, see the Service Registry 3.1 Administration Guide.

You need to configure Sun Java System Portal Server for Registry to publish the producer details to the registry.

ProcedureTo Configure Sun Java System Portal Server for Registry

  1. Create the directory, /soar/3.0/jaxr-ebxml/security, in the machine where Portal Server is installed.

  2. Copy keystore.jks from Registry Server's /var/opt/SUNWsrvc-registry/3.0/data/security directory to /soar/3.0/jaxr-ebxml/security.

  3. Log in to the Portal Server management console.

  4. Select the Portals tab.

  5. Select a portal server from Portals.

  6. Click SSO Adapter from the submenu.

  7. Click JES-REGISTRY-SERVER.

    The Edit Meta-adapter - JES-REGISTRY-SERVER screen appears.

  8. Type the details.

    If you are accessing the registry server through a proxy:

    http.proxy.host

    Hostname of the proxy server.

    http.proxy.password

    Proxy password if proxy server required authentication.

    http.proxy.port

    Port on which proxy server is available.

    http.proxy.user

    Proxy username if proxy server required authentication.

    If you are not using a proxy server:

    registry.keypassword

    Password that is required to get the key from the keystore.

    registry.keystorealias

    The key alias that is present in the keystore that is to be used for authenticating with the registry server.

    registry.keystorelocation

    Location of the keystore relative to /soar/3.0/jaxr-ebxml/.

    registry.keystorepassword

    Password used to open the keystore.

    registry.publishurl

    URL of the registry server where publish request should be sent. This URL should accept SOAP requests.

    registry.queryurl

    URL of the registry server where search request should be sent. This URL should accept SOAP requests.

ProcedureTo Publish Producer Details to Registry

The following steps explain how to publish a producer to the Registry Server:

  1. Create organization data and producer data files.

    Organization data file can contain the following entries:

    org.name=Sun Microsystems

    org.description=Description

    org.primarycontact.name=Henry

    org.primarycontact.phoneno=1234567

    org.primarycontact.email=someone@host.com

    Note –

    The org.name and org.description should be similar as that of the details in Identity Server unless the Registry is deployed internally.

    The producer data file should have the following entries:

    producer.name=Producer_name

    producer.description=Producer_Description

    producer.id=Producer_ID

    Note –

    It is not a must that you should create all the data files. But, for searching the details of producer, organization, or portlet, you should have created at least one file associated with that.

  2. Stop and restart the common agent container:

    /usr/lib/cacao/bin/cacaoadm stop

    /usr/lib/cacao/bin/cacaoadm start

  3. To publish the produce details, use the following command:

    ./psadmin publish-registry -u amadmin -f password_file -p portal1 -m producer -U producer_data_file -O organization_data_file -T portlet -L --debug

    Note –

    The portlet file specifies the portlets that are offered by WSRP producer. The portlets list is specified as a string within double quotes and elements separated by space. For example, "NotepadPortlet BookmarkPortlet WeatherPortlet."

    Note –

    You can check the log file by using the following command: more var/opt/SUNWportal/logs/admin/portal.admin.cli.0.0.log

Equivalent psadmin Command

psadmin publish-registry

Finding a Producer

The following section explains how to search for a producer:

ProcedureTo Search a Producer

  1. Create a Search Producer data file.

    Search Producer data file can contain the following:

    producer.name=producer_name

    producer.description=producer_description

    Note –

    The Search Producer data file contains a description of the producer to search for in the registry. Use the character % as a wildcard. For example, %acme% in producer.name any WSRP Producer that contains the string "acme" in its name.

  2. To search the registry, use the following command:

    ./psadmin search-registry -m consumer -u amadmin -f ps_password -C search_producer_datafile -p portal1

  3. Create a search Portlet data file.

    Search Portlet data file can contain the following:

    portlet.name=portlet_name

    portlet.description=portlet_description

    Note –

    The Search Portlet data file contains a description of the portlet to search for in the registry. Use the character % as a wildcard. For example, %stock% in portlet.name locates any Portlet that contain the string "stock" in its name.

  4. To search based on portlet details, use the following command:

    ./psadmin search-registry -m consumer -u amadmin -f ps_password -D search_portlet_datafile

  5. Create a Search Organization data file.

    Search Organization data file should contain the following:

    organization.name=organization_name

    organization.description=organization_description

    Note –

    The Search Organization data file contains a description of the organization to search for in the registry. Use the character % as a wildcard. For example, %acme% in organization.name locates any organization that contains the string "acme" in its name.

  6. To search based on the organization data file, use the following command:

    ./psadmin search-registry -m consumer -u amadmin -f ps_password -L search_organization_datafile -p portal1

Equivalent psadmin Command

psadmin search-registry