Documentation Home
> Sun Java System Portal Server 7 Developer's Guide
Sun Java System Portal Server 7 Developer's Guide
Book Information
Preface
Chapter 1 Introduction to the APIs
Overview of Portal Server Software
What Is a Portal?
Sample Desktop and Desktop Hierarchy
Providers and Channels
Portlets and Web Service for Remote Portlets
Portal Server Software Desktop
Display Profile
Search Engine
Access Manager 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 Access Manager Software
Search APIs
Search Robot
Search Database
Authentication APIs
Portal Environment
Web Container
File System
Chapter 2 Overview of the Provider API (PAPI)
Introduction to the Provider API
The Provider API
Provider Interface
ProviderAdapter Class
ProfileProviderAdapter Class
ProviderContext Interface
ProviderWidths Interface
ProviderEditTypes Interface
PropertiesFilter Class
Provider Exceptions
ProviderException Class
AsciiFormInputExpectedException Exception
InvalidEditFormDataException Exception
UnknownEditTypeException Exception
The Provider Life Cycle
Chapter 3 Overview of the Desktop Servlet
Introduction to DesktopServlet
DesktopServlet Actions
Action content
Action edit
DesktopServlet Legacy edit Action
DesktopServlet edit Action
Action process
DesktopServlet Legacy process Action
DesktopServlet process Action
Action logout
Chapter 4 Overview of the Leaf Providers
Introduction to Leaf Providers
The JSPProvider
The URLScraperProvider
The XMLProvider
Chapter 5 Overview of the Container Providers
The ContainerProvider Architecture
Overview of the ContainerProviders
ContainerProvider Interface
ContainerProviderContext Interface
ContainerProviderAdapter Class
JSPContainerProviderAdapter Class
JSPSingleContainerProvider Class
Introduction to JSPSingleContainerProvider
Using the JSPSingleContainerProvider
The JSPSingleContainerProvider Class
JSPTableContainerProvider Class
Introduction to JSPTableContainerProvider
Using the JSPTableContainerProvider
The TabContainer
UnmodifiableTab Interface
ModifiableTab Interface
JSPTabContainerProvider Class
Chapter 6 Overview of Implementing a Custom Provider
Overview of Defining a Custom Provider
Defining Specific Requirements and Functionality
Application Specific Requirements
Presentation Method
Provider-specific Properties
Properties in Display Profile
Properties in Resource bundle
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
To install the provider manually:
Transporting Using the psadmin Utility
Chapter 7 Extending the Base Providers
Implementing the Provider Interface
To create a custom provider by implementing the Provider interface
Extending the ProviderAdapter Class
To create a custom provider by extending the ProviderAdapter class
Extending the ProfileProviderAdapter Class
To Create a Provider by Extending the ProfileProviderAdapter Class
To Create a Provider by Extending the ProfileProviderAdapter Class
Extending the PropertiesFilter Class
To create a custom filter by extending the PropertiesFilter class
Chapter 8 Extending the Leaf Providers
Extending the JSPProvider
Example 1
To Extend the JSPProvider
Example 2
To Develop the SimpleUserInfoProvider
Extending the URLScraperProvider
To Extend the URLScraperProvider
Extending the XMLProvider
To Extend the XMLProvider
Chapter 9 Extending the Container Providers
Extending the JSPSingleContainerProvider
To Develop the CustomSingleContainerProvider
Extending the JSPTableContainerProvider
Example 1: Developing CustomTableContainerProvider
To Develop the CustomTableContainerProvider
Example 2: Developing SpanTableContainerProvider
To Develop the SpanTableContainerProvider
Customizing the Row Layout
To Develop the CustomTCProvider
Customizing the Column Widths
To Develop the CustomJSPTableContainerProvider
Extending the JSPTabContainerProvider
To Develop the CustomTabContainerProvider
Chapter 10 Creating a Custom ContainerProvider
Creating a Custom ContainerProvider
To Develop the RouterContainerProvider
Chapter 11 Overview of the Portlets
What is a Portlet?
Overview of Developing and Deploying Portlets
To develop and deploy portlets
Chapter 12 Extending the GenericPortlet Abstract Class
Introduction to Extending the GenericPortlet Abstract Class
Developing the Class File
GenericPortlet Class
Methods to Override
Render Request Processing
Action Request Processing
Portlet Preferences
Example Portlet Class File
Compiling the Portlet
Creating a Portlet Web Application
To create a portlet web application:
Deploying the Application
Creating Channels from the Deployed Portlets
Debugging the Portlet
Chapter 13 Converting Providers to Portlets
Introduction to Converting Providers to Portlets
Mapping ProviderAdapter to GenericPortlet
Sample Code Fragments for Provider to Portlet Conversion
Provider to Portlet Mapping
Dispatching to a JSP
Help Documentation
Title Mapping
editType Property
PortletPreferences Mapping
Chapter 14 WSRP: Validating Registration Data
Overview of WSRP Communication
Registering with the Producer
Validating the Registration Data
The RegistrationValidator Interface
Default Implementation
Chapter 15 WSRP: Defining Custom Registration Validators
Implementing the RegistrationValidator Interface
To Develop the DefaultRegistrationValidator
Installing the Class File
To install via the web container WAR file:
Customizing the Return Codes
To customize the return codes:
Configuring the Producer’s Registration Validator
To administer the producer:
Chapter 16 Search Engine Robot Overview
Introduction to the Search Engine Robot
How the Robot Works
Robot Configuration Files
The Filtering Process
Stages in the Filter Process
Chapter 17 Robot Completion Scripts
Introduction to Robot Completion Scripts
Monitoring cmdHook Execution
Preparing Your Completion Script to Appear in the Administration Interface
Chapter 18 Overview of the Robot Application Functions
Introduction to Robot Application Functions
Robot Plug-in API Overview
To Create Custom Plug-In Functions
The Robot Application Function Header Files
Header File Hierarchy
Header File Contents
Chapter 19 Writing New Robot Application Functions
Overview of Writing Robot Application Functions
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
Chapter 20 Overview of the SOIF API
Introduction to the SOIF API
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
Chapter 22 Overview of RDM
Introduction to RDM
RDM Format Syntax
RDM Header
RDM Body
Chapter 23 About the RDM API
Introduction to the RDM API
rdm.h File
API Reference
Finding the RDM Version
Creating and Freeing RDM Structures
An RDMHeader
An RDMQuery
Other RDM Structures
Chapter 24 Example of Submitting a Query
Overview of Submitting a Query
RDMHeader and RDMQuery Object Parameters
Running the Example
To Run the Example
Chapter 25 Overview of the Search Engine Java SDK
Introduction to Search Engine Java SDK
The Search Engine Java SDK
Running the Sample Applications
To Install and Run the Search Demo Command Line Program
To Install and Run the Search Demo Applet
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 Command
SOIF Object
Constructing and Submitting a Request
Constructing a Request
Submitting a Request
Submit Operations
Submit Types
Chapter 28 Federated Search samples in Search SDK
Federated Search samples in Search SDK
Chapter 29 Developing a New Database or Search Engine Connector
Developing a New Search Engine Connector
To Develop a New Federated Search Connector
Chapter 30 Localization: Templates and JSPs
Desktop Templates
Template Files
JavaServer Pages
Image Files
File Lookup Mechanism
Chapter 31 Localization: Properties
Resource Bundles
Introduction to Resource Bundles
File Naming Convention
File Installation Location
File Entries Format
Resource Bundle Access
Display Profile Properties
To Localize the User Information Channel Display Profile
Chapter 32 Localization Support in PAPI
Localization Support in ProviderContext
Localization Support in ProfileProviderAdapter
© 2010, Oracle Corporation and/or its affiliates