... {section} {column:width=30%} {panel:borderStyle=outset|borderColor=#ff9900|bgColor=#ffffff} *+[Home]+* *+[Read Me First]+* *+[Purpose and Policy]+* *+[Frequently Asked Questions]+* *+[Recently Updated Pages]+* {panel}
{panel:borderStyle=outset|borderColor=#ff9900|bgColor=#ffffff} {livesearch:spaceKey=WebServerdocs} {panel} {panel:borderStyle=outset|borderColor=#ff9900|titleBGColor=#BDBEC0|bgColor=#ffffff} *{color:black}Table of Contents{color}*
---- {toc:minLevel=2|maxLevel=5|indent=15px} {panel} \\ {panel:borderStyle=outset|borderColor=#ff9900|bgColor=#ffffff} *{color:black}Top Contributors {color}*
---- {contributors-summary:columns=edits,comments|order=edits|labels=+configguide} {panel} {column}
{column} h1. Sun Java System Web Server 7.0 Update 5 Administrator's Configuration File Reference {anchor:cfr}
||[Download this document|^Administrator's Configuration File Reference Guide.tar.gz]|| The Sun Java System Web Server Administrator's Configuration File Reference discusses the purpose and use of the configuration files for Sun Java System Web Server (Web Server), including {{server.xml}}, {{magnus.conf}}, {{obj.conf}}, and {{mime.types}}. This document provides a comprehensive list of the elements and directives in these configuration files.
{panel:borderStyle=outset|borderColor=#ff9900|title=Related Documents|titleBGColor=#ff9900|bgColor=#ffffff} *[Sun Java System Web Server 7.0 Update 5 Documentation Center|http://docs.sun.com/app/docs/doc/820-7340]* *[Sun Java System Web Server 7.0 Update 5 Release Notes|Release Notes]* *[Sun Java System Web Server 7.0 Update 5 Performance Tuning, Sizing and Scaling Guide|Performance Tuning, Sizing and Scaling Guide]* *[Sun Java System Web Server 7.0 Update 5 Developer's Guide|Developer's Guide]* *[Sun Java System Web Server 7.0 Update 5 Troubleshooting Guide|Troubleshooting Guide]* *[Sun Java System Web Server 7.0 Update 5 NSAPI Developer's Guide|NSAPI Developer's Guide]* *[Sun Java System Web Server 7.0 Update 5 Installation and Migration Guide|Installation and Migration Guide]* *[Sun Java System Web Server 7.0 Update 5 Administrator's Guide|Administrator's Guide]* *[Sun Java System Web Server 7.0 Update 5 Developer's Guide to Java Web Applications|Developer's Guide to Java Web Applications]* *[Sun Java System Web Server 7.0 Update 5 CLI Reference Manual|http://docs.sun.com/app/docs/doc/820-7337]* {panel}
h2. Overview of Configuration Files and Directories {anchor:chap1}
The configuration and behavior of Sun Java System Web Server 7.0 (Web Server) is determined by a set of configuration files. You can use the Admin Console and the command-line interface (CLI) to change the configuration file settings. You can also manually edit these files.
This chapter has the following sections: * h6. [Configuration Files] * h6. [Directory Structure] * h6. [Dynamic Reconfiguration]
h2. Syntax and Use of server.xml {anchor:chap2}
The {{server.xml}} file contains most of the server configuration. This chapter describes the basic syntax of {{server.xml}} and gives a high-level view of the elements that configure server features. It contains the following sections: * h6. [Overview of server.xml] * h6. [Understanding server.xml] * h6. [Sample server.xml File]
h2. Elements in server.xml {anchor:chap3}
This chapter describes the elements in the server.xml file.
||h6. [A] ||h6. [C] ||h6. [D] ||h6. [E] ||h6. [F & H] ||h6. [I & J] || |* access-log * access-log-buffer * acl-cache * acl-db * acl-file * audit-accesses * auth * auth-db * auth-realm |* cgi * cluster * connection-creation-property * connection-lease-property * convert * custom-resource |* dav * dav-collection * default-auth-db-name * default-auth-realm-name * default-soap-auth-provider-name * display-name * dns * dns-cache |* env-variable * event * external-jndi-resource |* file-cache * http * http-listener |* include * index * instance * jdbc-resource * jvm | \\ ||h6. [K & L] ||h6. [M] ||h6. [P] ||h6. [Q] ||h6. [R] ||h6. [S] ||h6. [T] ||h6. [V & W] || |* keep-alive * lifecycle-module * localization * lock-db * log |* mail-resource * mime-file |* pkcs11 * pkcs11 bypass * profiler * property * property-db |* qos * qos-limits |* request-policy * response-policy |* search-app * search-collection * server * servlet-container * session-replication * single-sign-on * snmp * soap-auth-provider * ssl * ssl2-ciphers * ssl3-tls-ciphers * ssl-session-cache * stats |* thread-pool * time * token |* variable * virtual-server * web-app |
\[*Back to* *[top|#cfr]*\]
h2. Syntax and Use of magnus.conf {anchor:chap4}
The {{magnus.conf}} file contains NSAPI plug-in initialization directives and settings that control the way NSAPI plug-ins are run. The {{magnus.conf}} file is located in the {{_instance_dir_/config}} directory.
{info:title=Note -}When you edit the {{magnus.conf}} file, you must restart the server for the changes to take effect. {info}
This chapter discusses the following topics: * h6. [Editing magnus.conf] * h6. [Settings specified in magnus.conf]
h2. Predefined SAFs in magnus.conf {anchor:chap5}
This chapter lists the {{Init}} Server Application Functions (SAF) that you can specify in {{magnus.conf}}. {{Init}} SAFs load and initialize server modules and NSAPI plug-ins.
{info:title=Note - }When you edit the {{magnus.conf}} file, you must restart the server for the changes to take effect. {info}
The following topics are described in detail in this chapter: * h6. [Init SAFs] * h6. [Common SAFs] * h6. [Deprecated Init SAFs]
h2. Syntax and Use of obj.conf {anchor:chap6}
|
... However, when changes made through Admin interface impacts the {{obj.conf}}, for example Java disabling, a new {{obj.conf}} file is created for each virtual server. The {{server.xml}} file is immediately updated to reflect the appropriate {{obj.conf}} file used for each virtual server. During Java disabling if there are two virtual servers, {{vs1}} and {{vs2}}, two new virtual server specific {{obj.conf}} files are created, {{vs1-obj.conf}} and {{vs2-obj.conf}}. These new files are updated in the {{server.xml}} with the exact {{object-file}} used by these two virtual servers.
{code} <object-file>vs1-obj.conf</object-file>
<object-file>vs2-obj.conf</object-file> {code}
|
... When this document refers to {{obj.conf}}, it refers either to all {{obj.conf}} files or to the {{obj.conf}} file for the virtual server being discussed.
This chapter discusses the {{obj.conf}} directives; the use of {{Object}}, {{Client}}, {{If}}, {{ElseIf}}, and {{Else}} tags; the flow of control in {{obj.conf}}; and the syntax rules for editing {{obj.conf}}.
This chapter has the following sections: * h6. [Request-Handling Process Overview] * h6. [Directives in obj.conf] * h6. [Editing obj.conf] * h6. [Objects in obj.conf] * h6. [Flow of Control in obj.conf] * h6. [Changes in Function Flow]
\[*Back to* *[top|#cfr]*\]
h2. Predefined SAFs and Filters in obj.conf {anchor:chap7}
This chapter describes the predefined Server Application Functions (SAFs) and filters that are used in the {{obj.conf}} file. For details about the syntax and use of the {{obj.conf}} file, see [#Syntax and Use of obj.conf].
Each SAF has its own parameters which are passed to it by an {{obj.conf}} directive. SAFs may examine, modify, or create server variables. Each SAF returns a result code that indicates whether it succeeded, did nothing, or failed.
The SAFs in this chapter are grouped by the type of directive that calls them. For an alphabetical list of predefined SAFs and server configuration elements, see [Appendix G: Alphabetical List of Server Configuration Elements and Predefined SAFs|#appG]
This chapter contains the following sections: * h6. [The bucket Parameter] * h6. [AuthTrans] * h6. [NameTrans] * h6. [PathCheck] * h6. [ObjectType] * h6. [Input] * h6. [Output] * h6. [Route] * h6. [Service] * h6. [AddLog] * h6. [Error] * h6. [Common SAFs across Multiple Directives] * h6. [FastCGI Plug-in SAFs]
h2. MIME Types {anchor:chap8}
The MIME types file in the {{config}} directory contains mappings between the Multipurpose Internet Mail Extensions (MIME) types and file extensions. For example, the MIME types file maps the extensions {{.html}} and {{.htm}} to the type {{text/html}}:
{{type=text/html exts=htm,html}}
When the Web Server receives a request from a client, it uses the MIME type mappings to determine the kind of resource that is requested.
MIME types are defined by three attributes: language ({{lang}}), encoding ({{enc}}), and content type ({{type}}). At least one of these attributes must be present for each type. The most commonly used attribute is {{type}}. The server frequently considers the {{type}} when deciding how to generate the response to the client. The {{enc}} and {{lang}} attributes are rarely used. The default MIME types file is {{mime.types}}.
This chapter discusses the following sections:
* h6. [Determining the MIME Type] * h6. [Referencing MIME Types Files in server.xml] * h6. [Generating the Server Response Using the MIME Type] * h6. [Processing the Response in the Client Using the MIME Type] * h6. [MIME Types Syntax] * h6. [Sample MIME Types File]
h2. ACL Files {anchor:chap9}
This chapter describes the access control list (ACL) files and their syntax. ACL files are text files containing lists that define who can access resources stored on Web Server. By default, Web Server uses one ACL file that contains the access list. You can, however, create multiple ACL files and reference them in the {{obj.conf}} file.
After installation, a default access control list is written to the {{default.acl}} file in the {{_instance_dir_/config}} directory. You can change access control rules by editing this file or by creating additional ACL files.
When you make changes to ACL files, you must restart or reconfigure the server for the changes to take effect. For information on reconfiguring the server without restarting, see [Dynamic Reconfiguration].
This chapter contains the following sections: * h6. [Referencing ACL Files in server.xml and obj.conf] * h6. [ACL File Syntax] * h6. [Sample ACL File]
\[*Back to* *[top|#cfr]*\]
h2. Other Server Configuration Files {anchor:chap10}
This chapter summarizes the configuration files that are not discussed in other chapters. Configuration files that should never be modified are not listed in this chapter. The following configuration files are described in detail: * h6. [certmap.conf] * h6. [sun-web.xml] * h6. [login.conf] * h6. [server.policy] * h6. [default-web.xml]
h2. Appendix A: Using Variables, Expressions, and String Interpolation {anchor:appA}
This appendix describes variables, expressions, and string interpolation in the following sections: * h6. [Variables] * h6. [Expressions] * h6. [String Interpolation]
h2. Appendix B: Using Wildcard Patterns {anchor:appB}
This appendix describes the wildcard patterns used by the Sun Java System Web Server. Wildcards use special characters and are applicable in the {{obj.conf}} file, built-in SAFs, and NSAPI functions. To use a wildcard character without any special meaning, precede it with a backslash ( \ ) character.
This appendix has the following sections * h6. [Wildcard Patterns] * h6. [Wildcard Examples]
h2. Appendix C: Using the Custom Log File Format {anchor:appC}
This appendix contains information about the log format used by Web Server. Use these format options to customize the format of your log files. You can enter them through the Admin Console, or edit the {{format}} subelement of the {{access-log}} element in {{server.xml}}. For more information, see [{{access-log}}|A#a1].
You can use variables and expressions in log formats with the syntax {{$}}_variable_ and {{$}}{{(}}_expression_{{)}}. For more information, see [Variables], and [Expressions].
This appendix contains the following section: * h6. [Custom Log File Format]
\[*Back to* *[top|#cfr]*\]
h2. Appendix D: Using Time Formats {anchor:appD}
This appendix describes the format strings used for dates and times in the server log. These formats are used by the NSAPI function {{util_strftime}}, by some built-in SAFs such as {{append-trailer}}, and by server-parsed HTML ({{parse-html}}). For more information about server-parsed HTML, see [Sun Java System Web Server NSAPI Developer's Guide|NSAPI Developer's Guide].
The formats are similar to those used by the {{strftime}} C library routine, but not identical. For more information on the NSAPI function, {{util_strftime}}, see [Sun Java System Web Server NSAPI Developer's Guide|S & U#util_strftime() Function].
This appendix contains the following section: * h6. [Format Strings]
h2. Appendix E: Configuration Changes Between Sun ONE Web Server 6.1 and Sun Java System Web Server 7.0 {anchor:appE}
This appendix summarizes the major configuration file changes between the 6.1 and the 7.0 version of Sun Java System Web Server. The following sections are discussed: * h6. [Element Changes in server.xml] * h6. [Directive and Init Function Changes in magnus.conf] * h6. [Other Configuration File Changes]
h2. Appendix F: Web Server Interfaces {anchor:appF}
This appendix describes the interfaces in Web Server and their stability level. Sun products classify public interfaces according to their expected stability level so that you can make informed decisions when creating dependencies on these interfaces. For example, you can confidently create programmatic dependencies (for example, shell scripts) which rely on stable interfaces, knowing these will not change often (if ever).
Note that the word interface is used in a very broad sense. Any implementation detail on which your code might rely on can be an interface. This includes APIs but also includes aspects such as CLI option names, file system paths, file names and so forth.
This appendix contains the following section: * h6. [Interfaces and their Stability Levels]
h2. Appendix G: Alphabetical List of Server Configuration Elements and Predefined SAFs {anchor:appG}
This appendix provides an alphabetical list of server configuration elements, including {{server.xml}} elements, and predefined SAFs in {{magnus.conf}} and {{obj.conf}} files.
* h6. [Alphabetical List]
\[*Back to* *[top|#cfr]*\]
{column} {section} |