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:
Table 34 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 greater than 1that 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 | ||
+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_ObjectFactories
+CTX_properties |
Properties specifying additional information about security and object lookup in the JNDI context | N |
Default = WebService.
Default = MO_DataHandler_Default.
Default = com.ibm.net.ssl.internal.www.protocol.
Default = none.
Default = none.
Table 35. SOAP/HTTP-HTTPS protocol handler configuration properties
Name | Possible values | Default value | Required |
---|---|---|---|
++SOAPHTTPHTTPSHandler | This is a hierarchical property and has no value. | Yes | |
+++Protocol | The kind of protocol
the handler is implementing. For SOAP/HTTP and SOAP/HTTPS, the value is
soap/http.
|
Yes | |
+++HTTPReadTimeout | A SOAP/HTTP-specific property that specifies the timeout interval (in milliseconds) while reading from the remote host (web service).If this property is not specified or if set to 0, the SOAP/HTTP protocol handler blocks indefinitely while reading from the remote host. | 0 | No |
Figure 31 shows the properties as displayed in Connector Configurator.
Figure 31. SOAP/HTTP-HTTPS protocol handler properties
Table 36. SOAP/JMS protocol handler configuration properties
Name | Possible values | Default value | Required |
---|---|---|---|
++SOAPJMSHandler | This is a hierarchical property and has no value. | Yes | |
+++Protocol | The kind of protocol
the handler is implementing. For SOAP/JMS, the value is soap/jms.
|
Yes | |
+++ResponseWaitTimeout | This is a JMS protocol handler-specific property that specifies the timeout interval (in milliseconds) that the protocol handler waits on ReplyToQueue for synchronous request processing. If the response does not arrive during this interval, the handler fails the collaboration request. If this property is not specified or if set to 0, the protocol handler waits on ReplyToQueue indefinitely. | 0 | No |
+++ReplyToQueue | This is a required
JMS protocol handler-specific property that names the ReplyTo queue. For
synchronous request processing, the handler sets the JMSReplyTo field to
this JMS destination.
If LookupQueuesUsingJNDI = true, the SOAP/JMS protocol handler looks up this queue using JNDI. |
none | Yes |
Figure 32 shows the properties as displayed in Connector Configurator.
Figure 32. SOAP/JMS protocol handler properties
Default = 20.
Default = xml/soap
Table 37. SOAP/HTTP and SOAP/HTTPS protocol listener-specific configuration properties
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
|
Yes | |
++++SOAPDHMimeType | xml/soap | xml/soap | No |
++++BOPrefix | The BOPrefix is reserved for future use | 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 |
++++ContextPath | The URI for the requests received by the listener. This property is used by the WSDL Configuration Wizard to publish the endpoint address--the listener does not use this property. If this property is not specified, it defaults to /. 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.(For https, it should be https.) If host is specified, it should be equal to the value of Host listener property. If port is specified, it should be equal to the value of Port listener property. | / | 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 |
Figure 33 shows the properties as displayed in Connector Configurator.
Figure 33. SOAP/HTTP protocol listener properties
Table 38 summarizes the SOAP/JMS protocol listener-specific properties. The + character indicates the entry's position in the property hierarchy.
Table 38. SOAP/JMS protocol listener-specific configuration properties
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 BOPrefix is reserved for future use | 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. | No |
Figure 34 shows the properties as displayed in Connector Configurator.
Figure 34. SOAP/JMS protocol listener properties
Figure 35 shows the ProxyServer properties as displayed in Connector Configurator and discussed below.
Figure 35. ProxyServer properties
Default = none
Default = 80
Default = none
Default = none
Default = 443
Default = none
Default = none
Default = none
Default = none
Default = none
Default = none
Figure 36 shows the SSL properties as displayed in Connector Configurator and discussed below.
Default = SSL
Default = false
Default = JKS
Default = None
Default = None
Default = None
Default = None
Default = None
Default = false
Figure 37. WSCollaborations properties
Default = none
Default = none
Default = none
Default = asynch
Figure 38 shows JNDI properties as displayed in Connector Configurator and discussed below.
Default = false
Default = none
Default = none
Default = none
Table 39. Java Naming and Directory Interface (JNDI) provider properties
Property Name | Description |
+CTX_InitialContextFactory | Fully qualified class name of the factory class that will create an initial context. (for example, com.sun.jndi.fscontext) |
+CTX_ProviderURL | Configuration information for the service provider to use. The value of the property should contain a URL (for example, ldap://somehost:389) |
+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. |
You cannot create multiple instances of a handler. There can be only one handler for each protocol.