5 Configuring Oracle HTTP Server

This chapter describes Oracle HTTP Server configuration in the OPMN opmn.xml file.

It features the following topics:

Oracle HTTP Server Process Module Configuration
Oracle HTTP Server Minimum Configuration
Oracle HTTP Server Complete Configuration
Oracle HTTP Server Attribute Descriptions

5.1 Oracle HTTP Server Process Module Configuration

The following lines load and identify the Oracle HTTP Server process module. Management of Oracle HTTP Server processes by the process module are identified by the module id.

<module path="ORACLE_HOME/opmn/lib/libopmnohs.so">
   <module-id="OHS" />
</module>

5.2 Oracle HTTP Server Minimum Configuration

The following lines represent the minimum configuration for Oracle HTTP Server. Default values are assigned to all other configuration elements and attributes for Oracle HTTP Server.

<ias-component id="HTTP_Server">
   <process-type id="HTTP_Server" module-id="OHS">
      <process-set id="HTTP_Server" numprocs="1"/>
   </process-type>
</ias-component>

5.3 Oracle HTTP Server Complete Configuration

The following lines show a complete configuration for Oracle HTTP Server. It contains all possible configuration elements and attributes for Oracle HTTP Server.

<ias-component id="HTTP_Server" status="enabled" id-matching="false">
   <process-type id="HTTP_Server" module-id="OHS">
      <process-set id="HTTP_Server" restart-on-death="true" numprocs=1>
         <module-data>
            <category id="start-parameters">
               <data id="config-file" value="/myconfs/httpd.conf"/>
               <data id="start-mode" value="ssl-disabled"/>
               <data id="command-line" value="-D MyDefine"/>
            </category>
            <category id="ping-parameters">
               <data id="ping-url" value="/"/>
            </category>
            <category id="restart-parameters">
               <data id="reverseping-timeout" value="345"/>
               <data id="no-reverseping-failed-ping-limit" value="3"/>
               <data id="reverseping-failed-ping-limit" value="6"/>
            </category>
         </module-data>
            <start timeout="300" retry="3"/>
            <stop timeout="300"/>
            <restart timeout="300"/>
            <ping timeout="30" interval="30"/>
      </process-set>
   </process-type>
</ias-component>

5.4 Oracle HTTP Server Attribute Descriptions

This section describes the attributes that are specific for Oracle HTTP Server.

The Oracle HTTP Server attributes are described with the following format:

Title: This is the attribute name and value being defined. For example, id="HTTP_Server".
Required: This field defines whether or not the attribute is required in the component definition.
Default: This defines the default value assigned to the attribute. The default value appears in the installed version of the opmn.xml file or is assigned internally if the attribute is not present.
Valid values: This field defines the valid values for the attribute. For example, HTTP_Server.
Path: This field defines in which elements the attribute can appear. For example, ias-component/process-type/process-set

id="HTTP_Server"

Required: true
Default: none
Valid values: HTTP_Server
Path: ias-component
Path: ias-component/process-type
Path: ias-component/process-type/process-set

The id attribute is required and cannot be changed. The id must match the targets.xml entry or Application Server Control Console will not work.

module-id="OHS"

Required: true
Default: none
Path: ias-component/process-type

The module-id attribute defines the type of process. It associates the configuration with a process module.

numprocs=1

Required: true
Default: none
Valid values: 1
Path: ias-component/process-type/process-set

The Number of OHS Instances to start. Only valid value is 1.

The numprocs attribute gives the number of Oracle HTTP Server instances to start. The only valid value is 1.

id="start-parameters"

Required: false
Default: none
Path: ias-component/process-type/process-set/module-data/category

The start-parameters category contains the parameters that are relevant for the startup of Oracle HTTP Server.

id="config-file"

Required: false
Default: $ORACLE_HOME/Apache/Apache/conf/httpd.conf
Valid values: any full path to an existing configuration file
Path: ias-component/process-type/process-set/module-data/category/
data

The config-file id is an start command option which specifies the httpd.conf for starting Oracle HTTP Server.

id="start-mode"

Required: false
Default: ssl-enabled
Valid values: ssl-enabled/ssl-disabled
Path: ias-component/process-type/process-set/module-data/
category/data

This option specifies whether Oracle HTTP Server will be started with ssl enabled

id="command-line"

Required: false
Default: none
Valid values: any valid command line options to Oracle HTTP Server
Path: ias-component/process-type/process-set/module-data/
category/data

This id option specifies extra command lines to append to the Oracle HTTP Server command line.

id="ping-parameters"

Required: false
Default: none
Path: ias-component/process-type/process-set/module-data/
category

The ping parameters category contains the parameters that configure how OPMN pings Oracle HTTP Server.

id="ping-url"

Required: false
Default: /
Valid values: the path portion of an url; for example: http://127.0.0.1/<path>
Path: ias-component/process-type/process-set/module-data/
category/data

The ping-url id specifies the URL at which OPMN pings Oracle HTTP Server.

id="restart-parameters"

Required: false
Default: none
Path: ias-component/process-type/process-set/module-data/
category

The restart-parameters category is used for defining parameters that will be used in death-detection.

id="reverseping-timeout"

Required: false
Default: 300 seconds
Valid values: Any reasonable timeout value
Path: ias-component/process-type/process-set/module-data/
category/data

The reverseping-timeout value is the maximum allowable time between two notifications arriving from an Oracle HTTP Server process. As part of death-detection, the Oracle HTTP Server module performs forward pings on the Oracle HTTP Server process. In the event that forward pings start failing, the reverse pings are taken into account in death-detection and Oracle HTTP Server processes are restarted.

id="no-reverseping-failed-ping-limit"

Required: false
Default: 1
Valid values: Any reasonable value that reflects the tolerance that OPMN should have for failed forward pings when reverse pings are also failing. This tolerance is used by OPMN to determine when the process should be declared as unresponsive and replaced.
Path: ias-component/process-type/process-set/module-data/category/
data

This id module data element defines the tolerance for failed forward pings in the event that reverse pings are also not being received (within the timeout period specified by the reverseping-timeout data element). After the number of ping failures equals this limit, the process is deemed unresponsive and restarted by OPMN.

id="reverseping-failed-ping-limit"

Required: false
Default: 3
Valid values: Any reasonable value that reflects the tolerance that OPMN should have for failed forward pings when reverse pings are being received. This tolerance is used by OPMN to determine when the process should be declared as unresponsive and replaced.
Path: ias-component/process-type/process-set/module-data/category/
data

This module data element defines the tolerance for failed forward pings when reverse pings are succeeding. After the number of ping failures equals this limit, the process is deemed unresponsive and restarted by OPMN.