| Sun ONE Portal Server 6.2 Developer's Guide |
About This Guide
This guide explains how to use the Sun™ ONE Portal Server 6.2 software APIs. Sun ONE Portal Server software provides a platform to create portals for your organization’s integrated data, knowledge management, and applications. The Sun ONE Portal Server software platform offers a complete infrastructure solution for building and deploying all types of portals, including business-to-business, business-to-employee, and business-to-consumer.
This preface includes the following sections:
Who Should Read This BookYou should read this book if you are responsible for customizing and extending the Sun ONE Portal Server software APIs.
What You Need to KnowThis book assumes that you are familiar with the following products:
This book assumes you already know the basics of:
How This Book is OrganizedThis book contains the following chapters:
(this chapter)
Chapter 1, "Introduction to the APIs"
This chapter provides an introduction to the Sun ONE Portal Server APIs.
Chapter 2, "Using Provider API (PAPI)"
This chapter provides an introduction to the base PAPI interfaces, classes, and exceptions, and includes instructions for implementing a custom provider by extending the PAPI.
Chapter 3, "Extending the Base Providers"
This chapter provides instructions for implementing a custom provider by extending the PAPI base classes.
Chapter 4, "Using Leaf Providers"
This chapter provides an introduction to the leaf providers and includes sample customizations to methods in the leaf provider classes.
Chapter 5, "Using the Container Providers"
This chapter provides an introduction to the container providers and includes instructions for developing a custom ContainerProvider.
Chapter 6, "Developing and Deploying Portlets"
This chapter provides instructions for developing portlets.
Chapter 7, "Using the SOIF API to Work with SOIF Objects"
This chapter describes the use of the search engine SOIF API to work with SOIF objects in C.
Chapter 8, "Search Engine Robot"
This chapter describes the Search Engine Robot and the application programming interface (API) used to create plug-in robot application functions (RAFs).
Chapter 9, "Using the RDM API to Access the Search Engine and Database in C"
This chapter describes the use of the Search Engine RDM API to access the Search Engine and its database.
Chapter 10, "Using Java to Access the Search Engine Database"
This chapter describes how to submit queries and add entries to the Search Engine database by using the Java programming language.
Chapter 11, "Localizing Sun ONE Portal Server"
This chapter provides instructions for localizing the customizable parts of Sun ONE Portal Server software.
Document Conventions Used in This GuideMonospaced Font
Monospaced font is used for any text that appears on the computer screen or text that you should type. It is also used for file names, distinguished names, functions, and examples.
Bold Monospaced Font
Bold monospaced font is used to represent text within a code example that you should type. For example, you might see something like this:
portal-server-install-root/SUNWps/bin/dpadmin add -p parent -u amadmin_dn -w password -d node dp-locale.xml
Italicized Font
Italicized font is used to represent text that you enter using information that is unique to your installation (for example, variables). It is used for server paths and names and account IDs.
Command-Line Prompts
Command-line prompts (for example, % for a C-Shell, or $ for a Korn, or Bourne shell) are not displayed in the examples. Depending on which operating system environment you are using, you will see a variety of different command-line prompts. However, you should enter the command as it appears in the document unless specifically noted otherwise.
Where to Find Related InformationIn addition to this guide, SunTM ONE Portal Server comes with supplementary information for administrators as well as documentation for developers. Use the following URL to see all the Sun ONE Portal Server software documentation:
http://docs.sun.com/prod/s1portalsrv
Use this book in conjunction with the Javadocs at http://hostname:port/URI/javadocs. Listed below are the additional documents that are available:
Sun ONE Portal Server 6.2 Deployment Guide
Sun ONE Portal Server 6.2 Installation Guide
Sun ONE Portal Server 6.2 Migration Guide
Sun ONE Portal Server 6.2 Administrator’s Guide
Sun ONE Portal Server, Secure Remote Access 6.2 Administrator’s Guide
Sun ONE Portal Server 6.2 Desktop Customization Guide
Sun ONE Portal Server 6.2 Release Notes
Where to Find This Guide OnlineYou can find the Sun ONE Portal Server 6.2 Developer’s Guide online in PDF and HTML formats. This book can be found at the following URL:
http://docs.sun.com/prod/s1portalsrv
