1. iWay Integration Tools
  2. Chapter 3. iWay Providers
  3. 3.1. Concept: Providers
  4. Provider - HTTP

Provider - HTTP

Description - This provider creates a reusable configuration for making HTTP/HTTPS requests.
 
Runtime Class - com.iwaysoftware.eclipse.template.HttpClientProviderType


 

Parameter Groups

  Parameter Type Description
  TLS/SSL Configuration: string A provider for configuring TLS/SSL for securing https requests.

Click below for a definition:
  Kerberos Login Entry: string The Application Login Entry in the JAAS login configuration file that will be used to login to Kerberos. This login entry should configure a Kerberos login module (Krb5LoginModule).
* - denotes required
  Parameter Type Description
  Connection Timeout: integer Time in milliseconds that a request will block while waiting for a connection to become available from the pool. The value 0 means there is no timeout.
* Maximum Connections Per Host: integer Maximum number of connections allowed per host for this provider. Value must be greater than 0.
* Maximum Total Number of Connections: integer Maximum number of connections allowed overall for this provider. Value must be greater than 0.
  Idle Timeout: integer Time in seconds that an unused connection can remain in the pool. If set to 0, connections will remain in the pool indefinitely.
* - denotes required
  Parameter Type Description
  Set TCP No Delay: boolean If true, disables Nagle's Algorithm on the client socket. This will result in faster line turnaround at the expense of an increased number of packets.
  Reuse Socket Address: boolean If true, allows a socket to be bound even though a previous connection is still in a timeout state. Note that this only applies when the local IP interface is specified. This option may be useful for applications that make a large number of short-lived, non-persistent connections, but should be changed with caution. To use this option, you MUST specify the local bind address as 0.0.0.0 (a wildcard) or :: (a wildcard for IPV6.) This allows the system to avoid "exact match" clashes on socket source address/port combinations, and this actually harvest the port.
  Linger-On-Close Timeout: integer This option disables/enables immediate return from a close() of a TCP Socket. Enabling this option with a non-zero Integer timeout means that a close() will block pending the transmission and acknowledgment of all data written to the peer, at which point the socket is closed gracefully. Upon reaching the linger timeout, the socket is closed forcefully, with a TCP RST. Enabling the option with a timeout of zero does a forceful close immediately. Note that this may have the effect of leaving sockets on the server side in a wait state. Enter -1 or leave blank for the JRE default. Requires HttpClient 4.1 or later.
  IP Interface Host: string Local IP Interface from which the outgoing IP socket originates. To use the Reuse Socket Address option, set this address to 0.0.0.0.
* - denotes required
  Parameter Type Description
  Enabled: boolean If on, emit through proxy server
  User ID: string User ID for proxy challenges
  Password: password Password to access proxy server
  Domain: string Domain for NTLM proxy authentication
  Host: string Host where the proxy can be accessed
  Port: integer Port where the proxy can be accessed
  Authentication Preference: string If several schemes are returned in the WWW-Authenticate header, this parameter defines which schemes take precedence over others. The value is a comma separated list of authentication scheme names with the most preferred scheme first. The default is negotiate,NTLM,Digest,Basic where negotiate means SPNEGO. Kerberos requires the negotiate scheme and HttpClient 4.1 or later.
* - denotes required
  Parameter Type Description
  Redirect Strategy: string Determines how an HTTP redirect response is handled. The default is to follow redirects according to the RFC. The off strategy does not redirect any request.

Select from one of the following options:
  • off {off}
* - denotes required
  Parameter Type Description
  Specification: string The cookie management specification determines the rules for parsing, validating and formatting cookies. The recommended policy is best-match. Requires HttpClient 4.1 or later.

Select from one of the following options:
  • best-match {best-match}
  • netscape {netscape}
  • rfc2109 {rfc2109}
  • rfc2965 {rfc2965}
  • compatibility {compatibility}
  • ignoreCookies {ignoreCookies}
  Persist: boolean If true, cookies are preserved between server reboots.
* - denotes required