Federated Portals Guide

Introduction

Federation in the Portal Life Cycle

Architecture

Development

Staging

Production

Getting Started

Prerequisites

Related Guides

Using this Guide

Part I Architecture

What are Federated Portals?

Overview

Basic Terminology

Traditional Portals: Before Federation

Federated Portals: A New Paradigm

Advantages of Federation

Overview

Reducing the Cost of Portal Deployment

Plug and Play SOA

Increasing the Flexibility of Release Schedules

Reducing the Cost of Testing Your Portal

Decreasing Dependencies Among Software Components

Promoting Reuse of Portal Components

Interoperability

Federated Portal Architecture

Key Actors in a Federated Portal

Federating Books and Pages

What is WSRP?

Understanding Producers and Consumers

Overview

WebLogic Portal Producers

Simple Producers

Complex Producers

Summary of Complex and Simple Producers

WebLogic Portal Consumers

Cookie Handling

Life Cycle of a Remote Portlet

Rendering a Remote Portlet

Initial Steps on the Consumer

Initial Steps on the Producer

Final Steps on the Consumer

Interacting With a Remote Portlet

Initial Steps on the Consumer

Initial Steps on the Producer

Final Consumer Steps

Rendering Versus Interaction

Interportlet Communication with Events

Retrieving Render Dependencies

Summary of Federated Portal Architecture

For More Technical Details

Part II Development

Creating Remote Portlets, Pages, and Books

Introduction

What Types of Portlets Can Be Remote?

Creating a Remote Portlet

Overview

Setting Up the Example

Locating and Consuming a Portlet

Viewing the Portlet

Summary

Creating Remote Pages and Books

Basic Procedure

Configuring Remote Portlets

Applying a Look and Feel to a Remote Portlet

Modifying Modes and States in a Remote Portlet

What are Modes and States?

Modes and States in Remote Portlets

Changing Modes and States in Remote Portlets

Handling Errors in Remote Portlets

Configuring an Error Page in Workshop for WebLogic

Configuring an Error Page in the .portlet File

Setting Preferences on a Remote Portlet

What is a Portlet Preference?

Portlet Preferences and Remote Portlets

Viewing and Modifying Preferences

Working with Preferences Programatically

Additional Usage Notes and Restrictions

Managing Portlet Instances through Registration

Using Backing Files with Remote Portlets

Setting a Timeout Value on a Remote Portlet

Overview

Setting Default Timeout Values

Setting Timeouts for Individual Remote Portlets

Modifying WSRP Markup and Messages

Remote Portlet Properties

Proxy Portlet Properties

Other Portlet Properties

Offering Books, Pages, and Portlets to Consumers

Introduction

Offering Portlets on a Producer

Offering Books and Pages on a Producer

Setting Up the Example

Creating a Remoteable Page (or Book)

Summary

Rules for Creating Remoteable Books and Pages

Interportlet Communication with Remote Portlets

Introduction

Firing and Handling a Minimize Event

Setting Up Your Environment

Creating the Portlets on the Producer

Create the JSP Files and Portlets

Create the Backing File

Attach the Backing File

Add the Event Handler to bPortlet

Test the Application

Summary

Creating the Consumer Portlets

Setting Up the Exercise

Creating the Remote Portlet

Summary

Testing the Application

Build the Portal

Test the Portal

Inside the Remote Portlet File

Data Transfer with Custom Events

Retrieving the Event on the Producer

Firing the Event in the Consumer

Configuring a WebLogic Server Producer

Introduction

Using WSRP in a Basic WebLogic Server Domain

Create a WebLogic Server Domain

Extend the WebLogic Server Domain

Configuring a Web Project

Create a Web Project

Testing the Producer Configuration

Create a Server on the Producer

Test for a Producer WSDL

Create a Portlet in the Producer Web Application

Consuming a Producer Portlet

Summary

Disabling a WSRP Producer

Publishing to UDDI Registries

What is UDDI?

Using UDDI with WebLogic Portal

Configure the Producer

Configure the Consumer

Perform Searches

Configuring the Producer

What Information is Published?

Editing the Configuration File

Configuring Third-Party Registries

Specifying Access Credentials

Creating tModels for Third-Party Registries

Pre-Configuring the Business Entity

Auto-Configuring the Business Entity

Specifying Metadata for Searches

Adding Producer Metadata

Adding Portlet Metadata

Adding Book and Page Metadata

Enabling and Disabling UDDI for a Producer

Enabling and Disabling a Producer Web Application for UDDI Searches

Enabling and Disabling Individual Producer Resources for UDDI Searches

Configuring the Consumer

Searching for Producers Programatically

The UDDI Query API

Sample Code

The Interceptor Framework

Introduction

Use Cases

Basic Steps

Designing Interceptors

Interceptor Interfaces

Context Objects

Interfaces

Interface Methods

Interceptor Method Return Values

Configuring Interceptors

Order of Method Execution

Overview

Basic Order Of Execution in a Group

How Return Status Affects Execution Order

Instance Creation and Reuse

Example Chains

Implementing an Error-Handling Interceptor

Modifying an Error Message

Including an Error JSP Page

Federating User Profiles

Introduction

What are User Profiles?

User Profiles in Federated Portals

Platform for Privacy Preferences (P3P)

When to Use this Feature

Configuring the Producer

Configuring Java Portlets

Configuring the Deployment Descriptor (portlet.xml)

Retrieving User Information in a Java Portlet

Creating Default User Property Sets

Mapping User Properties

Configuring Non-Java Portlets

Configuring the Deployment Descriptor File

Handling User Property Extensions

Mapping User Information on the Consumer

Configuring the Consumer

Using a Mapping File

Using a Mapping Class

Writing the Mapping Class

Configuring the Mapping Class

Mapping Constants

P3P Examples

Example: portlet.xml file with P3P Attributes

Example: Retrieving P3P User Information in a Java Portlet

Example: Retrieving User Information in Other Portlets

Consumer Entitlement

Introduction

Configuring a Producer

Creating an Application Property Set

Editing the Producer Configuration File

Defining Consumer Entitlements

Registering a Consumer

Modifying Registration Properties

Transferring Custom Data

What is Custom Data Transfer?

Custom Data Transfer Interfaces

Performing Custom Data Transfer

Custom Data Transfer with a Complex Producer

Example Overview

Setting Up the Example

Creating the Producer JSP and Portlet

Federating zipTest.portlet to the Consumer

Creating a Backing File

Testing the Consumer Application

Custom Data Transfer in a Simple Producer

Transferring XML Data

Deploying Your Own Interface Implementations

General Guidelines

Implementation Rules

WSRP Interoperability With WebCenter Framework

Installing the Patch Set

Consuming WLP Portlets in WebCenter Framework and Oracle Portal Applications

Introduction

Understanding the Cause of User Authentication Errors

Preventing User Authentication Errors

Consuming WebCenter Framework Portlets in WebLogic Portal

Avoiding Cookie Collisions

Configuring Portlets That Use ADF Faces Rich Client Components

Use iframe_unwrapped

Disable html-amp-entity in WEB-INF/wlp-framework-common-config.xml

Use CSS Styling (Optional)

Set a Fixed Height on the Portlet's Contents (Optional)

Configuring Security

Interportlet Communication Considerations

Consuming Oracle ADF Faces Rich Client Component Portlets

Other Topics and Best Practices

Support for WSRP Versions

Enabling WSRP 2.0 Support for Consumers

If You Enable WSRP 2.0 Features for Consumers

WSRP Interoperability with WebCenter

Consuming WebCenter 10g ADF Faces Portlets in WLP

Enabling Compatibility for Clone and Destroy Portlet WSRP Methods

Decouple Rendering from Interaction

Avoid Interportlet Dependencies

Avoid Portal Layout Dependencies

Avoid Coupling by URL

Avoid Accessing Request Parameters in Rendering Code

Avoid Moving Producers

WebLogic Server Producers

Security for Remote Portlets

Error Handling

On the Producer

On the Consumer

Interceptors

Portlet Programming Guidelines and Best Practices

Designing for Performance

Performance Guidelines for Producers

Reorder Authentication Providers

Enable Attachment Support

Other Techniques

Performance Guidelines for Consumers

Using Local Proxy Mode

Why Use Local Proxy Mode?

Deployment Configuration

How Local Proxy Mode Works

When to Use and Not Use

Monitoring and Logging

Using the Monitor Servlet

Creating Custom Logs

Configuring Session Cookies

Using Different Cookie Names

Using a System Property

Blocking Cookies

User Sessions on CWEB Applications

Using Multiple Views with Remote Portlets

Handling User Identity Changes

Storing Registration Properties

Why Store Registration Properties?

Using the Administration Console

Using Workshop for WebLogic

Editing the WSRP WSDL Template File

Configuring a Custom JAX-RPC Handler

Configuring a Handler on the Consumer

Configuring a Handler on the Producer

Part III Staging

Establishing WSRP Security with SAML

SAML Security Between WebLogic Portal Domains

Overview

Setting Up the SAML Configuration Example

Configuring the Consumer

Generate a Key

Export the Key

Modify the Consumer’s Security Realm

Configuring the Producer

Import the Certificate

Configure the Asserting Party Properties

Testing the Configuration

SAML Security Between WebLogic Portal 8.1x and 9.2 or Later Versions

SAML Security Between 9.2 or Later Version Consumers and 8.1x Producers

Configuring the Consumer

Generate a Key

Change the Consumer’s Name

Modify the Consumer’s Security Realm

Configure the WebLogic Portal 8.1x Producer

Import the Certificate

Test the Configuration

Summary

SAML Security Between 8.1x Consumers and 9.2 or Later Version Producers

Configure the 8.1x Consumer

Generate a Key

Configure the 9.2 or Later Version Producer

Testing the Configuration

Using SAML Security with a Name Mapper

Writing a Name Mapper Class

Implementing SAMLCredentialNameMapper on the Consumer

Implementing SAMLIdentityAssertionNameMapper on the Producer

Deploying the Mapper Classes

Configuring the Mapper Classes

Adding a Mapper Class to the Producer

Adding a Mapper Class to the Consumer

Allowing Virtual Users

Configuring WSRP Security Between WLP and WebCenter Framework

Introduction

SAML Security Between a WebCenter Framework Consumer and a WebLogic Portal Producer

Configuring the Consumer

Generate a Key Pair

Export the Public Key Certificate

Configuring the Producer

Import the Public Key Certificate Into The Producer Domain's Trust Key Store

Modify the WSDL Templates in the Producer Web-App

Modify the Web Services Policy Configuration in the Producer Web-App

Add a New Asserting Party to the SAML Identity Asserter

Register the WebLogic Portal Producer with the WebCenter Consumer

Test the Configuration

SAML Security Between a WebLogic Portal Consumer and a WebCenter Framework Producer

Register the WebCenter Framework Producer with the WebLogic Portal Consumer

Add an Authentication Mechanism To Your Portal

Configure the WebLogic Portal Consumer

Generate a Key Pair

Export the Public Key Certificate

Import the Public Key Certificate Into The Consumer Domain's Trust Key Store

Add a New Policy to the Consumer Web-App

Update the Producer's Security Policy on the Consumer

Modify the Consumer's SAMLCredentialMapper

Configure the Consumer's PKI Credential Mapping Provider

Create a New PKI Credential Mapping to the Consumer

Configuring the WebCenter Framework Producer

(Optional) Additional Configuration for a WebLogic Portal Consumer

Register the WebLogic Portal producer with the WebLogic Portal Consumer

Update the Producer's Security Policy on the Consumer

Create a New PKI Credential Mapping to the Consumer

Configuring User Name Token Security

Configuring the Consumer

Configuring the Producer

Summary

Adding Remote Resources to the Library

Introduction

Adding a Producer

Adding a Remote Portlet to the Portal Library

Adding a Remote Page to the Portal Library

Adding a Remote Book to the Portal Library

Part IV Production

Managing Federated Portals

Modifying the Consumer Security Configuration

Changing the Web Application

Modifying Global Credentials

Modifying Producer Credentials

Modifying the Producer Portlet Registry

Changing the Web Application

Modifying the Registry Credentials

Modifying Producer Registration Properties