10 Configuring Oracle Application Server Wireless

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

It features the following topics:

OracleAS Wireless Process Module Configuration
OracleAS Wireless Minimum Configuration
OracleAS Wireless Complete Configuration
OracleAS Wireless Attribute Descriptions

10.1 OracleAS Wireless Process Module Configuration

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

<module path="%ORACLE_HOME%/opmn/lib/libopmnoc4j.so">
   <module-id id="OC4J"/>
</module>
<module path="ORACLE_HOME/opmn/lib/libopmnwireless.so">
   <module-id id="alert"/>
   <module-id id="datafeeder"/>
   <module-id id="performance"/>
   <module-id id="messaging"/>
   <module-id id="notification"/>
</module>

10.2 OracleAS Wireless Minimum Configuration

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

<ias-component id="wireless" status="enabled">
   <environment>
      <variable id="WIRELESS_HOME" value="$ORACLE_HOME/wireless" append="false"/>
      <variable id="WIRELESS_LIB" value="$WIRELESS_HOME/lib" append="false"/>
      <variable id="JAVA13_HOME" value="$ORACLE_HOME/jdk" append="false"/>
      <variable id="JAVA_HOME" value="$JAVA13_HOME" append="false"/>
      <variable id="IAS_LIB" value="$ORACLE_HOME/lib" append="false"/>
      <variable id="CLASSPATH" value="." append="true"/>
      <variable id="CLASSPATH" value="$JAVA13_HOME/jre/lib/rt.jar" append="true"/>
      <variable id="CLASSPATH" value="$WIRELESS_HOME/server/classes" append="true"/>
      <variable id="CLASSPATH" value="$WIRELESS_LIB/wireless.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jdbc/lib/classes12.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jdbc/lib/nls_charset12.jar" append="true"/>
      <variable id="CLASSPATH" value="$IAS_LIB/xmlparserv2.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/jndi.jar" append="true"/>
      <variable id="CLASSPATH" value="$IAS_LIB/servlet.jar" append="true"/>
      <variable id="CLASSPATH" value="$IAS_LIB/activation.jar" append="true"/>
      <variable id="CLASSPATH" value="$IAS_LIB/mail.jar" append="true"/>
      <variable id="CLASSPATH" value="$WIRELESS_LIB/ssosdk902.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/ldapjclnt9.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/ldap.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/providerutil.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/repository.jar" append="true"/>
      <variable id="CLASSPATH" value="$IAS_LIB/xschema.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/sysman/webapps/emd/WEB-INF/lib/emd.jar"       append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/dcm/lib/dcm.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/emPid.jar" append="true"/>
      <variable id="CLASSPATH" value="$WIRELESS_LIB/mwa.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/netcfg.jar"append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/lib/http_client.jar"       append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/lib/javax-ssl-1_2.jar"       append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/lib/jssl-1_2.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/ldapjclnt9.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/ojmisc.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/jazn.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/jaas.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/soap/lib/soap.jar" append="true"/>
   </environment>
   <process-type id="wireless_oc4j" module-id="OC4J">
      <port id="ajp" range="3301-3400" />
      <port id="rmi" range="3101-3200" />
      <port id="jms" range="3201-3300" />
      <process-set id="wireless-island" numprocs="1"/>
   </process-type>
   <process-type id="alert_server" module-id="alert">
      <stop timeout="300"/>
      <restart timeout="480"/>
      <process-set id="alert_instance_1" numprocs="1"/>
   </process-type>
   <process-type id="datafeeder_server" module-id="datafeeder">
      <stop timeout="300"/>
      <restart timeout="480"/>
      <process-set id="datafeeder_instance_1" numprocs="1"/>
   </process-type>
   <process-type id="performance_server" module-id="performance">
      <stop timeout="300"/>
      <restart timeout="480"/>
      <process-set id="performance_instance_1" numprocs="1"/>
   </process-type>
   <process-type id="messaging_server" module-id="messaging">
      <stop timeout="300"/>
      <restart timeout="480"/>
      <process-set id="messaging_instance_1" numprocs="1"/>
   </process-type>
   <process-type id="notification_server" module-id="notification">
      <stop timeout="300"/>
      <restart timeout="480"/>
      <process-set id="notification_instance_1" numprocs="1"/>
   </process-type>
</ias-component>

10.3 OracleAS Wireless Complete Configuration

The following lines show a complete configuration for OracleAS Wireless. It contains all possible configuration elements and attributes for OracleAS Wireless.

<ias-component id="wireless" status="enabled">
   <environment>
      <variable id="WIRELESS_HOME" value="$ORACLE_HOME/wireless" append="false"/>
      <variable id="WIRELESS_LIB" value="$WIRELESS_HOME/lib" append="false"/>
      <variable id="JAVA13_HOME" value="$ORACLE_HOME/jdk" append="false"/>
      <variable id="JAVA_HOME" value="$JAVA13_HOME" append="false"/>
      <variable id="IAS_LIB" value="$ORACLE_HOME/lib" append="false"/>
      <variable id="CLASSPATH" value="." append="true"/>
      <variable id="CLASSPATH" value="$JAVA13_HOME/jre/lib/rt.jar" append="true"/>
      <variable id="CLASSPATH" value="$WIRELESS_HOME/server/classes" append="true"/>
      <variable id="CLASSPATH" value="$WIRELESS_LIB/wireless.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jdbc/lib/classes12.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jdbc/lib/nls_charset12.jar" append="true"/>
      <variable id="CLASSPATH" value="$IAS_LIB/xmlparserv2.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/jndi.jar" append="true"/>
      <variable id="CLASSPATH" value="$IAS_LIB/servlet.jar" append="true"/>
      <variable id="CLASSPATH" value="$IAS_LIB/activation.jar" append="true"/>
      <variable id="CLASSPATH" value="$IAS_LIB/mail.jar" append="true"/>
      <variable id="CLASSPATH" value="$WIRELESS_LIB/ssosdk902.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/ldapjclnt9.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/ldap.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/providerutil.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/repository.jar" append="true"/>
      <variable id="CLASSPATH" value="$IAS_LIB/xschema.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/sysman/webapps/emd/WEB-INF/lib/emd.jar"       append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/dcm/lib/dcm.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/emPid.jar" append="true"/>
      <variable id="CLASSPATH" value="$WIRELESS_LIB/mwa.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/netcfg.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/lib/http_client.jar"       append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/lib/javax-ssl-1_2.jar"
      append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/lib/jssl-1_2.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/ldapjclnt9.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/ojmisc.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/jazn.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/jaas.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/soap/lib/soap.jar" append="true"/>
   </environment>
   <process-type id="wireless_oc4j" module-id="OC4J">
      <port id="ajp" range="3301-3400" />
      <port id="rmi" range="3101-3200" />
      <port id="jms" range="3201-3300" />
      <process-set id="wireless-island" numprocs="1"/>
      </process-type>
   <process-type id="alert_server" module-id="alert" working-dir="%ORACLE_HOME%/wireless">
      <module-data>
         <category id="start-parameters">
            <data id="java-bin" value="/my/path/to/java/exec"/>
            <data id="java-parameters" value="-Doracle.wireless.instance=my_alert_instance_name
            -Dyet_another_definition=yet_another_value"/>
            <data id="class-name" value="MyJavaStartClass"/>
            <data id="application-parameters" value="my_application_parameters"/>
         </category>
         <category id="stop-parameters">
            <data id="java-bin" value="/my/path/to/java/exec"/>
            <data id="java-parameters" value="-Doracle.wireless.instance=my_alert_instance_name
            -Dyet_another_definition=yet_another_value"/>
            <data id="class-name" value="MyJavaStopClass"/>
            <data id="application-parameters" value="my_application_parameters"/>
         </category>
      </module-data>
      <stop timeout="300"/>
      <restart timeout="480"/>
      <process-set id="alert_instance_1" numprocs="1"/>
   </process-type>
   <process-type id="datafeeder_server" module-id="datafeeder" working-dir="ORACLE_HOME/wireless">
      <module-data>
         <category id="start-parameters">
            <data id="java-bin" value="/my/path/to/java/exec"/>
            <data id="java-parameters" value="-Doracle.wireless.instance=my_ datafeeder            _instance_name
            -Dyet_another_definition=yet_another_value"/>
            <data id="class-name" value="MyJavaStartClass"/>
            <data id="application-parameters" value="my_application_parameters"/>
         </category>
         <category id="stop-parameters">
            <data id="java-bin"  value="/my/path/to/java/exec"/>
            <data id="java-parameters" value="-Doracle.wireless.instance= 
            my_datafeeder_instance_name -Dyet_another_definition=yet_another_value"/>
            <data id="class-name" value="MyJavaStopClass"/>
            <data id="application-parameters" value="my_application_parameters"/>
         </category>
      </module-data>
      <stop timeout="300"/>
      <restart timeout="480"/>
      <process-set id="datafeeder_instance_1" numprocs="1"/>
   </process-type>
   <process-type id="performance_server" module-id="performance" 
   working-dir="ORACLE_HOME/wireless">
      <module-data>
         <category id="start-parameters">
            <data id="java-bin" value="/my/path/to/java/exec"/>
            <data id="java-parameters" 
             value="-Doracle.wireless.instance=my_performance_instance_name 
            -Dyet_another_definition=yet_another_value"/>
            <data id="class-name"  value="MyJavaStartClass"/>
            <data id="application-parameters" value="my_application_parameters"/>
         </category>
         <category id="stop-parameters">
            <data id="java-bin" value="/my/path/to/java/exec"/>
            <data id="java-parameters"
             value="-Doracle.wireless.instance=
             my_performance_instance_name-Dyet_another_definition=yet_another_value"/>
            <data id="class-name"  value="MyJavaStopClass"/>
            <data id="application-parameters" value="my_application_parameters"/>
         </category>
      </module-data>
      <stop timeout="300"/>
      <restart timeout="480"/>
      <process-set id="performance_instance_1" numprocs="1"/>
   </process-type>
   <process-type id="messaging_server" module-id="messaging" working-dir=    "ORACLE_HOME/wireless">
      <module-data>
         <category id="start-parameters">
            <data id="java-bin" value="/my/path/to/java/exec"/>
            <data id="java-parameters" 
             value="-Doracle.wireless.instance=my_messaging_instance_name 
            -Dyet_another_definition=yet_another_value"/>
            <data id="class-name"  value="MyJavaStartClass"/>
            <data id="application-parameters" value="my_application_parameters"/>
         </category>
         <category id="stop-parameters">
            <data id="java-bin" value="/my/path/to/java/exec"/>
            <data id="java-parameters" value="-Doracle.wireless.instance= 
            my_messaging_instance_name -Dyet_another_definition=yet_another_value"/>
            <data id="class-name" value="MyJavaStopClass"/>
            <data id="application-parameters" value="my_application_parameters"/>
         </category>
      </module-data>
      <stop timeout="300"/>
      <restart timeout="480"/>
      <process-set id="messaging_instance_1" numprocs="1"/>
   </process-type>
   <process-type id="notification_server" module-id="notification" working-dir= 
   "ORACLE_HOME/wireless">
      <module-data>
         <category id="id="start-parameters"">
            <data id="java-bin" value="/my/path/to/java/exec"/>
            <data id="java-parameters" value="-Doracle.wireless.instance= 
            my_notification_instance_name -Dyet_another_definition=yet_another_value"/>
            <data id="class-name" value="MyJavaStartClass"/>
            <data id="application-parameters" value="my_application_parameters"/>
         </category>
         <category id="stop-parameters">
            <data id="java-bin" value="/my/path/to/java/exec"/>
            <data id="java-parameters" value="-Doracle.wireless.instance= 
            my_notification_instance_name -Dyet_another_definition=yet_another_value"/>
            <data id="class-name" value="MyJavaStopClass"/>
            <data id="application-parameters" value="my_application_parameters"/>
         </category>
      </module-data>
      <stop timeout="300"/>
      <restart timeout="480"/>
      <process-set id="notification_instance_1" numprocs="1"/>
   </process-type>
</ias-component>

10.4 OracleAS Wireless Attribute Descriptions

This section describes the attributes that are specific for OracleAS Wireless.

The OracleAS Wireless attributes are described with the following format:

Title: This is the attribute name and value being defined. For example, id="wireless".
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, wireless.
Path: This field defines in which elements the attribute can appear. For example, ias-component.

id="wireless"

Required: true
Default: none
Valid values: wireless
Path: ias-component

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

module-id="alert"

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

This module-id defines the type of process and associates this configuration with a process module. In Section 10.1, the five OracleAS Wireless server types are associated with OracleAS Wireless process module.

module-id="datafeeder"

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

This module-id defines the type of process and associates this configuration with a process module.

module-id="performance"

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

This module-id defines the type of process and associates this configuration with a process module.

module-id="messaging"

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

This module-id defines the type of process and associates this configuration with a process module.

module-id="notification"

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

This module-id defines the type of process and associates this configuration with a process module.

numprocs="1"

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

This attribute gives the number of OracleAS Wireless instances started for this process-set. The OracleAS Wireless module does not permit more than one instance with the same process-set. To start more than one processes for the same server type, put one process-set entry with one unique process-set id for each process.

For example:

<process-type id="datafeeder_server" module-id="datafeeder">
   <process-set id="datafeeder_instance_1" numprocs="1"/>
   <process-set id="datafeeder_instance_2" numprocs="1"/>
</process-type>

Do not create the following:

<process-type id="datafeeder_server" module-id="datafeeder">
   <process-set id="datafeeder_instance_1" numprocs="2"/>
</process-type>

id="start-parameters"

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

This id indicates the configuration block for start-parameters category. This category contains data related to starting the module.

id="java-bin"

Required: false
Defualt: $ORACLE_HOME/jdk/bin/java
Valid values: Full path to java.exe
Path: ias-component/process-type/process-set/module-data/
category/data

You can specify alternate paths to the Java executable. However, a valid version of Java will have to be used for the process to start up and work correctly.

id="java-parameters"

Required: false
Default: None
Valid values: Any valid Java parameters
Path: ias-component/process-type/process-set/module-data/
category/data

This id allows you to specify any valid Java parameters. All specified Java parameters will be appended to the default values. OPMN derives some java parameters internally and additional parameters can be added with this attribute.

id="class-name"

Required: false
Default: oracle.panama.sysmgmt.server.PanamaServer for start and oracle.panama.sysmgmt.client.manager for stop
Valid values: Any valid Java class names
Path: ias-component/process-type/process-set/module-data/ category/data

This id allows you to specify a Java class name other than the default ones to start or stop a OracleAS Wireless process. Oracle recommends not changing this parameter; it is for internal use only.

id="application-parameters"

Required: false
Default: none
Valid values: any valid Java application parameters
Path: ias-component/process-type/process-set/module-data/
category/data

This id allows you to put more application parameters in addition to the default one. The default one tells which OracleAS Wireless process-type to be started.

id="stop-parameters"

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

This id indicates the configuration block for stop-parameters category. In this category, some stop related module data can be specified.

See Also:

id="start-parameters"

stop timeout="300"

Required: false
Default: 180
Valid values: A timeout value in seconds
Path: ias-component/process-type/

This parameter notifies OPMN how long it should wait for the process to terminate. The default value is 180 seconds. However, when stopping OracleAS Wireless processes, database access is required and it may take up to 5 minutes to signal a process to terminate.

restart timeout="480"

Required: false
Default: 180
Valid values: A timeout value in seconds
Path: ias-component/process-type/

This parameter notifies OPMN the waiting period for a OracleAS Wireless process to be restarted. The default value is 180 seconds. However, a restart action is actually a stop and start, so the total value should be 180 (for start)+300 (for stop)=480 seconds.