Sun Java logo     Copyright      Index      Next     

Sun logo
Sun Java System Web Proxy Server 4.0.1 Configuration File Reference 

Contents


About This Guide
Who Should Use This Guide
How This Guide Is Organized
Documentation Conventions
Using the Documentation
Contacting Sun Technical Support
Third-Party Web Site References
Feedback

Chapter 1   Basics of Server Operation
Configuration Files
server.xml
magnus.conf
obj.conf
mime.types
Other Configuration Files
Directory Structure
Default Directory Structure
Proxy Server Directory Structure
Dynamic Reconfiguration

Chapter 2   Server Configuration Elements in server.xml
The sun-web-proxy-server_4_0.dtd File
Subelements
Data
Attributes
Elements in the server.xml File
Core Server Elements
SERVER
Subelements
Attributes
PROPERTY
Subelements
Attributes
DESCRIPTION
Subelements
Attributes
LOG
Subelements
Attributes
EVENT
Subelements
Attributes
EVENTTIME
Subelements
EVENTACTION
Subelements
Listener Elements
LS
Subelements
Attributes
SSLPARAMS
Subelements
Attributes
MIME
Attributes
TYPE
Subelements
Attributes
ACLFILE
Subelements
Attributes
USERDB
Subelements
Attributes
Cache Elements
FILECACHE
Subelements
Attributes
CACHE
Subelements
Attributes
PARTITION
Subelements
Attributes
GC
Subelements
Attributes
The Sun Java System LDAP Schema
The Convergence Tree
The Domain Component (dc) Tree
Variables
Format of a Variable
Other Important Variables
General Variables
Variable Evaluation
Sample server.xml File

Chapter 3   Syntax and Use of magnus.conf
Server Information
Server Name
Server ID
User
NetsiteRoot
DNS Lookup
AsyncDNS
DNS
Processes
MaxProcs (UNIX Only)
Error Logging and Statistic Collection
ErrorLogDateFormat
PidLog
Security
Security
Summary of Directives in magnus.conf
Directives

Chapter 4   Syntax and Use of obj.conf
How the Proxy Server Functions
Forward Proxy Scenario
Reverse Proxy Scenario
NSAPI Filters
Steps in the Request-handling Process
Directives for Handling Requests
Dynamic Reconfiguration
Server Instructions in obj.conf
Summary of the Directives
Configuring HTTP Compression
The Object and Client Tags
The Object Tag
Objects that Use the name Attribute
Objects that Use the ppath Attribute
The Client Tag
Client Tag Parameters
Variables Defined in server.xml
Flow of Control in obj.conf
Init
AuthTrans
NameTrans
How and When the Server Processes Other Objects
PathCheck
ObjectType
Setting the Type By File Extension
Forcing the Type
Input
Output
Service
Service Examples
Default Service Directive
AddLog
Error
Connect
DNS
Filter
Route
Changes in Function Flow
Internal Redirects
Restarts
URI Translation
Syntax Rules for Editing obj.conf
Order of Directives
Parameters
Case Sensitivity
Separators
Quotes
Spaces
Line Continuation
Path Names
Comments
About obj.conf Directive Examples

Chapter 5   Predefined SAFs in obj.conf
The bucket Parameter
Init
define-perf-bucket
flex-init
flex-rotate-init
host-dns-cache-init
icp-init
init-clf
init-filter-order
init-j2ee
init-proxy
init-uhome
init-url-filter
ip-dns-cache-init
load-modules
load-types
nt-console-init
pa-init-parent-array
pa-init-proxy-array
perf-init
pool-init
register-http-method
stats-init
suppress-request-headers
thread-pool-init
tune-cache
tune-proxy
Summary of Init Functions
AuthTrans
basic-auth
basic-ncsa
get-sslid
match-browser
proxy-auth
set-variable
NameTrans
assign-name
document-root
home-page
map
match-browser
ntrans-j2ee
pac-map
pat-map
pfx2dir
redirect
reverse-map
set-variable
strip-params
unix-home
PathCheck
block-multipart-posts
check-acl
deny-existence
deny-service
find-compressed
find-index
find-links
find-pathinfo
get-client-cert
load-config
match-browser
nt-uri-clean
ntcgicheck
require-auth
require-proxy-auth
set-variable
set-virtual-index
ssl-check
ssl-logout
unix-uri-clean
url-check
url-filter
user-agent-check
ObjectType
block-auth-cert
block-cache-info
block-cipher
block-ip
block-issuer-dn
block-keysize
block-proxy-auth
block-secret-keysize
block-ssl-id
block-user-dn
cache-enable
cache-setting
force-type
forward-auth-cert
forward-cache-info
forward-cipher
forward-ip
forward-issuer-dn
forward-keysize
suppress-request-headers
forward-proxy-auth
forward-secret-keysize
forward-ssl-id
forward-user-dn
http-client-config
java-ip-check
match-browser
set-basic-auth
set-default-type
set-variable
shtml-hacktype
ssl-client-config
type-by-exp
type-by-extension
Input
insert-filter
match-browser
remove-filter
set-variable
Output
content-rewrite
insert-filter
match-browser
remove-filter
set-variable
Service
add-footer
add-header
append-trailer
deny-service
imagemap
index-common
index-simple
key-toosmall
list-dir
make-dir
match-browser
proxy-retrieve
query-handler
remove-dir
remove-file
remove-filter
rename-file
send-error
send-file
send-range
send-shellcgi
send-wincgi
service-dump
service-j2ee
service-trace
set-variable
shtml_send
stats-xml
upload-file
AddLog
common-log
flex-log
match-browser
record-useragent
set-variable
Error
error-j2ee
match-browser
query-handler
remove-filter
send-error
set-variable
Connect
DNS
dns-config
your-dns-function
Filter
filter-ct
filter-html
pre-filter
Route
icp-route
pa-enforce-internal-routing
pa-set-parent-route
set-proxy-server
set-origin-server
set-socks-server
unset-proxy-server
unset-socks-server

Chapter 6   MIME Types
Introduction
Determining the MIME Type
How the Type Affects the Response
What Does the Client Do with the MIME Type?
Syntax of the MIME Types File
Sample MIME Types File

Chapter 7   Other Server Configuration Files
certmap.conf
dbswitch.conf
Deployment Descriptors
generated.instance.acl
password.conf
*.clfilter
bu.conf
Accept
Connections
Count
Depth
Object boundaries
Reject
Source
Type
icp.conf
add_parent
add_sibling
server
socks5.conf
Authentication/Ban Host Entries
Routing Entries
Variables and Flags
Available Settings
Proxy Entries
Access Control Entries
Specifying Ports
parray.pat
parent.pat

Appendix A   Configuration Changes Between iPlanet Web Proxy Server 3.6 and Sun Java System Web Proxy Server 4
Appendix B   Time Formats
Appendix C   Alphabetical List of Server Configuration Elements
Appendix D   Alphabetical List of Predefined SAFs
Index


Copyright      Index      Next     

Part No: 819-3651-10.   Copyright 2005 Sun Microsystems, Inc. All rights reserved.