6 Configuring Oracle Application Server Web Cache

This chapter describes Oracle Application Server Web Cache (OracleAS Web Cache) configuration in the OPMN opmn.xml file.

It features the following topics:

• Section 6.1, "OracleAS Web Cache Process Module Configuration"

• Section 6.2, "OracleAS Web Cache Minimum Configuration"

• Section 6.3, "OracleAS Web Cache Complete Configuration"

• Section 6.4, "OracleAS Web Cache Attribute Descriptions"

6.1 OracleAS Web Cache Process Module Configuration

The following lines load and identify the OracleAS Web Cache process module. Management of OracleAS Web Cache processes by the process module are identified by the module id.

<module path="$ORACLE_HOME/opmn/lib/libopmnwc.so">
   <module-id id="WebCache" />
   <module-id id="WebCacheAdmin" />
</module>

6.2 OracleAS Web Cache Minimum Configuration

The following lines represent the minimum configuration for OracleAS Web Cache. Default values are assigned to all other configuration elements and attributes for OracleAS Web Cache.

<ias-component id="WebCache">
   <environment>
      <variable id="LD_LIBRARY_PATH" value="$ORACLE_HOME/lib:$ORACLE_HOME/opmn/lib" append="true"/>
   </environment>
   <process-type id="WebCache" module-id="WebCache">
      <process-set id="WebCache" numprocs="1"/>
   </process-type>
      <process-type id="WebCacheAdmin" module-id="WebCache-admin">
      <process-set id="WebCacheAdmin" restart-on-death="false" numprocs="1"/>
   </process-type>
</ias-component>

6.3 OracleAS Web Cache Complete Configuration

The following example represents the complete configuration for OracleAS Web Cache. It contains all possible configuration elements and attributes that can be used with OracleAS Web Cache.

<ias-component id="WebCache">
   <environment>
      <variable id="LD_LIBRARY_PATH" value="$ORACLE_HOME/lib:$ORACLE_HOME/opmn/lib" append="true"/>
   </environment>
   <process-type id="WebCache" module-id="WebCache">
      <process-set id="WebCache" restart-on-death="true" numprocs="1"/>
         <module-data>
            <category id=start-parameters>
               <data id ="command-line" value="Option1 Option2"/>
            </category>
         </module-data>
      </process-set>
   </process-type>
   <process-type id="WebCacheAdmin" module-id="WebCache"-admin">
      <process-set id="WebCacheAdmin" restart-on-death="false" numprocs="1"/>
         <module-data>
            <category id=start-parameters>
               <data id ="command-line" value="Option1 Option2"/>
            </category>
         </module-data>
      </process-set>
   </process-type>
</ias-component>

6.4 OracleAS Web Cache Attribute Descriptions

This section describes the attributes that are specific for OracleAS Web Cache.

The OracleAS Web Cache attributes are described with the following format:

• Title: This is the attribute name and value being defined. For example, id="WebCache".

• 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: If applicable, this field defines the valid values for the attribute. For example, WebCache.

• Path: This field defines in which elements the attribute can appear. For example, ias-component.

id="WebCache"

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

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

id="WebCacheAdmin"

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

The id name is required and cannot be changed. The id must match the targets.xml entry or elements and attributes will not work.

environment

Required: true
Default: none
Path: ias-component

The environment segment must add $ORACLE_HOME/lib and $ORACLE_HOME/opmn/lib to the LD_LIBRARY_PATH.

module-id="WebCache"

Required: true
Default: none
Valid values: WebCache, WebCache-admin
Path: ias-component/process-type

The module id defines whether the child process-set element defines a WebCache server process or a WebCache administrative process. At least one WebCache server process must be defined in the WebCache component.

restart-on-death

Required: true
Default: true
Valid values: true or false
Path: ias-component/process-type/process-set

The restart-on-death attribute defines whether the process will be restarted if it exits unexpectedly. By default after Oracle Application Server installation, this attribute is set to true for the OracleAS Web Cache server, and false for the OracleAS Web Cache administrative process.

numprocs="1"

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

This attribute gives the number of OracleAS Web Cache processes started for the process-set. The value must be set to 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 OracleAS Web Cache or OracleAS Web Cache Administrator.

id ="command-line"

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

The options specified for the value of command-line will be added to the command-line for OracleAS Web Cache or OracleAS Web Cache Administrator.