Sun Java logo     Copyright      Index      Next     

Sun logo
Sun Java System Portal Server 6 2004Q2 Developer's Guide 

Contents


About This Guide
Who Should Read This Book
What You Need to Know
How This Book is Organized
Document Conventions Used in This Guide
Monospaced Font
Bold Monospaced Font
Italicized Font
Command-Line Prompts
Where to Find Related Information
Where to Find This Guide Online

Chapter 1   Introduction to the APIs
Overview
What Is a Portal?
Desktop and Desktop Hierarchy
Display Profile
Search Engine
Software Services
Application Development
Software Architecture
Overview of the APIs
Desktop APIs
Provider API
Building Blocks
Desktop Servlet
How Concepts in the Provider API Map to the Identity Server Software
Search APIs
Authentication APIs
Portal Environment
Web Container
File System

Part I Overview

Chapter 2   Overview of the Provider API (PAPI)
Introduction
The Provider API
Provider
ProviderAdapter
ProfileProviderAdapter
ProviderContext
ProviderWidths
ProviderEditTypes
PropertiesFilter
Exceptions
The Provider Life Cycle

Chapter 3   Overview of the Desktop Servlet
Introduction
DesktopServlet Actions
Action content
Action edit
Action process
Action logout

Chapter 4   Overview of the Leaf Providers
Introduction
JSPProvider
URLScraperProvider
XMLProvider

Chapter 5   Overview of the Container Providers
The ContainerProvider Architecture
Overview of the ContainerProviders
ContainerProvider
ContainerProviderContext
ContainerProviderAdapter
JSPContainerProviderAdapter
JSPSingleContainerProvider
JSPTableContainerProvider
TabContainer
JSPTabContainerProvider

Chapter 6   Overview of Implementing a Custom Provider
Introduction
Defining Specific Requirements and Functionality
Application Specific Requirements
Presentation Method
Provider-specific Properties
Developing the Provider Class File
Provider Class File Location
Provider Class File
Provider Class Loader
Creating XML Fragments for Display Profile
Installing the Provider
Installing Manually
Transporting Using the par Utility

Part II Extending the Providers

Chapter 7   Extending the Base Providers
Implementing the Provider Interface
Extending the ProviderAdapter Class
Extending the ProfileProviderAdapter Class
Example 1
Example 2
Extending the PropertiesFilter Class

Chapter 8   Extending the Leaf Providers
Extending the JSPProvider
Example 1
Example 2
Extending the URLScraperProvider
Extending the XMLProvider

Chapter 9   Extending the Container Providers
Extending the JSPSingleContainerProvider
Extending the JSPTableContainerProvider
Extending the JSPTabContainerProvider

Chapter 10   Creating a Custom ContainerProvider
Part III Portlets

Chapter 11   Overview of the Portlets
What is a Portlet?
Overview of Developing and Deploying Portlets

Chapter 12   Extending the GenericPortlet Abstract Class
Developing the Class File
Compiling the Portlet
Creating a Portlet Web Application
Deploying the Application
Creating Channels from the Deployed Portlets

Chapter 13   Converting Providers to Portlets
Developing the Class File
Mapping ProviderAdapter to GenericPortlet
Sample Code Fragments for Provider to Portlet Conversion
Compiling the Portlet
Creating a Portlet Web Application
Deploying the Application
Creating Channels from the Deployed Portlets

Part IV WSRP

Chapter 14   Validating Registration Data
Overview
Registering with the Producer
Validating the Registration Data
The RegistrationValidator Interface
Default Implementation

Chapter 15   Defining Custom Registration Validators
Implementing the RegistrationValidator Interface
Installing the Class File
Customizing the Return Codes
Configuring the Producer’s Registration Validator

Part V Search Engine Robot

Chapter 16   Search Engine Robot Overview
Introduction
How the Robot Works
Robot Configuration Files
The Filtering Process
Stages in the Filter Process

Chapter 17   Robot Completion Scripts
Introduction
Monitoring cmdHook Execution
Preparing Your Completion Script to Appear in the Administration Interface

Chapter 18   Overview of the Robot Application Functions
Introduction
Robot Plug-in API Overview
The Robot Application Function Header Files
Header File Hierarchy
Header File Contents

Chapter 19   Writing New Robot Application Functions
Introduction
RAF Prototype
Writing Functions for Specific Directives
Passing Parameters to Robot Application Functions
Working with Parameter Blocks
Getting Information on the Processed Resource
Returning a Response Status Code
Reporting Errors to the Robot Log File
RAF Definition Example
Compiling and Linking your Code
Loading Your Shared Object
Using your New Robot Application Functions

Part VI Using the SOIF API to Work with SOIF Objects

Chapter 20   Overview of the SOIF API
Introduction
What is SOIF?
Using the SOIF API
An Introductory Example
Getting Search Server Database Contents as a SOIFStream

Chapter 21   SOIF API
Functions and Objects
SOIF Structure
Attribute-Value Pair Routines
Multi-valued Attribute Routines
Stream Routines for Parsing and Printing SOIFs
Filtering SOIF Objects
Memory Buffer Management

Part VII Using the RDM API to Access the Search Engine and Database in C

Chapter 22   What is an RDM?
Introduction
RDM Format Syntax
RDM Header
RDM Body

Chapter 23   About the RDM API
Introduction
rdm.h File
API Reference
Finding the RDM Version
Creating and Freeing RDM Structures
RDMHeader
RDMQuery
Other RDM Structures

Chapter 24   Example of Submitting a Query
Introduction
RDMHeader and RDMQuery Object Parameters
Running the Example

Part VIII Using Java To Access the Search Engine Database

Chapter 25   Overview of the Search Engine Java SDK
Introduction
The Search Engine Java SDK
Running the Sample Applications

Chapter 26   Using Java To Access the Search Server Database
Creating a Search Object
Executing A Query and Getting the Results
Working Through An Example Search Application
Import the Necessary Classes
Define the SearchDemo Class
Define the SimpleSearch Class
Execute the Search Query
Display the Results

Chapter 27   Using Java To Add Entries to the Search Engine Database
rdmgr
SOIF Object
Constructing and Submitting a Request
Constructing a Request
Submitting a Request

Part IX Localizing Sun Java System Portal Server

Chapter 28   Templates and JSPs
Desktop Templates
Template Files
JSPs
Images
File Lookup Mechanism

Chapter 29   Properties
Resource Bundles
File Naming Convention
File Installation Location
File Entries Format
Resource Bundle Access
Display Profile

Chapter 30   Localization Support in PAPI
Glossary

Index


Copyright      Index      Next     


Copyright 2004 Sun Microsystems, Inc. All rights reserved.