|
Table of Contents
|
Sun Java System Web Server 7.0 Update 5 Administrator's Configuration File ReferenceThe 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. Related Documents Sun Java System Web Server 7.0 Update 5 Documentation Center Overview of Configuration Files and DirectoriesThe 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: Syntax and Use of server.xmlThe 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: Elements in server.xmlThis chapter describes the elements in the server.xml file.
[Back to top] Syntax and Use of magnus.confThe 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.
This chapter discusses the following topics: Predefined SAFs in magnus.confThis 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.
The following topics are described in detail in this chapter: Syntax and Use of obj.confThe obj.conf file contains directives for HTTP request processing. The obj.conf file is located in the instance_dir/config directory. During Web Server installation an obj.conf file is created. If you configure multiple virtual servers using the Admin Console or CLI, separate obj.conf files may be created for each virtual server. These files are named virtual-server-name-obj.conf, where virtual-server-name is the name of the virtual server. The newly created virtual-server-name-obj.conf becomes functional. This can be verified from the server.xml, where the name of the functional obj.conf is updated. When changes made through Admin Console or CLI does not impact the obj.conf, for example changing log-level, no new virtual server specific obj.conf files are created and the default obj.conf will be used for all the virtual servers of the configuration. 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. <object-file>vs1-obj.conf</object-file> <object-file>vs2-obj.conf</object-file> From this point onwards, the obj.conf file is neither updated, used, nor deleted. However, if the user wants to modify the obj.conf file for either of the two virtual servers, they should edit the respective file only and not the original obj.conf file.
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:
[Back to top] Predefined SAFs and Filters in obj.confThis 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 This chapter contains the following sections:
MIME TypesThe 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:
ACL FilesThis 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: [Back to top] Other Server Configuration FilesThis 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: Appendix A: Using Variables, Expressions, and String InterpolationThis appendix describes variables, expressions, and string interpolation in the following sections: Appendix B: Using Wildcard PatternsThis 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 Appendix C: Using the Custom Log File FormatThis 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. 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: [Back to top] Appendix D: Using Time FormatsThis 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. 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. This appendix contains the following section: Appendix E: Configuration Changes Between Sun ONE Web Server 6.1 and Sun Java System Web Server 7.0This 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:
Appendix F: Web Server InterfacesThis 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: Appendix G: Alphabetical List of Server Configuration Elements and Predefined SAFsThis appendix provides an alphabetical list of server configuration elements, including server.xml elements, and predefined SAFs in magnus.conf and obj.conf files. [Back to top] |
Sign up or Log in to add a comment or watch this page.