Show TOC

HTTP Client Output Adapter ConfigurationLocate this document in the navigation structure

Configure the HTTP Client Output adapter by specifying values for the ESP connector and transporter modules in the adapter configuration file.

Logging
XML Element Description
Log4jProperty

Type: string

(Optional) Specify a full path to the log4j.properties logging file you wish to use. The default value is STREAMING_HOME/adapters/framework/config/log4j.properties.

Encryption
XML Element Description
Cipher

Type: string

(Optional) Specify a full path to the adapter.key encryption file you wish to use. The default value is $STREAMING_HOME/adapters/framework/adapter.key.

ESPConnector Module: ESP Subscriber

The ESP Subscriber module obtains data from the SAP Event Stream Processor project and passes it along to a transporter or formatter module.

XML Element Description
Module

(Required) Element containing all information for this module. It contains a type attribute for specifying the module type.

For example, espconnector.

InstanceName

Type: string

(Required) Instance name of the specific module you want to use. For example, MyInputTransporter.

Name

Type: string

(Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.

Next

Type: string

(Required) Instance name of the module that follows this one.

BufferMaxSize

Type: integer

(Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240.

Parameters (Required) Element containing the EspSubscriberParameters element.
EspSubscriberParameters

(Required) Element containing elements for the ESP subscriber.

ProjectName

Type: string

(Required if running adapter in standalone mode; optional if running in managed mode) Specifies the unique project tag of the ESP project to which the adapter is connected. For example, StreamingProject2.

This is the same project tag that you specify later in the adapter configuration file in the Name element within the Event Stream Processor (EspProjects) element.

If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this element as the adapter automatically detects the project name.

StreamName

Type: string

(Required if running adapter in standalone mode; optional if running in managed mode) Name of te stream from which the adapter subscribes to data.

If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this element as the adapter automatically detects the stream name.

OutputBase

Type: boolean

(Optional) If set to true, the adapter outputs the initial stream contents in addition to stream updates.

If this option is enabled and the adapter is running in GD mode, once the adapter has done a GD commit on the entire base data, the ESP Server does not redeliver the base data on adapter restart and only sends deltas that are saved for delivery. The default value is false.

OnlyBase

Type: boolean

(Advanced) Sends a one-time snapshot of initial contents in a stream. Default value is false. If set to true, OutputBase automatically becomes true.

Transporter Module: HTTP Output Transporter

The HTTP Output transporter obtains data from the ESP stream and outputs it to an HTTP server.

XML Element Description
Module

(Required) Element containing all information for this module. It contains a type attribute for specifying the module type.

For example, transporter.

InstanceName

Type: string

(Required) Instance name of the specific module you want to use. For example, MyInputTransporter.

Name

Type: string

(Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.

BufferMaxSize

Type: integer

(Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240.

Parameters

(Required) Element containing the HttpOutputTransporterParameters element.

HttpOutputTransporterParameters

(Required) Element containing the elements for the HTTP Output transporter.

ProxyHost

Type: string

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

ProxyPort

Type: integer

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

RetryNumber

Type: integer

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

BodyCharset

Type: string

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

UrlColumn

Type: integer

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

UsernameColumn

Type: integer

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

PasswordColumn

Type: integer

(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.

BodyColumn

Type: integer

(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.

RequestUrl

Type: string

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

RequestUsername

Type: string

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

RequestPassword

Type: string

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

This property includes an encrypted attribute which indicates whether the password value is encrypted. If set to true, the password is decrypted using the RSAKeyStore, RSAKeyStorePassword, and RSAKeyStoreAlias properties.

RequestBody

Type: string

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

RSAKeyStore

Type: string

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

RSAKeyStorePassword

Type: string

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

RSAKeyStoreAlias

Type: string

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

SAP Event Stream Processor Elements

SAP Event Stream Processor elements configure communication between Event Stream Processor and the HTTP Client Output adapter.

XML Element Description
EspProjects

(Required) Element containing elements for connecting to Event Stream Processor.

EspProject

(Required) Element containing the Name and Uri elements. Specifies information for the ESP project to which the adapter is connected.

Name

Type: string

(Required) Specifies the unique project tag of the ESP project which the EspConnector (publisher/subscriber) module references.

Uri

Type: string

(Required) Specifies the total project URI to connect to the ESP project. For example, if you have SSL enabled, use esps://localhost:19011/ws1/p1.

Security

(Required) Element containing all the authentication elements below. Specifies details for the authentication method used for Event Stream Processor.

User

Type: string

(Required) Specifies the user name required to log in to Event Stream Processor (see AuthType). No default value.

Password

Type: string

(Required) Specifies the password required to log in to Event Stream Processor (see AuthType).

Includes an "encrypted" attribute indicating whether the Password value is encrypted. The default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword.

AuthType

Type: string

(Required) Method used to authenticate to Event Stream Processor. Valid values are:
  • server_rsa - RSA authentication using keystore
  • kerberos - Kerberos authentication using ticket-based authentication
  • user_password - LDAP, SAP BI, and Native OS (user name/password) authentication

If the adapter is operated as a Studio plug-in, AuthType is overridden by the Authentication Mode Studio start-up parameter.

RSAKeyStore

Type: string

(Dependent required) Specifies the location of the RSA keystore, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both.

RSAKeyStorePassword

Type:string

(Dependent required) Specifies the keystore password, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both.

KerberosKDC

Type: string

(Dependent required) Specifies host name of Kerberos key distribution center. Required if AuthType is set to kerberos.

KerberosRealm

Type: string

(Dependent required) Specifies the Kerberos realm setting. Required if AuthType is set to kerberos.

KerberosService

Type: string

(Dependent required) Specifies the Kerberos principal name that identifies the Event Stream Processor cluster. Required if AuthType is set to kerberos.

KerberosTicketCache

Type: string

(Dependent required) Specifies the location of the Kerberos ticket cache file. Required if AuthType is set to kerberos.

EncryptionAlgorithm

Type: string

(Optional) Used when the encrypted attribute for Password is set to true. If left blank, RSA is used as default.