Contents


Preface

Who Should Use This Book
How This Book Is Organized
Documentation
Using UNIX Commands
What Typographic Conventions Mean
Shell Prompts in Command Examples

Chapter 1 Overview of the APIs

Extending iPlanet Portal Server
The iPlanet Portal Server APIs

Which APIs to Use?

Understanding iPlanet Portal Server APIs
Identify Needed iPlanet Portal Server APIs

Content Provider API
Profile and Policy API
Session API
Log API

Integrating an Application with iPlanet Portal Server Software

Chapter 2 Session API

Session API Overview
Implementing the Session API

Using the Session API

Session API Transport Protocol

Session API Message Format
Session API Classes and Interfaces
Sample Session Code

Instructions for using the HelloServlet

Import the iPlanet Portal Server Classes
Sample Code

Chapter 3 Profile and Policy API

Profile and Policy API Overview
Profile and Policy API Functionality
Implementing the Profile and Policy API

Profile and Policy API Classes and Interfaces
Interactions, Assumptions, and Dependencies
Exception Handling

Using the Profile and Policy API

Getting Attribute Values
Setting Attribute Values
Checking Policy (Using Boolean Privileges)
Checking Policy (Using List Privileges)

Import the iPlanet Portal Server Classes
Sample Code

Chapter 4 Log API

Log API Overview
Implementing the Log API

iPlanet Portal Server Classes

Log API Functionality

Creating Logs
Deleting Logs
Writing to a Log
Reading from a Log
Log List Retrieval
Querying Logs
Sample Code

Chapter 5 Content Provider API

Content Provider Overview

Content Provider Functionality

Using the Sample Providers

Compiling Sample Provider Code

Implementing the Content Provider API

Provider Sample Code

Chapter 6 Pluggable Authentication API

Pluggable Authentication API Overview
Authentication Process Overview
Understanding the .properties File
Writing a Pluggable Authentication Module

Requirements
Recommendations

About using helpers

Integrating the Module
Sample Code

Sample Properties File
Sample Login Module Source
Sample XML File

Chapter 7 Single Signon

Single Signon Overview

Special Cases

Instructions for using Single Signon

Command Line Example
Include the iPlanet Portal Server Classes

Chapter 8 Using the Command Line Interface

Command Line Inferface Overview
How it Works
ipsadmin Command

Usage

Using ipsadmin

Importing a New Component
Creating a New Domain
Creating a New Role
Creating a New User and Assigning a Role
Reading (Getting) a Profile
Changing a Profile
Deleting a Profile

Sample Code

Chapter 9 Using the iPlanet Portal Server APIs

Instructions for using the HelloServlet

HelloServlet Properties
HelloServlet XML
Prints HTML Output

Setting Privileges

Attributes and Privileges
Initializing the Servlet

Session API Examples

HTTP Request and Response
Session Event
Get a Session

Profile API Examples

Modify an Attribute
Get User Profile
Policy Checking

Log API Example

Method handles Logging

Chapter 10 HTML Templates

Setting up Login Pages for Different Domains

How Authentication Templates Work

Templates for Customizing the Authentication Pages

How Desktop Templates Work

Templates for Customizing the iPlanet Portal Server Desktop

Appendix A HTTP/XML Interface

HTTP/XML Interface Overview

Exchanging Information Between the Client and the Server

XML DTDs

PLL Request Set DTD
PLL Response Set DTD
PLL Notification Set DTD
Naming Response DTD
Naming Request DTD
Naming Request XML
Naming Response XML

Session-Related DTD and XML

SessionNotification DTD
Session Request DTD
Session Response DTD
Session Request XML
Session Response XML

Profile and Policy-related DTD and XML

Getting an Attribute Value Using XML

Log-related DTDs

DTD for Log API Communication

Appendix B Putting Code Together

Building an iPlanet Portal Server Provider

Define Specific Requirements and Functionality
Identify non-iPlanet Portal Server Functionality
Define Application Attributes/Privileges
Define the Provider to iPlanet Portal Server

Sample Code

Appendix C iPlanet Portal Server API Exceptions

Profile API Exceptions
Log API Exceptions
Session API Exceptions

Glossary

Index