Configuring the connector

The installation and configuration tasks for the XML adapter depend on the roles it must fill in the WebSphere Business Integration Express for Item Synchronization system. Read the sections below to determine what tasks you must perform based on how you will be using the e-Mail adapter.

Configuring the data handler

Configure the meta-objects used for the XML data handler. For information on configuring meta objects, see "Configuring top-level meta-objects for the data handler".

Standard connector properties

Standard configuration properties provide information that all connectors use. See Appendix A, Standard configuration properties for connectors for documentation of these properties.

Table 1 provides information specific to this connector about a configuration property in the appendix.

Table 1. Property information specific to this connector

Property Note
CharacterEncoding This connector does not use this property.
Locale This connector has not been internationalized, you cannot change the value of this property.

You must provide a value for the ApplicationName configuration property before running the connector. You also must set at least the following standard connector configuration properties before running the connector.

Connector-specific properties

Connector-specific configuration properties provide information needed by the connector at runtime. Connector-specific properties also provide a way of changing static information or logic within the connector without having to recode and rebuild the connector.

Table 2 lists the connector-specific configuration properties for the connector. See the section that follows for explanations of the properties.

Table 2. Connector-specific configuration properties

Name Possible values Default value Required?
ArchiveDirectory archive directory name \connectors\xml\ archive
DataHandlerConfigMO data handler meta-object name MO_DataHandler_ Default YES
HttpProxyHost http host name

HttpProxyPort http proxy port 80
HttpsDebug Set the property to one of the values in Table 3.

HttpsProxyHost https host name

HttpsProxyPort https proxy port 443
JavaProtocolHandlerPkgs protocol handler name com.crossworlds. connectors.utils. ProtocolHandlers YES
MaxNumRetries positive integer 10
PollingBusinessObjects business object names

ReturnBusObjResponse true or false true
SecurityProvider SSL implementation com.sun.net.ssl. internal.ssl. Provider.sun. security.provider. Sun YES
UseCaches true or false false
UseDefaults true or false false
UseDigitalSignature true or false false

ArchiveDirectory

Directory containing archived events. Each event can be identified by its business object name and verb. By default, the create verb is appended to the business object name. The default is \connectors\xml\ archive.

DataHandlerConfigMO

Name of the top-level meta-object that the XML connector uses to determine its data handler support. This meta-object must contain the name of the child meta-object that the XML data handler uses to set configuration properties. This property is also used by the DataHandler base class to determine which DataHandler class to instantiate for a particular content type. The default is MO_DataHandler_ Default. For more information, see Configuring top-level meta-objects for the data handler.

HttpProxyHost

Name of the host that acts as the proxy for HTTP. This property is required only if the network uses a proxy server that uses the HTTP protocol.

HttpProxyPort

Proxy port number used to connect HTTP. This property is required only if the network uses a proxy server that uses the HTTP protocol. The default port number is 80.

HttpsDebug

Setting that determines what debugging information is generated for the HTTPS session. Table 3 lists the HTTPS debug values for the HTTPS protocol handler.

Table 3. HttpsDebug Values

Name Meaning
all Turn on all debugging
data Hex dump of each handshake message. It can be used to widen handshake debugging.
handshake Print each handshake message. It can be used with SSL.
keygen Print key generation data. It can be used with SSL.
plaintext Hex dump of record plain text. It can be used to extend record debugging.
record Enable per-record tracing. It can be used with SSL.
session Print session activity. It can be used with SSL.
ssl Turn on SSL debugging only.
verbose Print verbose handshake message. It can be used to extend record debugging.

HttpsProxyHost

HTTPS proxy machine name. This property is required only if the network uses a proxy server that uses the HTTPS protocol.

HttpsProxyPort

Proxy port number used to connect HTTPS. This property is required only if the network uses a proxy server that uses the HTTPS protocol.

JavaProtocolHandlerPkgs

If this attribute is present, it specifies the packages that are used as protocol handlers, instead of the default Java handler. These classes must conform to Java's Protocol Handler Framework. For example, to use a protocol handler named com.mycompany.http (for HTTP), set this field to com.mycompany. Also make sure that the .jar files of the corresponding class are in your classpath.

For more information on Java Protocol Handlers, see the tutorial at the following website: http://developer.java.sun.com/developer/onlineTraining/protocolhandlers/

It is also possible to specify multiple packages for this value separated by vertical bars, "|". For example, com.crossworlds.Protocol Handlers|com.mycompany

The Adapter for XML delivers two packages:

The default is com.crossworlds.connectors.utils.ProtocolHandlers.

MaxNumRetries

Specifies the number of retries to attempt after the asynchronous protocol handler does not receive a response from the destination URL. This property is used only by the asynchronous protocol handler. If you do not specify a value, this property defaults to zero. The default is 0.

PollingBusinessObjects

Business objects used for event notification. Separate multiple entries with a comma (For example, XMLPoll_Cust, XMLPoll_Order). Each business object must be supported by the connector. This property is required if the connector is set up for event notification.

ReturnBusObjResponse

Determines whether the connector expects a business object to be returned from the protocol handler.If the value is set to true, then the connector expects a business object. If the value is set to false, then the connector does not expect a business object. It expects only a response of success or failure. The default is true.

Note:
If you are configuring the asynchronous protocol handler, then the value must be set to false, because the asynchronous protocol handler does not expect a business object response.

SecurityProvider

Used by HTTPS during the SSL handshake. Comma-separated values of this attribute determine which SSL implementation to use when connecting to HTTPS URLs. If no value is set, HTTPS connections do not work. The default is com.sun.net.ssl. internal.ssl.Provider.sun.security.provider.Sun.

UseCaches

If this attribute is set to false, the connector attempts to retrieve a non-cached version of XML documents. This is merely a request; it cannot be strictly enforced by the connector. Set this value to true to retrieve cached XML documents only.

UseDefaults

On a Create operation, if UseDefaults is set to true, the connector checks whether a valid value or a default value is provided for each isRequired business object attribute. If a value is provided, the Create operation succeeds. If the parameter is set to false, the connector checks only for a valid value and causes the Create operation to fail if it is not provided. The default is false.

UseDigitalSignature

Specifies whether a digital signature length (0 in binary) is added to the end of a message sent by using the HTTP or HTTPS protocol. If your connector supports digital signatures, set this property to true. The default is false.

Note:
The product-provided connector does not support digital signatures.

Copyright IBM Corp. 2003