HTTP Client Output Adapter Studio Properties

Adapter type: toolkit_http_output. Set these properties for the HTTP Client Output adapter in the ESP Studio adapter properties dialog.

If you use the CCL ATTACH ADAPTER statement to attach an adapter, you must supply the adapter type.

Property Label Description
Proxy Host

Property ID: proxyHost

Type: string

(Advanced) Specify the proxy server hostname. No default value.

Proxy Port

Property ID: proxyPort

Type: int

(Advanced) Specify the proxy server port. No default value.

BodyCharset

Property ID: bodyCharset

Type: string

(Optional) Specify the name of a supported charset. The default value is US-ASCII.

Retry Count

Property ID: retryNumber

Type: int

(Advanced) Specify the number of times to try reconnecting to the HTTP server if the adapter disconnects unexpectedly. The default value is 0.

URL Column Index

Property ID: urlColumn

Type: int

(Optional) Specify the column index of the ESP stream to which the adapter is attached which contains the URL to use for sending HTTP requests. This property is required if RequestUrl is empty.

Username Column Index

Property ID: usernameColumn

Type: int

(Optional) Specify the column index of the ESP stream to which the adapter is attached which contains the username to use if the HTTP server requires authentication.

Password Column Index

Property ID: passwordColumn

Type: int

(Optional) Specify the column index of the ESP stream to which the adapter is attached which contains the password to use if the HTTP server requires authentication.

Body Column Index

Property ID: bodyColumn

Type: int

(Required) Specify the column index of the ESP stream to which the adapter is attached which contains the message body content for the HTTP request.

Request Url

Property ID: requestUrl

Type: string

(Optional) Specify a URL to use for sending HTTP requests. This URL is used if the UrlColumn parameter is not specified, or if the ESP stream does not have a URL column.

Request Username

Property ID: requestUsername

Type: string

(Optional) Specify the user name to use if the HTTP server requires authentication. This user name is used if the UsernameColumn parameter is not specified, or if the ESP stream does not have a user name column.

Request Password

Property ID: requestPassword

Type: string

(Optional) Specify the password to use if the HTTP server requires authentication. This password is used if the PasswordColumn parameter is not specified, or if the ESP stream does not have a password column.

Request Body

Property ID: requestBody

Type: string

(Optional) Specify the message body content for the HTTP request. This value is used if the BodyColumn parameter is not specified, or if the ESP stream does not have a body column.

Request Password Encrypted

Property ID: encrypted

Type: boolean

(Advanced) Specify whether the password value is encrypted. If set to true, the password is decrypted using the RSA Key Store, RSA Key Store Password, and Alias in RSA Key Store parameters.

RSA Key Store

Property ID: rsaKeyStore

Type: filename

(Advanced) Specify the filepath of an RSA keystore file which contains the key used to encrypt and decrypt the password set in the RequestPassword property. This property is required if the password value set in RequestPassword is encrypted.

RSA Key Store Password

Property ID: rsaKeyStorePassword

Type: string

(Advanced) Stores the password to the RSA keystore file specified in the RSAKeyStore property. This property is required if the password value set in RequestPassword is encrypted.

Alias in RSA Key Store

Property ID: rsaKeyStoreAlias

Type: string

(Advanced) Specifies the location of the keystore alias. This property is required if the password value set in RequestPassword is encrypted.

PropertySet

Property ID: propertyset

Type: string

(Advanced) Specifies the name of the property set. Property sets are reusable sets of properties that are stored in the project configuration file. Using these sets allows you to move adapter configuration properties out of the CCL file and into the CCR file. If you specify the same properties in the project configuration file and the ATTACH ADAPTER statement, the values in the property set override the values defined in the ATTACH ADAPTER statement. No default value.