Table 12. EAI HTTP Transport Send and SendReceive Arguments
Parameter
|
Display Name
|
S
|
SL
|
Description
|
<Value>
|
User-Defined Message Text
|
|
|
Input and Output data passed as a string. This is the value stored in the Value field of the property set, either input or output. If you specify the HTTPRequestBodyTemplate, the <Value> parameter is ignored and the HTTPRequestBodyTemplate parameter is used instead.
|
HTTPRequestURLTemplate
|
Request URL Template
|
n
|
n
|
Template for the request URL, which is the address to which the data is sent or from which a response is requested.
|
HTTPRequestMethod
|
Request Method
|
n
|
n
|
HTTP method to use with the data request, such as Post and Get.
|
HTTPRequestBodyTemplate
|
Request Body Template
|
|
|
HTTP Body to use with the POST method. This overrides any body specified in the Value field of the input property set.
|
HTTPLoginURLTemplate
|
Login URL Template
|
n
|
|
Template for the URL used for the login operation. This operation is separate from the request operation and assumes communication mode is session mode. If there is a separate login, one or more request and response messages are expected.
|
HTTPLoginMethod
|
Login Method
|
n
|
|
HTTP method to be used for logging in. If no Login Method is specified, this parameter defaults to the HTTPRequestMethod value.
|
HTTPLoginBodyTemplate
|
Login Body Template
|
n
|
|
Specifies the HTTP request body that should be used when HTTPLoginURLMethod is POST. By putting login information into the HTTP body (as opposed to putting it into the URL) for sending, this method provides stronger security than sending the login information in the URL. Generally, the login parameters in a login query are specified in the body of the request that uses the POST method. This is required for session mode only if the HTTPLoginMethod parameter is set to POST.
|
HTTPLogoffURLTemplate
|
Log Off URL Template
|
n
|
|
Template for the URL that is used for the logoff operation. This operation is separate from the request operation and assumes that the mode of communication is session mode. If set, the logoff operation will be completed. Otherwise, logoff is skipped. The purpose of the logoff operation is to end a session that was started with the corresponding login.
|
HTTPLogoffMethod
|
Log Off Method
|
n
|
|
Defaults is HTTPLoginMethod. HTTP method to be used for logging off.
|
HTTPAccept
|
HTTP Accept
|
|
|
Default is text/*. The explicit value for the Accept: header to override the default. Specifies the MIME types accepted by the sender.
|
HTTPContentType
|
HTTP Content Type
|
|
|
Default is application/xxx-form-urlencoded. The explicit value for the Content-Type: header to override the default. Specifies the type of data sent in the body of the request.
|
HTTPUserAgent
|
HTTP User Agent
|
|
|
Default is Mozilla/4.0. The explicit value for the User-Agent: header to override the default. Specifies the name/version of the client program.
|
HTTPMaxIdleSeconds
|
Max Idle Seconds
|
|
|
Maximum number of seconds to allow connections to be idle. After the elapsed max idle time, the connection is invalidated and restarted.
|
HTTPAllowCaching
|
Allow Caching
|
|
|
Default is N. By default, the responses for specific URL addresses are not cached by the EAI HTTP Transport. Set this flag to Y to enable caching.
Note that this can lead to undesirable side effects, as old data from earlier requests can be exposed from the cache buffer.
|
HTTPAllowPersistentCookies
|
Allow Persistent Cookies
|
|
|
Default is N. A session cookie is used to tie requests and logoff operations to the user session started at the login, when communicating with any session-cookie-based system. Leaving this flag set to N leaves the persistence of cookies in the control of the EAI HTTP transport, which is the default behavior.
All session cookies persist in memory only as long as the current session. Session cookies are not written to disk.
If you want to use persistent cookies—that is, if persistence between logins is required and you want cookies written to disk and then set the parameter to Y.
|
HTTPIsSecureConn
|
Is Secure Connection
|
|
|
Default is N. If set to N then the security mode defaults to whatever the URL specifies, either HTTP or HTTPS.
Setting this parameter to Y enables the Secure flag for SSL communications; thus, it forces the use of secure mode.
If you choose to use SSL encryption, you must establish valid certificates and SSL capabilities on both the client and server.
Using the HTTPS: designation in an URL, by default enables the Secure flag and specifies clear text unencrypted communications.
|
HTTPNoAutoRedirect
|
No Auto Redirect
|
|
|
Default is N. This means auto-redirect is enabled. Setting this parameter to Y disables auto-redirection of messages to other URLs.
|
HTTPSleepTime
|
Sleep Time
|
|
|
Default is 120000 milliseconds. The timeout interval on login, send, and logoff requests in milliseconds.
|
HTTPImplicitCharsetDetection
|
Implicit Character Set Detection
|
|
|
Default is False. This is implicit character set detection for incoming data and should not be set to True for self-describing documents like XML. If set to True, this overrides the CharSetConversion parameter.
|
