|
| |
| Sun Java System Portal Server 6 2005Q1 Developer's Guide | |
Preface
This Developer’s Guide provides a high-level overview of the Sun JavaTM System Portal Server software APIs. This book explains how to extend and customize the software APIs.
Who Should Use This BookThis Developer’s Guide is intended for use by developers and individuals who are responsible for customizing the software APIs and creating custom providers and portlets for use with their deployment environment.
Portal Server developers should already understand the following technologies:
Also, this book assumes that you already know the basics of the Solaris Operating Environment and UNIX command-line utilities and administrative tasks.
Before You Read This BookPortal Server is a component of Sun Java Enterprise System, a software infrastructure that supports enterprise applications distributed across a network or Internet environment. You should be familiar with the documentation provided with Sun Java Enterprise System, which can be accessed online at http://docs.sun.com/coll/entsys_05q1.
Because the Portal Server software components work together with Sun JavaTM System Access Manager for user, service, and policy management and authentication, single sign-on, and logging services, you should be familiar with the documentation provided with that product. Access Manager software documentation can be accessed online at http://docs.sun.com/doc.
Because Sun JavaTM System Directory Server is used as the data store for primary configuration information and user profile data in a Portal Server deployment, you should be familiar with the documentation provided with that product. Directory Server software documentation can be accessed online at http://docs.sun.com/coll/DirectoryServer_05q1.
How This Book Is OrganizedThe first chapter of this book provides an introduction to the Portal Server APIs. The rest of the book is divided into parts. The following table summarizes the content of this book.
Table 0-1 How This Book Is Organized
Chapter
Description
This chapter provides an introduction to the Portal Server APIs.
Provides an overview of the various public extensible set of classes in the Portal Server software. The chapters provide:
- An introduction to the base PAPI interfaces, classes, exceptions, and an overview of the DesktopServlet, and introduction to the building-block leaf and container providers.
- A description of the development process for a Portal Server software provider. It touches on the public APIs available for integrating an application with the Portal Server software Desktop via the provider.
Provides instructions for
Provides:
Provides instructions for creating custom registration validators.
Describes the:
Describes the use of the search engine SOIF API to work with SOIF objects in C.
Part VII, "Using the RDM API to Access the Search Engine and Database in C"
Describes the use of the Search Engine RDM API to access the Search Engine and its database.
Part VIII, "Using Java To Access the Search Engine Database"
Describes how to:
Provides instructions for localizing the customizeable parts of the Portal Server software.
Conventions Used in This Book
The tables in this section describe the conventions used in this book.
Typographic Conventions
The following table describes the typographic changes used in this book.
Symbols
The following table describes the symbol conventions used in this book.
Default Paths and File Names
The following table describes the default paths and file names used in this book.
Shell Prompts
The following table describes the various shell prompts.
Command-line prompts 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.
Related DocumentationThe http://docs.sun.comSM web site enables you to access Sun technical documentation online. You can browse the archive or search for a specific book title or subject.
Books in This Documentation Set
The following table summarizes the books included in the Portal Server software documentation set.
Other Server Documentation
For other server documentation, go to the following:
Accessing Sun Resources OnlineFor product downloads, professional services, patches and support, and additional developer information, go to the following:
Contacting Sun Technical SupportIf you have technical questions about this product that are not answered in the product documentation, go to http://www.sun.com/service/contacting.
Related Third-Party Web Site ReferencesSun is not responsible for the availability of third-party web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through such sites or resources.
Sun Welcomes Your CommentsSun is interested in improving its documentation and welcomes your comments and suggestions.
To share your comments, go to http://docs.sun.com and click Send Comments. In the online form, provide the document title and part number. The part number is a seven-digit or nine-digit number that can be found on the title page of the book or at the top of the document. For example, the title of this book is Sun Java System Portal Server Developer’s Guide and the part number is 817-7695.