Skip Headers
Oracle® Application Server Integration InterConnect Adapter for HTTP Installation and User's Guide
10g Release 2 (10.1.2)
B14074-02
  Go To Documentation Library
Home
Go To Product List
Solution Area
Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
Next
Next
 

2 Installation and Configuration

This chapter describes how to install and configure the HTTP adapter. It contains the following topics:

Installing the HTTP Adapter

The HTTP adapter must be installed in an existing Oracle home Middle Tier for OracleAS Integration InterConnect 10g Release 2 (10.1.2).

This section contains the following topics:

Preinstallation Tasks

Refer to following guides before installing the HTTP adapter:

  • Oracle Application Server Installation Guide for information about Oracle Universal Installer startup.

  • Oracle Application Server Integration InterConnect Installation Guide for information on software, hardware, and system requirements for OracleAS Integration InterConnect.


    Note:

    OracleAS Integration InterConnect Hub is installable through the OracleAS Integration InterConnect Hub installation type. You must install the OracleAS Integration InterConnect Hub before proceeding with the HTTP adapter installation.

Installation Tasks

To install the HTTP adapter:

  1. In the Available Product Components page of the OracleAS Integration InterConnect installation wizard, select OracleAS Integration InterConnect Adapter for HTTP 10.1.2.0.2 and click Next.

  2. The Set Oracle Wallet Password page is displayed. Enter and confirm the password on the page, which will be used to manage OracleAS Integration InterConnect installation. Click Next.

    • Go to step 3 if installing the HTTP adapter in an OracleAS Middle Tier Oracle home that does not have an InterConnect component already installed. Ensure that the OracleAS Integration InterConnect hub has been installed.

    • Go to step 4 if installing the HTTP adapter in an OracleAS Middle Tier Oracle home that has an existing InterConnect component. Ensure that it is a home directory to an OracleAS Integration InterConnect component.

  3. The Specify Hub Database Connection page is displayed. Enter information in the following fields:

    • Host Name: The host name of the computer where the hub database is installed.

    • Port Number: The TNS listener port for the hub database.

    • Database SID: The System Identifier (SID) for the hub database.

    • Password: The password for the hub database user.

  4. Click Next. The Specify HTTP Adapter Name page is displayed.

  5. Enter the application to be defined. Blank spaces are not permitted. The default value is myHTTPApp.


    Note:

    You can change the application name in iStudio after installation. In such case, you need to specify the password corresponding to new application name in the Oracle Wallet.

    For more informtion, refer to the following sections in Appendix A, "Frequently Asked Questions":


  6. Click Next. The Specify HTTP Adapter Usage page is displayed.

  7. Select one of the options and go to the specified step.

    If You Select... Then Click Next and Go to Step...
    Configure for both sending and receiving messages 8
    Configure for sending messages ONLY 8
    Configure for receiving messages ONLY 10


    Note:

    You can change the values for these selections later by editing the parameter settings in the adapter.ini file.

  8. Enter the URL http://hostname:port/path/ in the Configure Sending Endpoint Information page. The URL is used by the HTTP adapter for sending messages.

  9. Click Next. The installation page that is displayed next is based on the selection made in Step 7.

    If You Selected... Then Go to Step...
    Configure for both sending and receiving messages 10
    Configure for sending messages ONLY 12

  10. Enter the following information in the Configure Receiving Endpoint Information page:

    • Hostname: The hostname of the HTTP server from which OracleAS Integration InterConnect receives messages.

    • Port Number: The port number of the HTTP server.

  11. Click Next. The Summary page is displayed.

  12. Click Install to install the HTTP adapter. The following table lists the platform and the directory in which the HTTP adapter will be installed.

    Platform Directory
    UNIX ORACLE_HOME/integration/interconnect/adapters/Application
    Windows ORACLE_HOME\integration\interconnect\adapters\Application

    You defined the value of Application in Step 5. A webapps subdirectory is created in the Application directory, which includes the following files for the HTTP application:

    • An EAR file (oai.ear)

    • A web.xml file located in the WEB-INF directory

    • An application.xml file located in the META-INF directory

  13. Click Exit on the Installation page to exit the HTTP adapter installation.

Postinstallation Tasks

The HTTP adapter installation creates the adapter.ini file that consists of configuration parameters read by the HTTP adapter at startup. These configuration parameter settings are suitable for most HTTP application environments. To customize the adapter.ini file parameter settings for the HTTP application, refer to the following sections:

Customizing the Payload Type

Payload data is the data sent between applications. To change the payload type from the default of XML to D3L, edit the parameters in the adapter.ini file.

  1. Set the ota.type parameter to the payload type D3L.

    ota.type=D3L
    
    
  2. Copy the D3L XML files associated with the HTTP application to the directory in which the adapter.ini file is located.

  3. Set the ota.d3ls parameter to specify the D3L files associated with the HTTP application. For example:

    ota.d3ls=person1.xml,person2.xml
    
    

    See Also:

    ota.type and ota.d3ls parameter descriptions in Table 2-9 for additional information

Customizing the Sending Endpoints

To customize the sending endpoints (destinations) for messages, edit the parameters in the adapter.ini file.

To customize the sending endpoints, set the http.sender.timeout parameter to the desired timeout interval in milliseconds. This parameter automatically defaults to a value of 60000 during installation. For example:

http.sender.timeout=10000


See Also:

The http.sender.timeout parameter description in Table 2-9 for additional information

Customizing the Authentication Scheme

To use a custom authentication scheme, edit the parameters in the adapter.ini file. These parameters are not automatically set to default values during installation.

To customize the authentication scheme:

  1. Set the http.sender.authtype parameter to the authentication type to use. For example:

    http.sender.authtype=basic
    
    
  2. Set the http.sender.realm parameter to the realm for the authentication scheme. For example:

    http.sender.realm=ipt
    
    
  3. Set the http.sender.username parameter to the authentication user name. For example:

    http.sender.username=joe
    
    
  4. Set the http.sender.password parameter to the authentication password. For example:

    http.sender.password=100100101
    
    

Customizing a Proxy Host

To use a proxy host, edit the parameters in the adapter.ini file. These parameters are not set to default values during installation.

To customize a proxy host:

  1. Set the http.sender.proxy_host parameter to the hostname of the proxy server. For example:

    http.sender.proxy_host=www-proxy.foo.com
    
    
  2. Set the http.sender.proxy_port parameter to the port number of the proxy server. For example:

    http.sender.proxy_port=80
    
    

Customizing a Secure Socket Layer Environment

To send messages using the Secure Socket Layer (SSL) environment, edit the following parameters in the adapter.ini file. These parameters are not set to default values during installation.

To customize an SSL environment:

  1. Set the http.sender.wallet_location parameter to the directory path and name of the wallet file. For example:

    http.sender.wallet_location=/private/foo/certdb.txt
    
    

    certdb.txt is the name of the flat file exported from the Oracle Wallet manager. In the http.sender.wallet_location parameter, you may need to use Oracle Wallet Manager to add additional trusted certificates from the HTTP server to avoid incomplete certificate chain error.

    
    
  2. Set the http.sender.wallet_password parameter to the Oracle Wallet Manager password. For example:

    http.sender.wallet_password=4341193845566
    
    

    Note:

    All passwords are stored in Oracle Wallet. Refer to AppendixA, "How do I secure my passwords?" in Appendix A, "Frequently Asked Questions" for more details on how to modify and retrieve the password by using Oracle Wallet.

  3. Set the http.sender.cipher_suites parameter to the cipher suites used in the secure connection. For example:

    http.sender.cipher_suites=SSL_RSA_WITH_NULL_SHA,SSL_RSA_WITH_3DES_EDE_CBC_SHA
    
    

    See Also:

    The following parameter descriptions for additional information:

Customizing the Receiving Endpoints

To customize the messages in the receiving application, edit the parameter in the adapter.ini file.

Set the http.receiver.registry_port parameter to the RMI registry port for communicating with the servlet. This parameter automatically defaults to a value of 9901 during installation. For example:

http.receiver.registry_port=3500

Deploying an EAR File Manually

If OC4J is installed on a separate computer from the HTTP adapter, then manually edit the web.xml file and deploy the EAR file (oai.ear) located in the directory of the HTTP adapter.

To manually deploy an EAR file:

  1. Change to the directory where the HTTP application is installed. For example,

    cd myHTTPapp
    
    

    myHTTPapp is the value defined in Step 4.

  2. Extract all the files from the oai.ear file:

    jar xvf oai.ear
    
    
  3. Extract all the files from the oai.war file:

    jar xvf oai.war
    
    
  4. Change to the WEB-INF directory:

    cd WEB-INF
    
    
  5. Edit the web.xml file.

    The web.xml file specifies the RMI information. This must match the settings in the adapter.ini file.

    The following web.xml file shows the rmiHost parameter with a computer hostname setting of prodserver10:

    <init-param>
      <param-name>rmiHost</param-name>
      <param-value>prodserver10</param-value>
    </init-param>
    <init-param>
      <param-name>rmiPort</param-name>
      <param-value>9901</param-value>
    </init-param>
    <init-param>
      <param-name>instanceName</param-name>
      <param-value>oai</param-value>
    </init-param>
    <!-- set the following parameters if logging is needed. -->
    <init-param>
      <param-name>isLogOn</param-name>
      <!-- enter true/false -->
      <param-value>false</param-value>
    </init-param>
    <init-param>
      <param-name>logDir</param-name>
      <!-- directory where log file is placed. -->
      <param-value></param-value>
    </init-param>
    <init-param>
      <param-name>logLevel</param-name>
      <!-- choose one of the levels: debug, status, or  error -->
      <param-value></param-value>
     </init-param>
    
    

    Note:

    The rmiHost parameter must match the hostname of the computer where the HTTP adapter is installed. The HTTP adapter functions as the RMI server. The transport servlet makes an RMI call to submit the requests sent by the external application. You can also edit the logging options that are turned off by default.

  6. Change to the directory where the HTTP application is installed:

    cd myHttpApp
    
    
  7. Restore the oai.war and oai.ear files:

    jar cvf oai.war WEB-INF
    jar cvf oai.ear META-INF/ oai.war
    
    
  8. Deploy the EAR file.


    See Also:

    Oracle Application Server Administrator's Guide for instructions on using the Distributed Configuration Management (DCM) command line utility to deploy the EAR file

Installing Multiple HTTP Adapters in the Same Oracle Home

To install multiple instances of the HTTP adapter in same Oracle home, perform the following:

  1. Use the copyAdapter utility to make a copy of the existing HTTP adapter:

    On UNIX:

    % cd ORACLE_HOME/integration/interconnect/bin
    % copyAdapter oldAdapterName newAdapterName
    
    

    On Windows:

    c:\> cd ORACLE_HOME\integration\interconnect\bin
    c:\> copyAdapter oldAdapterName newAdapterName
    
    

    Note:

    The copyAdapter script is copied to the following bin directory only during Hub installation:
    • UNIX: ORACLE_HOME/integration/interconnect/bin

    • Windows: ORACLE_HOME\integration\interconnect\bin

    If you need to use this script to create multiple adapters on a spoke computer, then copy the script to the bin directory on the spoke computer, and edit the script to reflect the new Oracle home.


  2. Change the parameters in the adapter.ini file for the new adapter. Ensure the parameters in the new adapter.ini file are different from the adapter.ini file for the existing HTTP adapter, as follows:

    1. Change the send endpoint (ota.send.endpoint) parameter.

    2. Change the receive endpoint (ota.receive.endpoint) parameter.

      The default receive endpoint set by the installer is:

      http://machine name:port number/oai/servlet/transportServlet
      
      

      You can change the receive endpoint to the following:

      http://machine name:portnumber/oai1/servlet/transportServlet
      
      
    3. Change the payload type parameter (ota.type), if necessary.

    4. Change the RMI registry port parameter (http.receiver.registry_port) to a port not used on this computer.

  3. Change the content of the web.xml file to match that of the adapter.ini file. The web.xml file is in the following directory:

    On UNIX:

    ORACLE_HOME/integration/interconnect/adapters/newAdapterName/webapps/WEB-INF
    
    

    On Windows:

    ORACLE_HOME\integration\interconnect\adapters\newAdapterName\webapps\WEB-INF
    
    
  4. Change the RMI port to match the value entered in Step 2d.

  5. Change the following entry in the web.xml file from:

    <param-value>9901</param-value>
    
    

    to:

    <param-value> port-number-you-used-step-2d </param-value>
    
    
  6. Change the following entry in the application.xml file in the ORACLE_HOME\integration\interconnect\adapters\<your new http app name>\webapps\META-INF directory:

    <context-root>oai/servlet</context-root>
    
    

    to:

    <context-root>oai1/servlet</context-root>
    
    
  7. Create the Java archive parameter (oai1.ear):

    On UNIX:

    % cd ORACLE_HOME/integration/interconnect/adapters/<your http app name>/webapps
    % jar cvf oai.war WEB-INF
    % jar cvf oai1.ear oai.war META-INF
    
    

    On Windows:

    c:\> ORACLE_HOME\integration\interconnect\adapters\<your new http app name>\webapps
    c:\> jar cvf oai.war WEB-INF
    c:\> jar cvf oai1.ear oai.war META-INF
    
    

    An .ear file called oai1.ear has been created, which is ready for deployment.

  8. Deploy the oai1.ear file in the OracleAS environment:

    On UNIX:

    % cd ORACLE_HOME/dcm/bin
    % dcmctl shell
    dcmctl> deployApplication -f oai1.ear  -a oaiservlet1 -co oc4j_oai
    dcmctl> exit
    
    

    On Windows:

    c:\> ORACLE_HOME\dcm\bin\dcmctl shell
    dcmctl> deployApplication -f oai1.ear  -a oaiservlet1 -co oc4J_OAI
    dcmctl> exit
    
    

    Note:

    oaiservlet1 is a unique application name that you assign to your servlet. If this name is already used in the current environment, then select a different name.

  9. Restart the HTTP server. Verify whether the new receiving endpoint is functioning by entering the URL used in Step 2b. If the servlet is deployed correctly, then a diagnostic page is displayed.

After running the copyAdapter script, If you want to manage or monitor the newly installed adapter through Oracle Enterprise Manager 10g Application Server Control Console, then you need to modify the opmn.xml file by adding information about the new instance. For example, you have created a new instance of the HTTP adapter myHTTPApp1 by using the copyAdapter script. To manage the myHTTPApp1 adapter through Enterprise Manager, perform the following:

  1. Navigate to the MiddleTier\bin directory and run the following command to stop the Enterprise Manager:

    emctl stop iasconsole
    
    
  2. Next, specify the information about this new instance in the opmn.xml file located in the ORACLEMIDDLETIER_HOME/opmn/conf directory as follows:

    <process-type id="myHTTPApp1" module-id="adapter" working-dir="$ORACLE_
    HOME/integration/interconnect/adapters/myHTTPApp1" status="enabled">
           <start timeout="600" retry="2"/>
           <stop timeout="120"/>
           <port id="icadapter_dmsport_range" range="15701-15800"/>
           <process-set id="myHTTPApp1" restart-on-death="true" numprocs="1">
                <module-data>
                    <category id="start-parameters">
                        <data id="java-parameters" value="-Xms8M"/>
                        <data id="class-name"
                         value="oracle.oai.agent.service.AgentService"/>
                    </category>
                    <category id="stop-parameters">
                        <data id="java-parameters" value="-mx64m"/>
                        <data id="class-name"
                         value="oracle.oai.agent.proxy.ShutdownAgent"/>
                        <data id="application-parameters"
                         value="persistence/Agent.ior"/>
                    </category>
                </module-data>
           </process-set>
    </process-type>
    
    

    The opmn.xml file would appear like this:

    <process-type id="myHTTPApp" module-id="adapter" working-dir="$ORACLE
    _HOME/integration/interconnect/adapters/myHTTPApp" status="enabled">
           <start timeout="600" retry="2"/>
           <stop timeout="120"/>
           <port id="icadapter_dmsport_range" range="15701-15800"/>
           <process-set id="myHTTPApp" restart-on-death="true" numprocs="1">
                <module-data>
                    <category id="start-parameters">
                        <data id="java-parameters" value="-Xms8M"/>
                        <data id="class-name"
                         value="oracle.oai.agent.service.AgentService"/>
                    </category>
                    <category id="stop-parameters">
                        <data id="java-parameters" value="-mx64m"/>
                        <data id="class-name"
                 value="oracle.oai.agent.proxy.ShutdownAgent"/>
                 <data id="application-parameters"
                  value="persistence/Agent.ior"/>
             </category>
         </module-data>
      </process-set>
    </process-type>
                
    <process-type id="myHTTPApp1" module-id="adapter" working-dir="$ORACLE
    _HOME/integration/interconnect/adapters/myHTTPApp1" status="enabled">
           <start timeout="600" retry="2"/>
           <stop timeout="120"/>
           <port id="icadapter_dmsport_range" range="15701-15800"/>
           <process-set id="myHTTPApp1" restart-on-death="true" numprocs="1">
            <module-data>
              <category id="start-parameters">
                  <data id="java-parameters" value="-Xms8M"/>
                  <data id="class-name"
                   value="oracle.oai.agent.service.AgentService"/>
              </category>
              <category id="stop-parameters">
                   <data id="java-parameters" value="-mx64m"/>
                   <data id="class-name"
                    value="oracle.oai.agent.proxy.ShutdownAgent"/>
                   <data id="application-parameters"
                    value="persistence/Agent.ior"/>
              </category>
            </module-data>
           </process-set>
    </process-type>
    
    
  3. Save the opmn.xml file.

  4. Navigate to the MiddleTier\opmn\bin directory and run the following command to reload the OPMN:

    opmnctl reload
    
    
  5. You can start the myHTTPApp1 adapter by using the following command

    opmnctl startproc ias-component="InterConnect" process-type="myHTTPApp1"
    
    
  6. Navigate to the MiddleTier\bin directory and run the following command to start the Enterprise Manager:

    emctl start iasconsole
    
    
  7. Login to the Oracle Enterprise Manager 10g Application Server Control Console to view and manage the newly installed or copied adapter. For information about how to use Oracle Enterprise Manager 10g Application Server Control Console , refer to the Oracle Application Server Integration InterConnect User's Guide


Note:

While installing multiple adapters in the same computer, the copyadapter script does not create entries for the new adapter's password in the Oracle Wallet. You need to manually create a password for this new adapter using the Oracle Wallet Manager. To store the password in Oracle Wallet, use the following format:
ApplicationName/password

The number of entries is dependent on the type of adapter. For example, Database adapter needs two entries whereas AQ Adapter needs only one entry. For more information about how to manage your passwords in Oracle Wallet, refer to AppendixA, "How do I secure my passwords?" in Appendix A, "Frequently Asked Questions"


Configuring the HTTP Adapter

After installing the HTTP adapter, you can configure it according to your requirements. The following tables describe the location and details of the configuration files.

Table 2-1 describes the location where the adapter is installed.

Table 2-1 HTTP Adapter Directory

Platform Directory

UNIX

ORACLE_HOME/integration/interconnect/adapters/Application

Windows

ORACLE_HOME\integration\interconnect\adapters\Application


Table 2-2 describes the various executable files of the HTTP adapter.

Table 2-2 HTTP Executable Files

File Description

start (UNIX)

Does not use parameters; starts the adapter.

start.bat (Windows)

Does not use parameters; starts the adapter.

stop (UNIX)

Does not use parameters; stops the adapter.

stop.bat (Windows)

Does not use parameters; stops the adapter.


Table 2-3 describes the HTTP adapter configuration files.

Table 2-3 HTTP Configuration Files

File Description

adapter.ini (UNIX)

Consists of all the initialization parameters that the adapter reads at startup.

adapter.ini (Windows)

Consists of all the initialization parameters that the adapter reads at startup.


Table 2-4 describes the directories used by the HTTP adapter.

Table 2-4 HTTP Directories

Directory Description

logs

The adapter activity is logged in subdirectories of the logs directory. Each time the adapter is run, a new subdirectory is created for the log.xml log file.

persistence

The messages are made available in this directory. Do not edit this directory or its files.


HTTP Adapter Ini File Settings

The following.ini files are used to configure the HTTP adapter:

hub.ini Files

The HTTP adapter connects to the hub database using the parameters in the hub.ini file located in the hub directory. Table 2-5 gives a description and an example for each parameter.

Table 2-5 hub.ini Parameters

Parameter Description Example

hub_host

The name of the computer hosting the hub database. There is no default value. The value is set during installation.

hub_host=mpscottpc

hub_instance

The SID of the hub database. There is no default value. The value is set during installation.

hub_instance=orcl

hub_port

The TNS listener port number for the hub database instance. There is no default value. The value is set during installation.

hub_port=1521

hub_username

The name of the hub database schema (or user name). The default value is ichub.

hub_username=ichub

repository_name

The name of the repository that communicates with the adapter. The default value is InterConnectRepository.

repository_name=InterConnectRepository


Oracle Real Application Clusters hub.ini Parameters

When a hub is installed on an Oracle Real Application Clusters database, the parameters listed in Table 2-6 represent information about additional nodes used for connection and configuration. These parameters are in addition to the default parameters for the primary node. In Table 2-6, x represents the node number which can range from 2 to total number of nodes in cluster. For example, if the cluster setup contains 4 nodes, x can be a value between 2 and 4.

Table 2-6 Oracle Real Application Clusters Hub.ini Parameters

Parameter Description Example

hub_hostx

The host where the Real Application Clusters database is installed.

hub_host2=dscott13

hub_instancex

The instance on the respective node.

hub_instance2=orcl2

hub_num_nodes

The number of nodes in a cluster.

hub_num_nodes=4

hub_portx

The port where the TNS listener is listening.

hub_port2=1521


adapter.ini Files

The agent component of the HTTP adapter reads the adapter.ini file at run time to access information on configuring the HTTP adapter parameter. Table 2-7 gives a description and an example for each parameter.

Table 2-7 adapter.ini Parameters

Parameter Description Example

agent_admin_port

Specifies the port through which the adapter can be accessed through firewalls.

Possible value: A valid port number

Default value: None

agent_admin_port=1059

agent_delete_file_cache_at_startup

Specifies whether to delete the cached metadata during startup. If any agent caching method is enabled, then metadata from the repository is cached locally on the file system. Set the parameter to true to delete all cached metadata on startup.

Possible values: true or false

Default value: false

Note: After changing metadata or DVM tables for the adapter in iStudio, you must delete the cache to guarantee access to new metadata or table information.

agent_delete_file_cache_at_startup=false

agent_dvm_table_caching

Specifies the Domain value Mapping (DVM) table caching algorithm.

Possible values:

  • startup: Cache all DVM tables at startup. This may take a while if there are a lot of tables in the repository

  • demand: Cache tables as they are used

  • none: No caching. This slows down performance

Default value: demand

agent_dvm_table_caching=demand

agent_log_level

Specifies the amount of logging necessary.

Possible values:

  • 0= errors only

  • 1= status and errors

  • 2= trace, status, and errors

Default value: 1

agent_log_level=2

agent_lookup_table_caching

Specifies the lookup table caching algorithm.

Possible values:

  • startup: Cache all lookup tables at startup. This may take a while if there are a lot of tables in the repository

  • demand: Cache tables as they are used

  • none: No caching. This slows down performance.

Default value: demand

agent_lookup_table_caching=demand

agent_max_ao_cache_size

Specifies the maximum number of application object metadata to cache.

Possible value: An integer greater than or equal to 1

Default value: 200

agent_max_ao_cache_size=200

agent_max_co_cache_size

Specifies the maximum number of common object metadata to cache.

Possible value: An integer greater than or equal to 1

Default value: 100

agent_max_co_cache_size=100

agent_max_dvm_table_cache_size

Specifies the maximum number of DVM tables to cache.

Possible value: An integer greater than or equal to 1

Default value: 200

agent_max_dvm_table_cache_size=200

agent_max_lookup_table_cache_size

Specifies the maximum number of lookup tables to cache.

Possible value: An integer greater than or equal to 1

Default value: 200

agent_max_lookup_table_cache_size=200

agent_max_message_metadata_cache_size

Specifies the maximum number of message metadata (publish/subscribe and invoke/implement) to cache.

Possible value: An integer greater than or equal to 1

Default value: 200

agent_max_message_metadata_cache_size=200

agent_max_queue_size

Specifies the maximum size to which internal OracleAS Integration InterConnect message queues can grow.

Possible value: An integer greater than or equal to 1

Default value: 1000

agent_max_queue_size=1000

agent_message_selector

Specifies conditions for message selection when the adapter registers its subscription with the hub.

Possible value: A valid Oracle Advanced Queue message selector string (such as '%,aqapp,%')

Default value: None

agent_message_selector=%,aqapp,%

agent_metadata_caching

Specifies the metadata caching algorithm.

Possible values:

  • startup: Cache everything at startup. This may take time if there are a lot of tables in the repositor

  • demand: Cache metadata as it is used

  • none: No caching. This slows down performance

Default value: demand

agent_metadata_caching=demand

agent_persistence_cleanup_interval

Specifies how often to run the persistence cleaner thread in milliseconds.

Possible value: An integer greater than or equal to 30000 milliseconds

Default value: 60000

agent_persistence_cleanup_interval=60000

agent_persistence_queue_size

Specifies the maximum size of internal OracleAS Integration InterConnect persistence queues.

Possible value: An integer greater than or equal to 1

Default value: 1000

agent_persistence_queue_size=1000

agent_persistence_retry_interval

Specifies how often the persistence thread retries when it fails to send an OracleAS Integration InterConnect message.

Possible value: An integer greater than or equal to 5000 milliseconds

Default value: 60000

agent_persistence_retry_interval=60000

agent_pipeline_from_hub

Specifies whether to activate the pipeline for messages from the hub to the bridge. If you set the pipeline to false, then the file persistence is not used in that direction.

Possible value: true, false

Default value: false

agent_pipeline_from_hub=false

agent_pipeline_to_hub

Specifies whether to activate the pipeline for messages from the bridge to the hub. If you set the pipeline to false, then the file persistence is not used in that direction.

Possible value: true, false

Default value: false

agent_pipeline_to_hub=false

agent_reply_message_selector

Specifies the application instance to which the reply must be sent. This parameter is used only if multiple adapter instances exist for the given application and given partition.

Possible value: A string built using the application name (parameter:application) concatenated with the instance number (parameter:instance_number).

Default value: None

If application=httpapp, instance_number=2, then agent_reply_message_selector=receipient_list like '%,httpapp2,%'

agent_reply_subscriber_name

Specifies the subscriber name used when multiple adapter instances are used for the given application and given partition. This parameter is optional if only one instance is running.

Possible value: The application name (parameter:application) concatenated with the instance number (parameter:instance_number)

Default value: None

If application=httpapp and instance_number=2, then agent_reply_subscriber_name=httpapp2

agent_subscriber_name

Specifies the subscriber name used when this adapter registers its subscription.

Possible value: A valid Oracle Advanced Queue subscriber name

Default value: None

agent_subscriber_name=httpapp

agent_throughput_measurement_enabled

Specifies if the throughput measurement is enabled. Set this parameter to true to activate all throughput measurements.

Default value: true

agent_throughput_measurement_enabled=true

agent_tracking_enabled

Specifies if message tracking is enabled. Set this parameter to false to turn off tracking of messages. Set this parameter to true to track messages with tracking fields set in iStudio.

Default value: true

agent_tracking_enabled=true

agent_use_custom_hub_dtd

Specifies whether to use a custom DTD for the common view message when handing it to the hub. By default, adapters use a specific OracleAS Integration InterConnect DTD for all messages sent to the hub.

Set this parameter to true to have the adapter use the DTD imported for the message of the common view instead of the OracleAS Integration InterConnect DTD.

Default value: None

agent_use_custom_hub_dtd=false

application

Specifies the name of the application to which this adapter connects. This must match with the name specified in iStudio while creating metadata.

Possible value: An alphanumeric string

Default value: None

application=httpapp

encoding

Specifies the character encoding for published messages. The adapter uses this parameter to generate encoding information for the encoding tag of transformed OracleAS Integration InterConnect messages. OracleAS Integration InterConnect represents messages internally as XML documents.

Possible value: A valid character encoding

Default value: UTF-8

When there is no existing encoding in the subscribed message, this parameter will be used to explicitly specify the encoding of the published message.This parameter will be ignored when the encoding already exists in the subscribed message.

encoding=Shift_JIS

external_dtd_base_url

Specify the base URL for loading external enitites and DTDs. This specifies to the XML parser to resolve the external entities in the instance document using the given URL.Possible value: A URLDefault value: The URL of the current user directory

external_dtd_base_url=file://C:\InterConnect10_1_2\adapters\AQApp\

instance_number

Specifies the instance number to which this adapter corresponds. Specify a value only if you have multiple adapter instances for the given application with the given partition.

Possible value: An integer greater than or equal to 1

Default value: None

instance_number=1

nls_country

Specifies the ISO country code. The codes are defined by ISO-3166.

Possible value: A valid code. A full list of the codes is available at http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

Default value: US

Note: This parameter specifies date format. It is applicable only for the date format.

nls_country=US

nls_date_format

Specifies the format for a date field expressed as a string.

Possible value: Any valid date format pattern as shown in Table 2-8 for the definitions of the format characters.

Default value: EEE MMM dd HHmmss zzz yyyy

Date format pattern dd/MMM/yyyy can represent 01/01/2003.

nls_date_format=dd-MMM-yy

Multiple date formats can be specified as num_nls_formats=2

nls_date_format1=dd-MMM-yy

nls_date_format2=dd/MMM/yy

nls_language

Specifies the ISO language code. The codes are defined by ISO-639.

Possible value: A valid code. A full list of these codes is available at http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt

Default value: en

Note: This parameter specifies date format. It is applicable for the date format only.

nls_language=en

partition

Specifies the partition this adapter handles as specified in iStudio.

Possible value: An alphanumeric string

Default value: None

partition=germany

service_class

Specifies the entry class for the Windows service.

Possible value: oracle/oai/agent/service/AgentService

Default value: None

service_class=oracle/oai/agent/service/AgentService

service_classpath

Specifies the class path used by the adapter JVM. If a custom adapter is developed and the adapter is to pick up any additional jar files, then add the files to the existing set of jar files.

Possible value: A valid PATH setting

Default value: None

This parameter is only for Microsoft Windows.

service_classpath=D:\oracle\oraic\integration\interconnect\lib\oai.jar; D:\oracle\oraic\jdbc\classes12.zip

service_jdk_dll

Specifies the Dynamic Link Library (DLL) that the adapter JVM should use.

Possible value: A valid jvm.dll

Default value: jvm.dll

This parameter is only for Microsoft Windows.

service_jdk_dll=jvm.dll

service_jdk_version

Specifies the JDK version that the adapter Java VM should use.

Possible value: A valid JDK version number

Default value: 1.4

This parameter is only for Microsoft Windows.

service_jdk_version=1.4

service_max_heap_size

Specifies the maximum heap size for the adapter JVM.

Possible value: A valid JVM heap size

Default value: 536870912

This parameter is only for Microsoft Windows.

service_max_heap_size=536870912

service_max_java_stack_size

Specifies the maximum size to which the JVM stack can grow.

Possible value: A valid JVM maximum stack size

Default value: Default value for the JVM

This parameter is only for Microsoft Windows.

service_max_java_stack_size=409600

service_max_native_stack_size

Specifies the maximum size the JVM native stack can grow.

Possible value: The valid JVM maximum native stack size

Default value: Default value for the JVM

This parameter is only for Microsoft Windows.

service_max_native_size=131072

service_min_heap_size

Specifies the minimum heap size for the adapter JVM.

Possible value: The valid JVM heap size

Default value: 536870912

This parameter is only for Microsoft Windows.

service_min_heap_size=536870912

service_num_vm_args

Specifies the number of service_vm_argnumber parameters specified in JVM.

Possible value: The number of service_vm_argnumber parameters

Default value: None

This parameter is only for Microsoft Windows.

service_num_vm_args=1

service_path

Specifies the environment variable PATH. The PATH variable is set before starting the Java Virtual Machine (JVM). Typically, list all directories that contain necessary DLLs.

Possible value: The valid PATH environment variable setting

Default value: None

This parameter is only for Microsoft Windows.

service_path=%JREHOME%\bin;D:\oracle\oraic\bin

service_vm_argnumber

Specifies any additional arguments to the JVM. For example, to retrieve line numbers in any of the stack traces, set service_vm_arg1=java.compiler=NONE. If a list of arguments exists, then use multiple parameters as shown in the example, by incrementing the last digit by 1.

Possible value: A valid JVM arguments

Default value: None

This parameter is only for Microsoft Windows.

service_vm_arg1=java.compiler= NONE

service_vm_arg2=oai.adapter=.aq


Table 2-8 shows the reserved characters used to specify the value of the nls_date_format parameter. Use these characters to define date formats.

Table 2-8 Reserved Characters for the nls_date_format Parameter

Letter Description Example

G

Era designator

AD

y

Year

1996 or 96

M

Month in year

July or Jul or 07

w

Week in year

27

W

Week in month

2

D

Day in year

189

d

Day in month

10

F

Day of week in month

Number 2

E

Day in week

Tuesday or Tue

a

a.m./p.m. marker

P.M.

H

Hour in day (0-23)

0

k

Hour in day (1-24)

24

K

Hour in a.m./p.m. (0-11)

0

h

Hour in a.m./p.m. (1-12)

12

m

Minute in hour

30

s

Second in minute

55

S

Millisecond

978


HTTP Adapter-Specific Parameters

Table 2-9 lists the parameters specific to the HTTP adapter.

Table 2-9 HTTP Adapter-Specific Parameters

Parameter Description Example

bridge_class

Specifies the entry class for the HTTP adapter. Once set, the value cannot be modified.

Possible value: oracle.oai.agent.adapter.technology.TechBridge

Default value: None

bridge_class=oracle.oai.agent.adapter.technology.TechBridge

http.receiver. customized_class

Specifies the class name for customizing the HTTP response.

Default value: None

http.receiver.customized_class=MyBanner

http.receiver.customizer_class

Specifies the class name for customizing the HTTP sender.

Default value: oracle.oai.agent.adapter.technology.HTTPDefaultSenderCustomizer

http.receiver.customizer_class=MyHTTPReceiverCustomizer

http.receiver.instance_name

Specifies the instance name of the HTTP receiver. If the default value is not used, then the instanceName of the initial parameter of the transport servlet must be modified to match this instance name.

Default value: oai

http.receiver.instance_name=oai

http.receiver.registry_port

Specifies the RMI port used by the HTTP receiver.

Default value: 9901

http.receiver.registry_port=9901

http.reqreply.mode

Specifies the type of mode, synchronous or asynchronous, that can be set for the request reply messaging paradigm.

Possible values: sync, async

If the value is async, the reply will be sent to the send endpoint defined by ota.send.endpoint.

Default value: async

http.reqreply.mode=sync

http.reqreply.syncmode.timeout

Specifies the time period the adapter should wait for a reply. Set this property only if http.reqreply.mode is synchronous. Set this property to customize the time period the adapter should wait for a reply. The value should be in milliseconds and -1 will be interpreted as infinite.

Default value: 60s

http.reqreply.syncmode.timeout=6000

http.sender.authtype

Specifies if authentication is needed.

Possible value: basic or digest.

Default value: None

http.sender.authtype= basic

http.sender.cipher_suites

Specifies the cipher to use for encrypting messages. This is an optional parameter for choosing the cipher suites. The selections are:

SSL_RSA_WITH_3DES_EDE_CBC_SHA

SSL_RSA_WITH_RC4_128_SHA

SSL_RSA_WITH_RC4_128_MD5

SSL_DH_anon_WITH_3DES_EDE_CBC_SHA

SSL_DH_anon_WITH_RC4_128_MD5

SSL_DH_anon_WITH_DES_CBC_SHA

SSL_RSA_WITH_DES_CBC_SHA

SSL_RSA_EXPORT_WITH_RC4_40_MD5

SSL_RSA_EXPORT_WITH_DES40_CBC_SHA

SSL_DH_anon_EXPORT_WITH_RC4_40_MD5

SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA

SSL_RSA_WITH_NULL_SHA

SSL_RSA_WITH_NULL_MD5

Default value: None

http.sender.cipher_suites=SSL_RSA_WITH_NULL_SHA,SSL_RSA_WITH_3DES_EDE_CBC_SHA

http.sender.customizer_class

Specifies the class name for customizing the HTTP sender.

Default value: oracle.oai.agent.adapter.technology.HTTPDefaultSenderCustomizer

http.sender.customizer_class=MyHTTPSenderCustomizer

http.sender.password

Specifies the password used in the sender.password authentication. This password can also be encrypted by running the encrypt tool and renaming this parameter to encrypted_http.sender.password.

Default value: None

See Also: AppendixA, "How do I secure my passwords?" in Appendix A, "Frequently Asked Questions" for instructions on how to modify and retrieve the password

http.sender.password=httpuser

http.sender.proxy_host

Specifies the proxy hostname.

Default value: None

http.sender.proxy_host=www-proxy.foo.com

http.sender.proxy_port

Specifies the port number for the proxy host. This is needed if the proxy host is set.

Default value: None

http.sender.proxy_port=80

http.sender.realm

Specifies the realm for the authentication scheme.

Default value: None

http.sender.realm=ipt

http.sender.timeout

Specifies the time out for an HTTP connection. The unit is milliseconds.

Default value: 60000 milliseconds (60 seconds)

http.sender.timeout=10000

http.sender.username

Specifies the authentication user name.

Default value: None

http.sender.username=joe

http.sender.wallet_location

Specifies the path and name of the exported wallet file (not .p12 file). This is required only when SSL is used.

Default value: None

http.sender.wallet_location=/private/foo/ certdb.txt

http.sender.wallet_password

Specifies the password for Oracle Wallet Manager. This is required only when SSL is used. This password can also be encrypted by running the encrypt tool and renaming this parameter to encrypted_http.sender.wallet_password.

Default value: None

See Also: "How do I secure my passwords?" for instructions on how to modify and retrieve the password

http.sender.wallet_password=walletuser

ota.d3ls

Specifies the list of D3L XML files used by the bridge. Each business event handled by the bridge must have its own D3L XML file. When a new D3L XML file is imported in iStudio for use by an application using the HTTP adapter, the parameter must be updated and the HTTP adapter restarted.

ota.d3ls=person.xml, person1.xml

ota.receive. endpoint

Specifies the URL of the receiving application. The URL is of the form:

http[s]://hostname:port/path

Default value: None

ota.receive.endpoint= http://site.com:8888/ servlet/inbound

ota.send.endpoint

Specifies the URL of the sending application. The URL is of the form:

http[s]://hostname:port/path

Default value: None

ota.send.endpoint=

http://site.com:8888/servlet/inbound

ota.type

Specifies the message payload type that the HTTP adapter handles for both incoming and outgoing messages. The options are XML, XML_NVP, or D3L.

Default value: XML

ota.type=XML


Uninstalling the HTTP Adapter

To uninstall the HTTP adapter, perform the following:

  1. Navigate to the MiddleTier\opmn\bin directory.

  2. Run the following command to check the adapter status.

    opmnctl status
    
    
  3. If the HTTP adapter instance that you want to remove is running, stop it by using the the following command:

    opmnctl stopproc ias-component="InterConnect" process-type="HTTPApp"
    
    

    where HTTPApp is the name of the HTTP adapter instance.

  4. Navigate to the MiddleTier\bin directory and run the following command to stop the Enterprise Manager:

    emctl stop iasconsole
    
    
  5. Carefully, remove the adapter process-type entry from the opmn.xml file located in the MiddleTier\opmn\conf directory. For example, to remove an HTTP adapter instance myHTTPApp1, delete the following information specific to the adapter instance:

    <process-type id="myHTTPApp1" module-id="adapter" working-dir="$ORACLE_HOME/integration/interconnect/adapters/myHTTPApp1" status="enabled">
           <start timeout="600" retry="2"/>
           <stop timeout="120"/>
           <port id="icadapter_dmsport_range" range="15701-15800"/>
           <process-set id="myHTTPApp1" restart-on-death="true" numprocs="1">
                <module-data>
                    <category id="start-parameters">
                        <data id="java-parameters" value="-Xms8M"/>
                        <data id="class-name"
                         value="oracle.oai.agent.service.AgentService"/>
                    </category>
                    <category id="stop-parameters">
                        <data id="java-parameters" value="-mx64m"/>
                        <data id="class-name"
                         value="oracle.oai.agent.proxy.ShutdownAgent"/>
                        <data id="application-parameters"
                         value="persistence/Agent.ior"/>
                    </category>
                </module-data>
           </process-set>
    </process-type>
    
    
  6. Save the opmn.xml file.

  7. Navigate to the MiddleTier\opmn\bin directory and run the following command to reload the OPMN:

    opmnctl reload
    
    
  8. Navigate to the ORACLE_HOME\integration\interconnect\adapters directory and delete the folder that was created for the removed adapter instance.

  9. Navigate to the MiddleTier\bin directory and run the following command to start the Enterprise Manager:

    emctl start iasconsole