SOAP

SOAP (Simple Object Access Protocol) is a lightweight protocol for exchanging information in a decentralized, distributed environment. SOAP is an XML-based protocol that consists of three parts. An envelope that defines the framework for describing what is in a message and how to process it, a set of encoding rules for expressing instances of application-defined data types, and a convention for representing remote procedure calls and responses.

SOAP codifies the existing practice of using XML and HTTP as a method invocation mechanism and uses an XML vocabulary for representing method properties, return values, and exceptions.

To receive messages from SOAP, you must configure a SOAP listener. The iWay protocol adapter base configuration includes a preconfigured SOAP listener.

Reference: SOAP Listener Properties

The following table lists and describes the SOAP listener properties. For instructions on creating a listener, see Configuring Listeners.

Property Name	Property Description
Port (required)	The port on which SOAP requests are accepted. 9000 is the iWay default SOAP port.
Local bind address	The local bind address for multi-homed hosts. This value is usually left empty.
Asynch Directory	The stores the responses (output) from previously issued asynchronous SOAP requests. Also stores event messages destined for remote systems.
Timeout	The timeout interval for the TCP socket.
LingerTime	The linger-on-close period in seconds. Use if TCP loses links when sending documents.
Keystore	The path to the keystore, which contains the key.
Keystore Password	The password required to recover private keys from the keystore.
Keystore Type	The keystore file type. JKS is the default value.
Truststore	The file that provides the trust certificates for authenticating clients. Use if client authentication is required. Leave blank to use the default JVM truststore.
Truststore Type	The type of truststore.
Security Provider Class	The name of the class that implements some or all parts of Java security, including algorithms, key generation, conversion, and management facilities. The default Sun provider is: com.sun.net.ssl.internal.ssl.Provider
Security Protocol	The protocol used to enable security. Security protocol values include: SSL. Supports some version of SSL. May support other versions. SSLv3. Supports SSL version 3. May support other versions. TLS. Supports some version of TLS. May support other versions. TLSv1. Supports TLS version 1. May support other versions.
Security Algorithm	The algorithm that enables security. SunX509 is the default value.
Client Authentication	If set to true, the client is required to authenticate itself. The client must have a keystore of its own.
Whitespace Normalization	This specifies how the parser treats whitespace in element objects. Select preserve (default) to turn off all normalization as prescribed by the XML Specification. Select condense to remove extra whitespaces in pretty printed documents and for compatibility with earlier versions.
Accepts non-XML (flat) only	If set to true, the input data is sent directly to the business logic step. The data is not preparsed, parsed, or validated. This flag is used primarily to send non-XML to the business logic or replyTo without processing it.
Optimize Favoring	Use this option to customize how the listener performs. For smaller transactions, select performance. For large input documents that could monopolize the amount of memory used by iWay Service Manager, select memory.
Multithreading	This indicates the number of worker threads (documents or requests) that iWay Service Manager can handle in parallel. Setting this to a value of greater than 1 enables the listener to handle a second request while an earlier request is still being processed. The total throughput of a system can be affected by the number of threads operating. Increasing the number of parallel operations may not necessarily improve throughput. Default: 1 Max Value: 99
Maximum threads	The parallel threads can grow to this count automatically on demand. Over time, the worker count will decrease back to the multithreading level. Use this parameter to respond to bursts of activity.
Execution Time Limit	The maximum time that a request may take to complete. Used to prevent runaway requests. Any request that takes longer to complete than this value will be attempted to be terminated. (See the kill interval for related information in Global Options.)
Agent Precedence	This sets the order by which iWay Service Manager selects agents. iWay Service Manager selects the agent or agents to process the document by searching through the configuration dictionary. Usually, it looks for a document entry in the configuration and when a match is found, the agent specified in that document entry is selected. If a matching document entry is not found, or no agent is specified, the engine looks in the input protocol configuration (listener). To have the processing agent taken directly from the listener (thus ignoring the document entry), use <listener> overrides <document>. Possible values are <document> overrides <listener> and <listener> overrides <document>. The default value is: <document> overrides <listener>
Always reply to listener default	If set to true, the default reply definition is used in addition to defined reply-to and error-to destinations.
Error Documents treated normally	If set true, the error documents are processed by any configured preemitters.
Listener is Transaction Manager	If set to true, the agents run in a local transaction. Agents can roll back uncompleted transactions.
Record in Activity Log(s)	If set to true, then the activity on this channel will be recorded in the activity logs. If set to false, the activity will not be recorded.

Reference: SOAP Listener Special Registers

The following table lists and describes the special registers (SREGs) available on the SOAP listener.

Name	Level	Type	Description
ip	Document	String	The IP address of the sender.
iwayconfig	System	String	The current active configuration name.
msgsize	Document	Integer	The physical length of the message payload.
name	System	String	The assigned name of the master (listener).
protocol	System	String	The protocol on which the message was received.
source	Document	String	The originator of the message.
tid	Document	String	Unique transaction ID.