This guide discusses how to use Netscape Server Application Programmer's Interface (NSAPI) to build plug-ins that define Server Application Functions (SAFs) to extend and modify SunTM JavaTM System Web Server 7.0. The guide also provides a reference of the NSAPI functions you can use to define new plug-ins.
The intended audience for this guide is the person who develops, assembles, and deploys NSAPI plug-ins in a corporate enterprise. This guide assumes you are familiar with the following topics:
HTTP
HTML
NSAPI
C programming
Software development processes, including debugging and source code control
The Web Server documentation set describes how to install and administer the Web Server. You can access Web Server 7.0 Update 6 documentation at http://docs.sun.com/coll/1653.6.
The Sun Java System Web Server documents are now in wiki format at http://wikis.sun.com/display/WebServerdocs/Home. This wiki is intended to promote collaboration and contribution on documentation content for Web Server. You are welcome to contribute, by posting your comments or by directly editing the wiki page, as long as the content is relevant to an appropriate standard.
For an introduction to Web Server 7.0, refer to the books in the order in which they are listed in the following table.
Table P–1 Books in the Web Server Documentation Set
Documentation Title |
Contents |
---|---|
This wiki is intended to promote collaboration and contribution on documentation content for Web Server. |
|
Sun Java System Web Server 7.0 Update 6 Documentation Center |
Web Server documentation topics organized by tasks and subject |
|
|
Sun Java System Web Server 7.0 Update 6 Installation and Migration Guide |
Performing installation and migration tasks:
|
Sun Java System Web Server 7.0 Update 6 Administrator’s Guide |
Performing the following administration tasks:
|
Using programming technologies and APIs to do the following:
|
|
Sun Java System Web Server 7.0 Update 6 NSAPI Developer’s Guide |
Creating custom Netscape Server Application Programmer’s Interface (NSAPI) plug-ins |
Sun Java System Web Server 7.0 Update 6 Developer’s Guide to Java Web Applications |
Implementing Java Servlets and JavaServer PagesTM (JSPTM) technology in Sun Java System Web Server |
Sun Java System Web Server 7.0 Update 6 Administrator’s Configuration File Reference |
Editing configuration files |
Sun Java System Web Server 7.0 Update 6 Performance Tuning, Sizing, and Scaling Guide |
Tuning Sun Java System Web Server to optimize performance |
Sun Java System Web Server 7.0 Update 6 Troubleshooting Guide |
Troubleshooting Web Server |
Sun Java System Web Server 7.0 Update 6 CLI Reference Manual |
Administration commands that allow you to administer the Web Server through the CLI |
The URL for all documentation about Sun Java Enterprise System (Java ES) and its components is at http://docs.sun.com/coll/1286.3.
The following table describes the default paths and file names that are used in this book.
Table P–2 Default Paths and File Names
Placeholder |
Description |
Default Value |
---|---|---|
install-dir |
Represents the base installation directory for Web Server 7.0 |
Sun Java Enterprise System (Java ES) installations on the SolarisTM platform: /opt/SUNWwbsvr7 Java ES installations on the Linux and HP-UX platform: /opt/sun/webserver/ Java ES installations on the Windows platform: system-drive:\Program Files\Sun\JavaES5\WebServer7 Other Solaris, Linux, and HP-UX installations, non-root user: home-directory/sun/webserver7 Other Solaris, Linux, and HP-UX installations, root user: /sun/webserver7 Windows, all installations: system-drive:\Program Files\Sun\WebServer7 |
instance-dir |
Directory that contains the instance-specific subdirectories. |
For Java ES installations, the default location for instances on Solaris: /var/opt/SUNWwbsvr7 For Java ES installations, the default location for instances on Linux and HP-UX: /var/opt/sun/webserver7 For Java ES installations, the default location for instance on Windows: system-drive:\Program Files\Sun\JavaES5\WebServer7 For stand-alone installations, the default location for instance on Solaris, Linux, and HP-UX:install-dir For stand-alone installations, the default location for instance on Windows: system-drive:\Program Files\sun\WebServer7 |
The following table describes the typographic changes that are used in this book.
Table P–3 Typographic Conventions
Typeface |
Meaning |
Example |
---|---|---|
AaBbCc123 |
The names of commands, files, and directories, and onscreen computer output |
Edit your .login file. Use ls -a to list all files. machine_name% you have mail. |
AaBbCc123 |
What you type, contrasted with onscreen computer output |
machine_name% su Password: |
AaBbCc123 |
A placeholder to be replaced with a real name or value |
The command to remove a file is rm filename. |
AaBbCc123 |
Book titles, new terms, and terms to be emphasized (note that some emphasized items appear bold online) |
Read Chapter 6 in the User's Guide. A cache is a copy that is stored locally. Do not save the file. |
The following table explains symbols that might be used in this book.
Table P–4 Symbol Conventions
Symbol |
Description |
Example |
Meaning |
---|---|---|---|
[ ] |
Contains optional arguments and command options. |
ls [-l] |
The -l option is not required. |
{ | } |
Contains a set of choices for a required command option. |
-d {y|n} |
The -d option requires that you use either the y argument or the n argument. |
${ } |
Indicates a variable reference. |
${com.sun.javaRoot} |
References the value of the com.sun.javaRoot variable. |
- |
Joins simultaneous multiple keystrokes. |
Control-A |
Press the Control key while you press the A key. |
+ |
Joins consecutive multiple keystrokes. |
Ctrl+A+N |
Press the Control key, release it, and then press the subsequent keys. |
-> |
Indicates menu item selection in a graphical user interface. |
File -> New -> Templates |
From the File menu, choose New. From the New submenu, choose Templates. |
The Sun web site provides information about the following additional resources:
Besides searching Sun product documentation from the docs.sun.comSM web site, you can use a search engine by typing the following syntax in the search field:
search-term site:docs.sun.com |
For example, to search for “broker,” type the following:
broker site:docs.sun.com |
To include other Sun web sites in your search (for example, java.sun.com, www.sun.com, and developers.sun.com), use sun.com in place of docs.sun.com in the search field.
Third-party URLs are referenced in this document and provide additional, related information.
Sun 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 is interested in improving its documentation and welcomes your comments and suggestions. To share your comments:
Go to http://docs.sun.com and click Feedback.
Go to http://wikis.sun.com/display/WebServerdocs/Home and post your comments or directly edit the wiki page.