iWay HTTP Solutions Development Guide > Configuring HTTP Components > HTTP

HTTP

Topics:

HTTP Listener Parameters
HTTP Emitter Parameters

Reference:

HTTP Listener Special Registers

The Hypertext Transfer Protocol (HTTP) is an application-level protocol with the lightness and speed required for distributed, collaborative, hyper-media information systems. HTTP enables easy management of agent resources through management applications, such as Firefox, Internet Explorer, and so on, which are readily available in all systems.

The iWay Adapter for HTTP/S provides the iWay Service Manager Server Integration platform with the ability to send and receive messages over secure HTTP. It enables you to take advantage of the Internet by providing secure, reliable, and efficient communication with external business systems, whether within or outside of your enterprise.

The iWay Adapter for HTTP/S:

Provides a bidirectional adapter.
Enables HTTP clients to invoke business processes within iWay Service Manager through a URL.
Enables a business process to request data from an HTTP server through a URL, thus acting as an HTTP client.
Includes a built-in multi-threaded HTTP listener, as part of the iWay Service Manager base configuration, which is used to serve the iWay Configuration pages to the user.
Supports HTTP and HTTPS protocols, both synchronous and asynchronous bidirectional invocation, and includes a limited-use license for the XML Data Handler.

For inbound messages, the adapter receives incoming messages through the registered URL, with the message payload being either an XML message or an arbitrary proprietary data structure.

HTTP Listener Parameters

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

Note: Parameters that are common to all components are omitted from the following table. For a list of these properties refrer to Configuring Common Parameters in the appendix of this manual.

Parameter	Description
Port (required)	The TCP port for receipt of HTTP requests.
Local bind address	The local bind address for multi-homed hosts. This is usually left empty.
Document Root (required)	The base directory from which all HTTP pages are served.
Timeout	The timeout interval for the TCP socket.
Set TCP No Delay	If set to true, this disables Nagle's Algorithm on the client socket. This results in faster line turnaround at the expense of an increased number of packets.False is the default.
Defer Close of Socket	If set to true, (default) the close of the client socket is deferred for one second after the response is written. This compensates for an issue seen on some older versions of z/OS.
Default Page	The default page if none is identified in the incoming HTTP or HTTPS request.
Response content type	This overrides content type of response. Select one of the following options from the drop-down list: application/EDI-X12 application/EDIFACT application/XML text/html text/plain
Default Text	The default text sent with 200 OK. The default text takes the configured Content Type.
Keystore	The full path to the keystore file, which provides certificate material to be used for a secure connection.
Keystore Password	The password to access the keystore file.
Keystore Type	The type of keystore file. .JKS is the default value.
Truststore	The file that provides trust certificates used to authenticate clients. Leave this blank to use the default JVM truststore. For more information on security, see the iWay Adapter for EDIINT User's Guide.
Truststore Password	The password to access the truststore file, if required.
Truststore Type	The type of truststore. For more information on security, see the iWay Adapter for EDIINT User's Guide.
Security Provider Class	This will override the default Sun security provider, which is: com.sun.net.ssl.internal.ssl.Provider
Security Protocol	The protocol to enable security. Security protocol values include: SSL - Supports some version of SSL. May support other versions. SSLv2 - Supports SSL version 2 or higher. SSLv3 - Supports SSL version 3. May support other versions. TLS - (default) Supports some version of TLS. TLSv1 - Supports TLS version 1. May support other versions.
Security Algorithm	This overrides the default security algorithm, which is: SunX509
Client Authentication	If set to true, authentication is required from the client. False is the default.
Require Authorization	If set to true, the listener implements HTTP basic authentication using one or more authorization drivers. False is the default.
Always reply to listener default	If set to true, the default reply definition is used in addition to defined replies. False is the default.
Channel Failure Flow	Name of published process flow to run if this channel cannot start or fails during message use. The server will attempt to call this process flow during channel close down due to the error.
Channel Startup Flow	The name of the published process flow to run prior to starting the channel.
Channel Shutdown Flow	The name of the published process flow to run after the channel is shut down.
Startup Dependencies	A comma-separated list of channel names that must be started before this one is called.

Note: The HTTP listener supports streaming. Streaming is used for large documents or documents for which the application needs to split the input into sections under the same transaction. For more information on streaming and configuring streaming preparsers, see the iWay Service Manager Component and Functional Language Reference Guide.

Reference: HTTP Listener Special Registers

The following table lists and describes the special registers on the HTTP listener.

Name	Level	Type	Description
...	Header	String	Each header value from the message.
action	Document	String	The action field of the post.
docroot	Document	String	The defined docroot from configuration.
ip	Document	String	The IP address of the sender.
iwayconfig	System	String	The current active configuration name.
iwayhome	System	String	The base at which the server is loaded.
iwayworkdir	System	String	The path to the base of the current configuration.
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 message was received.
requestType	Header	String	The type of HTTP request (GET, POST, or HEAD).
source	Document	String	The host name of the sender.
url	Header	String	The type of full URL of the HTTP (GET, POST, or HEAD).
tid	Document	String	Unique transaction ID.

HTTP Emitter Parameters

The following table lists and describes the HTTP emitter parameters. For instructions on creating an HTTP emitter, see Configuring Emitters.

Parameter	Description
Configuration Parameters HTTP Emitter
Destination (required)	The URL to which to post this information.
Action Method	Select GET (with data on the URL and URL encoded) or POST (with a content length header).
Request content type	This overrides request content type value. Choose from among the following values: application/EDI-X12 application/EDIFACT application/XML text/html text/plain
User ID	A valid user ID for basic authentication challenges.
Password	A password associated with the user ID.
Response Timeout value in seconds	The time (in seconds) to wait for response before signaling an error as integer.
IP Interface Host	The local IP interface from which the outgoing IP socket originates.
IP Interface Port	The local IP port from which the outgoing IP socket originates.
Relay Inbound Content Type	If set to true, then the relay headers are received as content type.
Set TCP No Delay	If set to true, then this parameter disables the Nagle Algorithm on the client socket. This results in a faster line turnaround at the expense of an increased number of packets.
Proxy
Proxy	If set to true, emit through proxy server. False is the default.
Proxy URL	The URL of the proxy server.
Proxy User ID	The user ID for proxy authentication challenges.
Proxy Password	The password to access proxy server.
HTTPS
Secure Connection	If set to true, then the emitter uses a secure connection. You may be required to configure the keystore under the HTTPS section of the system properties if client authentication is required, or if a certificate is used that does not have a matching entry in the default truststore of the JVM. False is the default.
Use 128-bit Encryption	Select true to use 128-bit encryption. False is the default.
Security Protocol	Select from the drop-down list. SSL - Supports some version of SSL. May support other versions. SSLv2 - Supports SSL version 2 or higher. SSLv3 - Supports SSL version 3. May support other versions. TLS - (default) Supports some version of TLS. May support other versions. TLSv1 - Supports TLS version 1. May support other versions.