Chapter 5. Configuring a Web Servlet Engine in domain.xml
Prev   Next

Chapter 5. Configuring a Web Servlet Engine in domain.xml

Table of Contents

5.1. Introduction
5.2. XML Schema/XML Tree
5.3. Element Reference
5.4. Example File

This chapter explains the tags related to web servlet engines in domain.xml.

5.1. Introduction

XML references are configured in the following format.

  1. XML Schema/XML Tree: Summarizes all the tags of XML configuration file. Each node is defined in the following format.

    1. Tag reference enables quick search for tags. Each tag is attached with index numbers ( ex: (11) ). Tags are explained with this number in tag reference.

    2. The XML tag name defined in the XML schema is expressed in the format of <tag name>.

    3. Tags are set with cardinality defined in XML schema.

      “?” is for 0 or 1 element, “+” is for 1 or more elements, “*” is for 0 or more elements, (no symbol) is for exactly one element

    4. Several tags have "P" character, meaning that they are the tags related to performance. These tags are used to tune the setting.

  2. Element Reference: Explains XML tags in the tree.

    1. Dynamic: Allowed to change the configuration dynamically.

    2. Non-Dynamic: Not allowed to change the configuration dynamically. This is expressed only for the special case to comment out.

    3. Description: A short description for tags.

    4. Value Description: The value and type.

    5. Value Type: Data type of the value. (ex: String)

    6. Value Type Description: Description for the data type of the value.

    7. Default Value: The value to be used by default when the XML is not used.

    8. Defined Value: The default value.

    9. Example: The XML tag example.

    10. Performance Recommendation: The value recommended to improve performance.

    11. Child Elements:The tags contained in its own tag element.

5.2. XML Schema/XML Tree

5.3. Element Reference

(85) < domain >< servers >< server > <web-engine>
Description A Web engine provides the environment for running J2EE Web and Servlet applications. It corresponds to the web container in the J2EE specifications. It is started when the JEUS server starts. Each JEUS server can only have one Web engine.
Value Type web-containerType
Child Elements

(87) default-error-page

(88) response-header

(93) encoding

(104) cookie-policy

(108) properties

(112) jsp-engine

(122) attach-stacktrace-on-error

(123) virtual-host

(226) web-connections

(406) monitoring

(410) access-log

(474) session-config

(494) async-timeout-min-threads

(495) blocked-url-patterns

(500) pipeline

5.4. Example File

[Example 5.1] Example File

<?xml version="1.0"?>
<domain xmlns="http://www.tmaxsoft.com/xml/ns/jeus">
    <servers>
        <server>
            <web-engine>
                <!-- define custom header on HTTP response in current web engine -->
                <response-header>
                    <custom-header>
                        <header-field>
                            <field-name>TestHeader</field-name>
                            <field-value>This is a test header value</field-value>
                        </header-field>
                        ...
                        <header-field>
                            ...
                        </header-field>
                    </custom-header>
                </response-header>
            
                <!-- refer to another chapter -->
                <!--
                <encoding>
                    ...
                </encoding>

                <jsp-engine>
                    ...
                </jsp-engine>
                -->
            
                <!-- set default-error-page -->
                <default-error-page>/home/errorpage/error.html</default-error-page>
            
                <!-- determine whether attach stacktrace on jeus error page or not -->
                <attach-stacktrace-on-error>false</attach-stacktrace-on-error>
            
                <!-- refer to another chapter -->
                <!--
                <virtual-host>
            		...
            	</virtual-host>

                <web-connections>
                    ...
                </web-connections>
                -->
            
                <monitoring>
                    <!-- thread check interval(checking idle, block threads, etc...) -->
                    <check-thread-pool>60000</check-thread-pool>
                    <!-- reload check interval -->
                    <check-class-reload>60000</check-class-reload>
                    <!-- session check interval(checking session's timeout, session server,
                         etc...) -->
                    <check-session>60000</check-session>
                </monitoring>

                <!-- access log for web engine : Common Log Format -->
                <access-log>
                    <enable>true</enable>
                    <format>common</format>
                    <handler>
                        <file-handler>
                            <name>fileHandler</name>
                        </file-handler>
                    </handler>
                </access-log>
            
                <!-- properties for web engine -->
                <properties>
                    <property>
                        <key>myKey</key>
                        <value>myValue</value>
                    </property>
                </properties>
            
                <!-- refer to another chapter -->
                <!--
                <session-config>
                    ...
                </session-config>
                -->
            
                <!-- set the minimum threads to process timeout event
                     of asynchrous processing -->
                <async-timeout-min-threads>1</async-timeout-min-threads>
            </web-engine>
        </server>
    </servers>
</domain>

Prev   Next
Chapter 4. Configuring a JMX Manager in domain.xml Home Chapter 6. Configuring a Web Engine Encoding in domain.xml