This guide describes how to configure and administer the Sun JavaTM System Web Proxy Server 4, formerly known as Sun ONETM Web Proxy Server and iPlanetTM Web Proxy Server and hereafter referred to as Sun Java System Web Proxy Server or just Proxy Server.
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
Sun Java System Web Proxy Server can be purchased by itself or as a component of Sun Java Enterprise System, a software infrastructure that supports enterprise applications distributed across a network or Internet environment. If you purchased Sun Java System Web Proxy Server as a component of Java Enterprise System, you should be familiar with the system documentation at http://docs.sun.com/coll/1286.2.
The following table lists the chapters in the guide and their contents.
Table P–1 Guide Organization
Chapter |
Description |
This chapter discusses how to create your own plug-ins that define new SAFs to modify or extend the way the server handles requests. |
|
This chapter discusses how to create custom filters that you can use to intercept, and potentially modify, incoming content presented to or generated by another function. |
|
This chapter provides examples of custom SAFs to use at each stage in the request-handling process. |
|
This chapter presents a reference of the NSAPI functions. You use NSAPI functions to define SAFs. |
|
This chapter discusses some of the commonly used NSAPI data structures. |
|
This chapter lists the wildcard patterns you can use when specifying values in obj.conf and various predefined SAFs. |
|
This chapter lists time formats. |
|
This chapter gives an overview of HTTP. |
|
This appendix provides an alphabetical list of NSAPI functions and macros. |
The documentation set lists the Sun documents that are related to Proxy Server. The URL for Sun Java System Web Proxy Server 4.0.12 documentation is http://docs.sun.com/coll/1311.12. For an introduction to Proxy Server, refer to the books in the order in which they are listed in the following table.
Table P–2 Sun Java System Web Proxy Server Documentation
Document Title |
Contents |
---|---|
The Proxy Server release:
|
|
Sun Java System Web Proxy Server 4.0.12 Installation and Migration Guide |
Performing installation and migration tasks:
|
Sun Java System Web Proxy Server 4.0.12 Administration Guide |
Performing administration and management tasks:
|
Sun Java System Web Proxy Server 4.0.12 Configuration File Reference |
Editing configuration files |
Sun Java System Web Proxy Server 4.0.12 NSAPI Developer’s Guide |
Creating custom Netscape Server Application Programmer’s Interface (NSAPI) plug-ins |
Sun Java System Web Proxy Server 4.0.12 Performance Tuning, Sizing, and Scaling Guide |
Tuning Sun Java System Web Proxy Server to optimize performance |
The URL for all documentation about Sun Java Enterprise System (Java ES) and its components is http://docs.sun.com/prod/entsys.5.
The following table describes the default paths and file names that are used in this book.
Table P–3 Default Paths and File Names
Placeholder |
Description |
Default Value |
---|---|---|
install-dir |
Represents the base installation directory for Sun Java System Web Proxy Server. |
Solaris and Linux installations: /opt/sun/proxyserver40 Windows installations: \Sun\ProxyServer40 |
The following table describes the typographic changes that are used in this book.
Table P–4 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 shows default system prompts and superuser prompts.
Table P–5 Shell Prompts
Shell |
Prompt |
---|---|
C shell on UNIX and Linux systems |
machine_name% |
C shell superuser on UNIX and Linux systems |
machine_name# |
Bourne shell and Korn shell on UNIX and Linux systems |
$ |
Bourne shell and Korn shell superuser on UNIX and Linux systems |
# |
Microsoft Windows command line |
C:\ |
The following table explains symbols that might be used in this book.
Table P–6 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:
Documentation (http://www.sun.com/documentation/)
Support (http://www.sun.com/support/)
Training (http://www.sun.com/training/)
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.