Oracle Application Server InterConnect Adapter for HTTP Installation and User's Guide 10g (9.0.4) Part Number B10413-01 |
|
This chapter describes the installation and configuration of the HTTP adapter in the following topics:
This section contains these topics:
The HTTP adapter must be installed in one of the following Oracle homes:
Consult the following guides before proceeding with HTTP adapter installation:
To install the HTTP adapter:
Consider the following scenarios:
The hub database information, such as the SID, host, port, and username/password from the Hub installation, is needed for step 2.
Note:
myHTTPApp
.
The OracleAS InterConnect HTTP Adapter usage screen appears.
adapter.ini
file.
If You Select... | Then Click Next and Go to Step... |
---|---|
Configure for both sending and receiving messages |
|
Configure for sending messages ONLY |
|
Configure for receiving messages ONLY |
The installation screen that appears next is based on the selection you made in Step 5:
If You Selected... | Then Go to Step... |
---|---|
Configure for both sending and receiving messages |
|
Configure for sending messages ONLY |
When finished, the Summary screen appears.
Platform | Directory |
---|---|
Windows |
|
UNIX |
|
Application
is the value you specified in Step 3. A webapps
subdirectory is created in the Application
directory identified in Step 11. webapps
includes the following files created for the HTTP application:
HTTP adapter installation creates an adapter.ini
file that consists of configuration parameters read by the HTTP adapter at startup. The configuration parameter settings are appropriate for most HTTP application environments. If you want to customize some adapter.ini
file parameter settings for the HTTP application, see the following sections:
Payload data is the data sent between applications. If you want to change the payload datatype from the default of XML to the data definition description language (D3L), edit the following parameters in the adapter.ini
file.
To customize the payload datatype:
ota.type
parameter to the payload type D3L
. For example:
ota.type
=D3L
adapter.ini
file is located.
ota.d3ls
parameter to specify the D3L files associated with the HTTP application. For example:
ota.d3ls=person1.xml,person2.xml
If you want to customize the behavior of the sending endpoints (destinations) for messages, edit the following parameter in the adapter.ini
file.
To customize the sending endpoints:
http.sender.timeout
parameter to the timeout interval in milliseconds for HTTP connections. This parameter automatically defaults to a value of 60000
during installation. For example:
http.sender.timeout
=10000
If you want to use an authentication scheme, edit the following parameters in the adapter.ini
file. These parameters are not automatically set to default values during installation.
To customize the authentication scheme:
http.sender.authtype
parameter to the authentication type to use. For example:
http.sender.authtype
=basic
http.sender.realm
parameter to the realm for the authentication scheme. For example:
http.sender.realm
=ipt
http.sender.username
parameter to the authentication username. For example:
http.sender.username
=joe
http.sender.password
parameter to the authentication password. For example:
http.sender.password
=100100101
See Also:
The following parameter descriptions for additional information:
|
If you want to use a proxy host, edit the following parameters in the adapter.ini
file. These parameters are not automatically set to default values during installation.
To customize a proxy host:
http.sender.proxy_host
parameter to the hostname of the proxy server. For example:
http.sender.proxy_host
=www-proxy.foo.com
http.sender.proxy_port
parameter to the port number of the proxy server. For example:
http.sender.proxy_port
=80
If you want to use the secure socket layer (SSL) environment for sending messages, edit the following parameters in the adapter.ini
file. These parameters are not automatically set to default values during installation.
To customize a secure socket layer environment:
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 some cases, you may need to use Oracle Wallet manager to add additional trusted certificates from the HTTP server into your wallet to avoid incomplete certificate chain error.
http.sender.wallet_password
parameter to the Oracle Wallet Manager password. For example:
http.sender.wallet_password
=4341193845566
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:
|
If you want to customize the behavior of receiving endpoint messages, edit the following parameter in the adapter.ini
file.
To customize the receiving endpoints:
http.receiver.registry_port
parameter to the remote method invocation (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
If the Oracle Application Server Containers for J2EE (OC4J) is installed on a separate computer from the HTTP adapter, you must manually:
To manually deploy an EAR file:
cd myHTTPapphome
where myHTTPapphome
is the directory in which the HTTP application is installed and the value you defined in Step 3.
oai.ear
file:
jar xvf oai.ear
oai.war
file:
jar xvf oai.war
cd WEB-INF
web.xml
file:
web.xml
specifies the RMI information that must match with the setting in the adapter.ini
file. For example, rmiHost
must match the hostname of the computer on which the HTTP adapter is installed. The HTTP adapter serves 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.
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>
cd myHttpApphome
oai.war
and oai.ear
files:
jar cvf oai.war WEB-INF jar cvf oai.ear META-INF/ oai.war
Table 2-2, Table 2-3, and Table 2-4 describe executable files, configuration files, and directories. These files and directories are accessible from the directory shown in Table 2-1:
Platform | Directory |
---|---|
UNIX |
|
Windows |
|
File | Description |
---|---|
|
Contains one error code per line |
|
Consists of all the initialization parameters that the adapter reads at startup |
The HTTP adapter connects to the hub database using parameters from the hub.ini
file located in the hub directory. Table 2-5 lists the parameter name, description, the possible and default values, and example for each parameter
When a hub is installed on a Real Application Cluster (RAC) database, parameters listed in Table 2-6 represent information on additional nodes used for connection and configuration. These parameters are added on top of the default parameters which represent the primary node. In Table 2-6, x
represent the node number, which varies between 2 and the number of nodes. For example, if the RAC setup contains 4 nodes, x
can take a value between 2 and 4.
The agent component of the HTTP adapter reads the adapter.ini
file at runtime to access HTTP adapter parameter configuration information. Table 2-7 lists the parameter name, a description for each parameter, the possible and default values, and an example.
Parameter | Description | Example |
---|---|---|
|
Specifies the name of the application to which this adapter connects. This must match with the name specified in iStudio during creation of metadata. Use any alphanumeric string. There is no default value. |
|
|
Specifies the partition this adapter handles as specified in iStudio. Any alphanumeric string is a possible value. There is no default value. |
|
|
Specifies the instance number to which this adapter corresponds. Specify a value only if you want to have multiple adapter instances for the given application with the given partition. Possible values are any integer greater than or equal to |
|
|
Specifies the amount of logging necessary. Possible values are:
The default value is |
|
|
Specifies the subscriber name used when this adapter registers its subscription. The possible value is a valid Oracle Advanced Queue subscriber name. There is no default value. |
|
|
Specifies conditions for message selection when registering its subscription with the hub. The possible value is a valid Oracle Advanced Queue message selector string. There is no default value. |
|
|
Specifies the subscriber name used when multiple adapter instances for the given application with the given partition are used. This parameter is optional if only one instance is running. The possible value is the application name ( |
If |
|
Used only if multiple adapter instances exist for the given application with the given partition. The possible value is a string built using the concatenated application name ( |
If |
|
Specifies if message tracking is enabled. Set this parameter to |
|
|
Specifies if the throughput measurement is enabled. Set this parameter to |
|
|
Specifies whether to use a custom document type definition (DTD) for the common view message when handing it to the hub (the repository in which metadata is stored). By default, adapters use an OracleAS InterConnect-specific DTD for all messages sent to the hub, as other OracleAS InterConnect adapters retrieve the messages from the hub and know how to interpret them.
Set this parameter to |
|
|
Specifies the metadata caching algorithm. Possible values are:
The default value is |
|
|
Specifies the domain value mapping (DVM) table caching algorithm. Possible values are:
The default value is |
|
|
Specifies the lookup table caching algorithm. Possible values are:
The default value is |
|
|
With any of the agent caching methods enabled, metadata from the repository is cached locally on the file system. Set this parameter to Note: After changing metadata or DVM tables for this adapter in iStudio, you must delete the cache to guarantee access to new metadata or table information. |
|
|
Specifies the maximum number of application objects' metadata to cache. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum number of common objects' metadata to cache. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum number of messages' metadata (publish/subscribe and invoke/implement) to cache. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum number of DVM tables to cache. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum number of lookup tables to cache. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum size to which internal OracleAS InterConnect message queues can grow. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum size to which internal OracleAS InterConnect persistence queues can grow. Possible values are any integer greater than or equal to |
|
|
Specifies how often to run the persistence cleaner thread (in milliseconds). Possible values are any integer greater than or equal to |
|
|
Specifies how often the persistence thread retries when it fails to send an OracleAS InterConnect message. Possible values are any integer greater than or equal to |
|
|
Specifies how to turn on or off the pipeline for messages from the Bridge towards the hub. If you set the pipeline to |
|
|
Specifies how to turn on or off the pipeline for messages from the hub towards the Bridge. If you set the pipeline to |
|
|
Windows only. Specifies the value to which to set the environment variable |
|
|
Windows only. Specifies the class path used by the adapter Java VM. If a custom adapter is developed and, as a result, the adapter is to pick up any additional jars, add the jars to the existing set of jars being picked up. Possible values are the valid class path. There is no default value. |
|
|
Specifies the entry class for the Windows service. A possible value is |
|
|
Windows only. Specifies the maximum size to which the Java VM's stack can grow. Possible values are the valid Java VM maximum native stack size. The default value is the default for the Java VM. |
|
|
Windows only. Specifies the maximum size to which the Java VM's native stack can grow. Possible values are the valid Java VM maximum native stack size. The default value is the default for the Java VM. |
|
|
Windows only. Specifies the minimum heap size for the adapter Java VM. Possible values are the valid Java VM heap sizes. The default value is 536870912. |
|
|
Windows only. Specifies the maximum heap size for the adapter Java VM. Possible values are any valid Java VM heap sizes. The default value is 536870912. |
|
|
Windows only. Specifies the number of |
|
|
Windows only. Specifies any additional arguments to the Java VM. For example, to retrieve line numbers in any of the stack traces, set |
|
|
The CORBA port number on which the adapter CORBA service listens. Generally, this port is allocated dynamically. However, it can be configured to enable access across firewall. |
|
|
Character encoding for published messages. The adapter uses this parameter to generate encoding information in encoding tag of transformed OracleAS InterConnect message. OracleAS InterConnect represents messages internally as an XML document. The default encoding of the XML document is |
|
|
Format for date fields expressed as string. The default date format is |
Date format pattern
Multiple date formats can be specified as
|
|
This parameter is a valid ISO Country Code. These upper-case and two-letter codes are defined by ISO-3166. You can find a full list of these codes at a Web site, such as,
The default Country code is Note: This parameter specifies date format. It is applicable for the date format only. |
|
|
This parameter is a valid ISO Language Code. These lower-case and two-letter codes are defined by ISO-639. You can find a full list of these codes at a Web site, such as,
The default language code is Note: This parameter specifies date format. It is applicable for the date format only. |
|
Table 2-8 shows the reserved characters used to specify the value of the nls_date_format
parameter. Using these characters, you can construct a pattern to define date formats.
Table 2-9 lists the parameters specific to the HTTP adapter.
Parameter | Description | Example |
---|---|---|
|
Specifies the entry class for the HTTP adapter. A value must be specified and cannot be modified later. A possible value is oracle.oai.agent.adapter.technology.TechBridge. There is no default value. |
|
|
Defines the sending endpoint URL for the HTTP adapter. There is no default value. The URL is of the form:
|
|
|
Defines the receiving endpoint URL for the HTTP adapter. There is no default value. The URL is of the form:
|
|
|
Defines the message payload type the HTTP adapter handles for both incoming and outgoing messages. The options are |
|
|
Specifies the list of D3L XML files used by this 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. |
|
|
Times out an HTTP connection. The unit is in milliseconds. The default is set to |
|
|
Set if authentication is needed. The valid options are |
|
|
Specifies the realm for the authentication scheme. There is no default value. |
|
|
Specifies the authentication username. There is no default value. |
|
|
Specifies the password used in the See Also: "How do I make the adapter.ini file password parameters secure?" for instructions on encrypting the user password |
|
|
Specifies the proxy hostname. There is no default value. |
|
|
Specifies the port number for the proxy host. This is needed if the proxy host is set. There is no default value. |
|
|
Needed if SSL is used. This specifies the path and name of the exported wallet file (not |
|
|
Needed if SSL is used. This specifies the password for the Oracle Wallet Manager. There is no default value. This password can also be encrypted by running the encrypt tool and renaming this parameter to See Also: "How do I make the adapter.ini file password parameters secure?" for instructions on encrypting the wallet password |
|
|
Optional parameter for choosing the cipher suites. The selections are:
|
|
|
Specifies the class name for customizing by the HTTP sender. The default value is: |
|
|
Specifies the RMI port used by the HTTP receiver. The default is |
|
|
Specifies the instance name of the HTTP receiver. The default is |
|
|
Specifies the class name for customizing the HTTP response. |
|
|
Specifies the class name for customizing by the HTTP sender. The default value is: |
|
|
![]() Copyright © 2002, 2003 Oracle Corporation. All Rights Reserved. |
|