After using the Installer to install the connector files to your system, you must set the standard and application-specific connector configuration properties.
Connectors have two types of configuration properties: standard configuration properties and connector-specific configuration properties. You must set the values of these properties using System Manager (SM) before running the connector.
Standard configuration properties provide information that all connectors use. See Appendix A. Standard configuration properties for connectors for documentation of these properties. The table below provides information specific to this connector about configuration properties in the appendix.
Property | Description |
---|---|
CharacterEncoding |
This connector does not use this property. |
Locale |
Because this connector has not been internationalized, you cannot change the value of this property. See release notes for the connector to determine currently supported locales. |
Because this connector supports only InterChange Server (ICS) as the integration broker, the only configuration properties relevant to it are for ICS.
You must set at least the following standard connector configuration properties:
Connector-specific configuration properties provide information needed by the connector agent at runtime. Connector-specific properties also provide a way of changing static information or logic within the connector agent without having to recode and rebuild the agent.
Table 37 lists the connector-specific configuration properties. See the sections that follow for explanations of the properties. Note that some of the properties contain other properties. The + character indicates the entry's position in the property hierarchy.
Name | Possible values | Default value | Required |
---|---|---|---|
ConnectorType | Any valid connector type | WebService | Yes |
DataHandlerMetaObjectName | Data handler meta-object name | MO_DataHandler_ Default | Yes |
JavaProtocolHandlerPackages | Valid Java protocol handler packages | com.ibm.net.ssl. internal.www.protocol | No |
ProtocolHandlerFramework | This is a hierarchical property and has no value | None | No |
+ProtocolHandlers | This is a hierarchical property and has no value | No | |
++SOAPHTTPHTTPSHandler | This is a hierarchical property. For information on its sub-properties, see SOAPHTTPHTTPSHandler. | Yes | |
++SOAPJMSHandler | This is a hierarchical property. For information on its sub-properties, see SOAPJMSHandler. | ||
ProtocolListenerFramework | This is a hierarchical property and has no value. | No | |
+WorkerThreadCount | An integer of 1 or greater that gives the number of available listener threads. | 10 | No |
+RequestPoolSize | Integer greater than WorkerThreadCount that gives the resource pool size. | 20 | No |
+ProtocolListeners | This is a hierarchical property and has no value | ||
++Listener1 | Uniquely named protocol listener | Yes | |
+++Protocol | soap/http, soap/https, soap/jms | Yes | |
+++SOAPDHMimeType | Any valid mime type of a SOAP data handler | xml/soap | |
+++ListenerSpecific | Properties unique to or required by the listener See ListenerSpecific. | ||
ProxyServer | This is a hierarchical property and has no value | No | |
+HttpProxyHost | Host name for the HTTP proxy server | No | |
+HttpProxyPort | Port number for the HTTP proxy server | 80 | No |
+HttpNonProxyHosts | HTTP host(s) requiring direct connection | No | |
+HttpsProxyHost | Host name for the HTTPS proxy server | No | |
+HttpsProxyPort | Port number for the HTTPS proxy server | 443 | No |
+HttpsNonProxyHosts | HTTPS host(s) requiring direct connection | No | |
+SocksProxyHost | Socks proxy server name | No | |
+SocksProxyPort | Socks proxy server port | No | |
+HttpProxyUsername | Http proxy server username | No | |
+HttpProxyPassword | Http proxy server password | No | |
+HttpsProxyUsername | Https proxy server username | No | |
+HttpsProxyPassword | Https proxy server password | No | |
SSL | This is a hierarchical property and has no value | No | |
+SSLVersion | SSL, SSLv2, SSLv3, TLS, TLSv1 | SSL | No |
+SSLDebug | true, false | false | No |
+KeyStoreType | Any valid keystore type | JKS | No |
+KeyStore | Path to KeyStore file. | No | |
+KeyStorePassword | Password for private key in KeyStore | No | |
+KeyStoreAlias | Alias for key pair in KeyStore | No | |
+TrustStore | Path to TrustStore file | No | |
+TrustStorePassword | Password for TrustStore | No | |
+UseClientAuth | true false | false | No |
WSCollaborations | This is a hierarchical property creating by the WSDL Configuration Wizard and has no value See WSCollaborations. | ||
+Collaboration1 | This is a hierarchical property and has no value | ||
++CollaborationPort1 | Name of the collaboration port | Yes | |
+++WebServiceOperation1 | This is a hierarchical property and has no value | Yes | |
++++BodyName | Name of web service method; must be valid XML element name | Yes | |
++++BodyNS | Namespace of web service method; must be valid XML namespace | Yes | |
++++BOName | Name of Request business object for operation | Yes | |
++++Mode | synch asynch | asynch | No |
JNDI | This is a JMS-related hierarchical property and has no value | No | |
+LookupQueuesUsingJNDI | true false | false | No |
+JNDIProviderURL | Valid JNDI URL | No | |
+InitialContextFactory | Name of factory class for initial context | No | |
+JNDIConnectionFactoryName | Name of connection factory to look up using JNDI context. | No | |
+CTX Properties
+CTX_properties |
Properties specifying additional information about security and object lookup in the JNDI context | N |
If this property is set to WebService, when binding the collaboration port, System Manager displays the connector as a web services connector. Otherwise it is displayed as a normal connector.
Default = WebService.
This is the name of the meta-object that the data handler uses to set configuration properties.
Default = MO_DataHandler_Default.
The value of this property gives the Java Protocol Handler packages. The connector uses the value of this property to set the system property java.protocol.handler.pkgs.
Default = com.ibm.net.ssl.internal.www.protocol.
The Protocol Handler Framework uses this property to load and configure its protocol handlers. This is a hierarchical property and has no value.
Default = none.
This hierarchical property has no value. Its first-level children represent discrete protocol handlers.
Default = none.
The name of a SOAP/HTTP-HTTPS protocol handler. Note that this is a hierarchical property. Unlike listeners, protocol handlers may not be duplicated, and there can be only one handler for each protocol. Table 38 below shows the sub-properties for the SOAP/HTTP-HTTPS protocol handler. The + character indicates the entry's position in the property hierarchy.
Figure 32 shows the properties as displayed in Connector Configurator.
The name of a SOAP/JMS protocol handler. Note that this is a hierarchical property. Unlike listeners, protocol handlers may not be duplicated, and there can be only one handler for each protocol. Table 39 below shows the sub-properties for the SOAP/JMS protocol handler. The + character indicates the entry's position in the property hierarchy.
Figure 33 shows the properties as displayed in Connector Configurator.
The protocol listener framework uses this property to load protocol listeners. This is a hierarchical property and has no value.
This property, which must be an integer of 1 or greater, establishes the number of protocol listener worker threads available to the protocol listener framework. For further information, see Protocol listeners.Default = 10.
This property, which must be an integer greater than WorkerThreadCount, sets the resource pool size of the protocol listener framework. The framework can process a maximum of WorkerThreadCount + RequestPoolSize requests concurrently.
Default = 20.
This is a hierarchical property and has no value. Each first-level child of this property represents a discrete protocol listener.
The name of a protocol listener. There may be multiple protocol listeners. Note that this is a hierarchical property. You can create multiple instances of this property and create additional, uniquely named listeners. When doing so, you can change the listener-specific properties but not the protocol property. The names of multiple listeners must be unique. Possible names (not values): SOAPHTTPListener1, SOAPHTTPSListener1, SOAPJMSListener1
This property specifies the protocol this listener is implementing. Possible values: soap/http, soap/https, soap/jms.
The SOAP data handler mime type to use for the requests received by this listener.
Default = xml/soap
Listener specific properties are unique to, or required by, the specified protocol listener. For example, the HTTP listener has a listener-specific property Port, which represents the Port number on which Listener monitors requests. Table 40 summarizes the HTTP-HTTPS listener specific properties. The + character indicates the entry's position in the property hierarchy.
Name | Possible values | Default value | Required |
---|---|---|---|
+++SOAPHTTPListener1 | Unique name of an HTTP protocol listener. This is a child of the ProtocolListenerFramework -> ProtocolListeners hierarchical property. There can be multiple listeners: you may plug-in additional HTTP listeners by creating another instance of this property and its hierarchy. | Yes | |
++++Protocol | soap/http if SOAP/HTTP protocol listener
soap/https if SOAP/HTTPS protocol listener Note:
If you do not specify a value for this property,
the connector will not initialize this protocol listener. |
Yes | |
++++SOAPDHMimeType | xml/soap | xml/soap | No |
++++BOPrefix | The value of this property is passed to the data handler. | No | |
++++Host | The listener will listen at the IP address specified by value of this property. If Host is not specified, it defaults to localhost. Note that you may either specify a host name (DNS name) or an IP address for the machine on which the listener is running. A machine may have multiple IP addresses or multiple names. | localhost | No |
++++Port | The port on which the listener listens for requests. If unspecified, the port defaults to 80 for SOAP/HTTP and 443 for SOAP/HTTPS.If you clone the listener within a connector, then the combination of Host and Port properties is unique or the listener may be unable to bind to the port to accept requests. | 80 for SOAP/HTTP listener
443 for SOAP/HTTPS listener |
No |
++++SocketQueueLength | Length of the queue (socket queue) for incoming connection requests. Specifies how many incoming connections can be stored at one time before the host refuses connections. The maximum queue length is operating system dependent. | 5 | No |
++++RequestWaitTimeout | The time interval in milli-seconds that the listener thread will block on the host and port while waiting for web service requests to arrive. If it receives a web service request before this interval, the listener will process it. Otherwise the listener thread checks whether the connector shutdown flag is set. If it is set, the connector will terminate. Otherwise it will continue to block for RequestWaitTimeout interval. If this property is set to 0, it will block for ever. If unspecified, it defaults to 60000ms. | 60000 (ms) | No |
++++HTTPReadTimeout | The time interval in milli-seconds that the listener will be blocked while reading a web service request from a client. If this parameter is set to 0, the listener indefinitely blocks until it receives the entire request message. | 0 | No |
++++HttpAsyncResponseCode | The HTTP response code for asynchronous requests to the listener:
200 (OK) 202 (ACCEPTED) |
202 (ACCEPTED) | No |
++++URLsConfiguration | This is a hierarchical property and has no value. It contains 1 or more configurations for URLs supported by this listener and, optionally, mime type and charset values. Note that this is child property of ProtocolListenerFramework->ProtocolListeners->SOAPHTTPListener1 hierarchical property. If this property is not specified, the listener assumes default values. | ContextPath: / Enabled: true Data handler MimeType: equal to the ContentType of the request Charset: NONE. For further information, see SOAP/HTTP and SOAP/HTTPS protocol listener processing. | No |
+++++URL1 | This is a hierarchical property and has no value. Its children provide the name of the URL supported by this listener. There can be multiple supported URLs. Note that you can plug in additional URLs by cloning this property and its hierarchy. | No | |
++++++ContextPath | The URI for the HTTP requests received by the listener. This value must be unique among ContextPath values under the URLsConfiguration property. Otherwise the connector will log an error and fail to start. ContextPath is case sensitive. However it may contain protocol, host name and port which are case-insensitive. If protocol is specified in ContextPath, it should be http. If host is specified, it should be equal to the value of the Host listener property. If port is specified, it should be equal to the value of Port listener property. This property is enabled for transformation of bidirectional languages. | No | |
++++++Enabled | The value of this property determines if the parent URL hierarchical property is enabled for the connector. | True | No |
++++++TransformationRules | This is a hierarchical property and has no value. It holds one or more transformation rules. | ||
+++++++TransformationRule1 | This is a hierarchical property and has no value. It holds the transformation rule. | No | |
++++++++ContentType | The value of this property specifies the ContentType of the incoming request for which special handling (data handler mime type or charset) should be applied. If ContentType is not specified by the TransformationRuleN hierarchical property, the connector logs a warning message and ignores the TransformationRuleN property.
Specifying the special value */* for this property enables the protocol listeners to apply this rule to any ContentType. Note that if a listener finds more than one rule for the same context path that shares a ContentType, the listener logs an error and fails to initialize. |
No | |
++++++++MimeType | The mime type to use when calling a data handler to process requests of the specified ContentType. | No | |
++++++++Charset | Charset to use when transforming the request of the specified ContentType into a business object. | No |
Figure 34 shows the properties as displayed in Connector Configurator.
Table 41 summarizes the SOAP/JMS protocol listener-specific properties. The + character indicates the entry's position in the property hierarchy.
Name | Possible values | Default value | Required |
---|---|---|---|
+++SOAPJMSListener1 | Unique name of a JMS protocol listener. This is a child of the ProtocolListenerFramework -> ProtocolListeners hierarchical property. There can be multiple listeners: you may plug-in additional JMS listeners by creating another instance of this property and its hierarchy. | Yes | |
++++Protocol | soap/jms | Yes | |
++++SOAPDHMimeType | xml/soap | xml/soap | No |
++++BOPrefix | The value of this property is passed to the data handler specified by SOAPDHMimeType property. | No | |
++++RequestWaitTimeout | This property sets the time interval that the SOAP/JMS listener thread blocks the InputQueue while waiting for a web service request. If it receives a web service request within this interval, the listener processes it. If it does not receive the request within this interval, the listener thread first checks if the connector shutdown flag is set. If the connector shutdown flag is set, the connector will terminate. Otherwise it will continue to block for RequestWaitTimeout interval. If this property is set to 0, it will block indefinitely. | 60000
milliseconds |
No |
++++SessionPoolSize | Maximum number of sessions that can be allocated for a given listener and its worker threads. The minimum number of sessions (and default) is 2. For larger session pool sizes, the connector requires more memory. | 2 | No |
++++InputQueue | This property gives the name of the input queue that the listener polls for inbound messages from web services. If LookupQueuesUsingJNDI = true, the listener looks up this queue using JNDI and the value of the InputQueue property is set to the jndiDestinationName attribute of the jms:address element of the SOAP/JMS binding. The jms:address element is specified in the wsdl:port section of the WSDL document. If during WSDL generation you select the SOAP/JMS listener, System Manager automatically creates the jndiDestinationName attribute using the value of this property. If LookupQueueUsingJNDI = false, then System Manager creates the jmsProviderDestinationName attribute instead. | Yes | |
++++InProgressQueue | This property gives the name of the in-progress queue. The listener sends copies of inbound messages from the InputQueue to InProgressQueue. If LookupQueuesUsingJNDI = true, the listener looks up this queue using JNDI. | Yes | |
++++ArchiveQueue | This property gives the name of the archival queue. The listener sends copies of successfully processed messages from the InProgressQueue to ArchiveQueue. If LookupQueuesUsingJNDI = true, the listener looks up this queue using JNDI. | No | |
++++UnsubscribedQueue | This property gives the name of the unsubscribed queue. The listener sends copies of unsubscribed messages from the InProgressQueue to UnsubscribedQueue. If LookupQueueUsingJNDI = true, the listener looks up this queue using JNDI. | No | |
++++ErrorQueue | This property gives the name of the error queue. The listener sends copies of failed messages to the ErrorQueue. If LookupQueueUsingJNDI = true, the listener looks up this queue using JNDI. | No | |
++++InDoubtEvents | This property specifies how to handle messages in the InProgressQueue that are not fully processed due to unexpected connector termination. It can take one of the following values:
|
Ignore | No |
++++ReplyToQueue | This property gives the name of the ReplyTo queue. The WSDL Configuration Wizard reads this property and writes it to the WSDL document. If this property is not specified, the utility does not create a ReplyTo JMS header in the SOAP/JMS binding in the WSDL document. (The listener does not use this property.) If JNDI properties are specified and LookupQueueUsingJNDI = false, the WSDL Generation Utility still create JNDI specific attributes in the WSDL document. Note that these JNDI-specific attributes are required because the SOAP/JMS binding does not provide any way to specify a ReplyTo attribute without JNDI. Though JNDI lookup for the InputQueue is not required, JNDI-specific properties are required for the ReplyTo queue. If the WSDL utility does not find JNDI-specific properties, the utility cannot create a ReplyTo attribute in the SOAP/JMS binding. | ||
++++ JMSVendorURI | A string that uniquely identifies the JMS implementation and that corresponds to the jmsVendorURI attribute of the jms:address element of the SOAP/JMS binding. The jms:address element is specified in wsdl:port section of the WSDL document. The listener does not use this property. This property is enabled for transformation of bidirectional languages. | No |
Figure 35 shows the properties as displayed in Connector Configurator.
Configure the values under this property when the network uses a proxy server. This is a hierarchical property and has no value. The values specified under this property are used by the SOAP/HTTP/HTTPS protocol handlers.
Figure 36 shows the ProxyServer properties as displayed in Connector Configurator and discussed below.
The host name for the HTTP proxy server. Specify this property if the network uses a proxy server for HTTP protocol.
Default = none
The port number that the connector uses to connect to the HTTP proxy server.
Default = 80
The value of this property gives one or more hosts (for HTTP) that must be connected not through the proxy server but directly. The value can be a list of hosts, each separated by a "|".
Default = none
The host name for the HTTPS proxy server.
Default = none
The port number that the connector uses to connect to the HTTPS proxy server.
Default = 443
The value of this property gives one or more hosts (for HTTPS) that must be connected not through the proxy server but directly. The value can be a list of hosts, each separated by a "|".
Default = none
The host name for the Socks Proxy server. Specify this property when the network uses a socks proxy.
Default = none
The port number to connect to the Socks Proxy server. Specify this property when the network uses a socks proxy.
Default = none
The username for the HTTP proxy server. If the destination for the web service request is an HTTP URL and you specify ProxyServer ->HttpProxyUsername, the SOAP HTTP/HTTPS protocol handler creates a Proxy-Authorization header when authenticating with the proxy. The handler uses the CONNECT method for authentication.
The proxy-authentication header is base64 encoded and has the
following structure:
Proxy-Authorization: Basic
Base64EncodedString
The handler concatenates the username and the password property values, separated by a colon (:), to create the base64 encoded string.
Default = none
The password for the HTTP proxy server. For more on how this value is used, see HttpProxyUsername.
Default = none
The username for the HTTPS proxy server. If the destination for the web service request is an HTTPS URL and you specify ProxyServer ->HttpsProxyUsername, the SOAP HTTP/HTTPS protocol handler creates a Proxy-Authorization header for authentication with the proxy. The handler concatenates the HttpsProxyUsername and HttpsProxyPassword configuration property values, separated by colon (:), to create the base64 encoded string.
Default = none
The password for the HTTPS proxy server. For more on how this value is used, see HttpsProxyUsername.
Default = none
Specify values under this property to configure SSL for the connector. This is a hierarchical property and has no value.
Figure 37 shows the SSL properties as displayed in Connector Configurator and discussed below.
The SSL version to be used by the connector. For further information, see IBM JSSE documentation for the supported SSL versions.
Default = SSL
If value of this property is set to true, the connector sets the value of thejavax.net.debug system property to true. IBM JSSE uses this property to turn on the trace facility. For further information, refer to IBM JSSE documentation.
Default = false
The value of this property gives the type of the KeyStore and TrustStore. For further information, see IBM JSSE documentation for valid keystore types.
Default = JKS
This property gives the complete path to keystore file. If KeyStore and/or KeyStoreAlias properties are not specified, KeyStorePassword, KeyStoreAlias, TrustStore, TrustStorePassword properties are ignored. The connector will fail to startup if it cannot load the keystore using the path specified in this property. The path must be the complete path to the keystore file.
Default = None
This property gives the password for the private key in the Keystore.
Default = None
This property gives the alias for the key pair in the KeyStore. SOAP/HTTPS listeners use this private key from the KeyStore. Also, the SOAP/HTTP-HTTPS protocol handler uses this alias from the KeyStore when invoking web services that require client authentication. The property must be set to a valid JSSE alias.
Default = None
This property gives the complete path to the TrustStore. TrustStore is used for storing the certificates that are trusted by the connector. TrustStore must be of the same type as KeyStore. You must specify the complete path to the TrustStore file.
Default = None
This property gives the password for the Truststore.
Default = None
This property specifies whether SSL client authentication is used. When it is set to true, SOAP/HTTPS listeners use client authentication.
Default = false
This property is created automatically when you expose a collaboration object as a web services and is used for non-TLOs. This is a hierarchical property and has no value. Each first-level child of this property represents a collaboration exposed as a web service. For information on the tools used to automatically create these properties, see Exposing collaborations as web services.
Figure 38 shows WSCollaborations properties as displayed in Connector Configurator and discussed below.
This property names the collaboration object that is exposed as web service via this connector. This is a hierarchical property and has no value. There can be multiple such properties, one for each of collaboration object that is exposed as a web service. Each first-level child of this property represents a port of this collaboration object.
This property names the collaboration port. This is a hierarchical property and has no value. There can be multiple such properties, one for each of the ports of this collaboration that are bound to the connector. Each first- level child of this property represents a web services operation.
This property represents a web services operation for the collaboration object. This is a hierarchical property and has no value. There may be one or more such properties, one for each of the web services operation defined by the user at the time of WSDL document generation.
This property gives the name of the web service method and must be a valid XML element name.
Default = none
This property gives the namespace of the web service method and must be a valid XML namespace.
Default = none
This property gives the name of the Request business object for this operation.
Default = none
This property specifies the processing mode for the operation. It it is set to synch, the connector synchronously invokes the collaboration. Otherwise and by default, the connector asynchronously invokes the collaboration as a request only operation.
Default = asynch
The connector maintains one set of JNDI (Java Naming and Directory Interface) provider properties that are used by the SOAP/JMS protocol handler and JMS protocol listener when connecting to JNDI. This is a hierarchical property and has no value. The connector uses JNDI to lookup the JMS connection factory object. Note that the WSDL Configuration Wizard uses this property when generating SOAP/JMS bindings.
Figure 39 shows JNDI properties as displayed in Connector Configurator and discussed below.
If the value of this property is set to true, the connector's SOAP/JMS listeners and SOAP/JMS protocol handler will look up queues using JNDI.
Default = false
This property gives the URL of the JNDI service provider, which corresponds to jndiProviderURL attribute of the jms:address element of the SOAP/JMS binding. The jms:address element is specified in the wsdl:port section. This is used as the default JNDI provider and must be a valid JNDI URL. For further information, see JNDI specifications.
This property is enabled for transformation of bidirectional languages.
Default = none
This property gives the fully qualified class name of the factory class (for example, com.ibm.NamingFactory)that creates an initial context. Note that this corresponds to the initialContextFactory attribute of the jms:address element of the SOAP/JMS binding. The jms:address element is specified in the wsdl:port section.
Default = none
This property gives the name of the connection factory to look up using JNDI context. Note that this corresponds to the jndiConnectionFactoryName attribute of the jms:address element of the SOAP/JMS binding. The jms:address element is specified in the wsdl:port section.
Default = none
Properties specifying additional information about security and object lookup in the JNDI context. Table 42 summarizes these properties. The + character indicates the entry's position in the property hierarchy.
The +CTX_DNS_URL property is enabled for transformation of bidirectional languages.
Property Name | Description |
+CTX_ObjectFactories
+CTX_StateFactories +CTX_URLPackagePrefixes +CTX_DNS_URL +CTX_Authoritative +CTX_Batchsize +CTX_Referral +CTX_SecurityProtocol +CTX_SecutiryAuthentication +CTX_SecurityPrincipal +CTX_SecurityCredentials +CTX_Language |
Properties specifying additional information about security and object lookup in the JNDI context. See J2EE documentation for more information. These properties reflect those used by the Adapter for JMS. |
You can create multiple instances of protocol listeners. Protocol listeners are configured as child properties of the ProtocolListenerFramework -> ProtocolListeners connector property. Each child (of ProtocolListenerFramework -> ProtocolListeners) identifies a distinct protocol listener for the connector. Accordingly, you can create additional protocol listeners by configuring new child properties under the ProtocolListeners property. Make sure that you specify all of the child properties of the newly created listener property. Each listener must be uniquely named. However, you do not change the listener Protocol property (soap/http, soap/https, or soap/jms), which remains the same for multiple instances of a listener.
If you are creating multiple instances of a SOAP/HTTP or SOAP/HTTPS listener, be sure to specify different Port and Host properties for each instance. If you are specifying multiple SOAP/JMS listeners, be sure to use a different set of queues for each instance.
You cannot create multiple instances of a handler. There can be only one handler for each protocol.