Skip Headers
Oracle® Application Server Integration InterConnect Adapter for HTTP Installation and User's Guide
10g Release 2 (10.1.2)
Part No. B14074-01
  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:

2.1 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:

2.1.1 Preinstallation Tasks

Consult the 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 mounting CD-ROMs, 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.

2.1.2 Installation Tasks

To install the HTTP adapter:

  1. In the Available Product Components page of the OracleAS Integration InterConnect installation, select HTTP adapter, and click Next.

  2. The Set Oracle Wallet Password screen is displayed. Enter and confirm the password on the screen, which will be used to administer 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.

  6. Click Next. The Specify HTTP Adapter Usage screen 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 screen that appears 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 adapter is installed in the following directory, depending on the operating system:

    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.

2.1.3 Postinstallation Tasks

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:

2.1.3.1 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

2.1.3.2 Customizing the Sending Endpoints

To customize the behavior of 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

2.1.3.3 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
    
    

    See Also:


2.1.3.4 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
    
    

2.1.3.5 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 "How do I secure my passwords?" for more details on how to modify and retrieve the password 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:

2.1.3.6 Customizing the Receiving Endpoints

To customize the behavior of 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

2.1.3.7 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

2.2 Configuring the HTTP Adapter

After an HTTP adapter installation, you can configure it for your needs. 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 oailog.txt log file.
persistence The messages are made available in this directory. Do not edit this directory or its files.

2.2.1 Ini File Settings

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

2.2.1.1 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 lists the parameter names, descriptions for each parameter, and examples.

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. The number is between 2 and the number of nodes. 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

2.2.1.2 adapter.ini Files

The agent component of the HTTP adapter reads the adapter.ini file at runtime to access information on configuring the HTTP adapter parameter. Table 2-7 lists the parameter names, descriptions for each parameter, and examples.

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 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 (like '%,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 repository.

  • 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 turn on 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 turn on 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 turn on 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 URL.Default 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 for the date format only.

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 for Microsoft Windows only.

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 for Microsoft Windows only.

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 for Microsoft Windows only.

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 for Microsoft Windows only.

service_max_heap_size=536870912
service_max_java_stack_size Specifies the maximum size the JVM stack can grow.

Possible Value: A valid JVM maximum stack size.

Default Value: Default value for the JVM.

This parameter is for Microsoft Windows only.

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 for Microsoft Windows only.

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 for Microsoft Windows only.

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 for Microsoft Windows only.

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 for Microsoft Windows only.

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 for Microsoft Windows only.

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.

In the case of 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: "How do I secure my passwords?" 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