Configure the Web Services (SOAP) Input adapter by specifying values for the SOAP Input transporter, the ESP connector (EspPublisher), and Event Stream Processor.
Parameter | Description |
---|---|
Log4jProperty |
Type: string (Optional) Specify the path to the log4j.properties logging file you wish to use. The default value is $ESP_HOME/adapters/framework/config/log4j.properties. |
Parameter | Description |
---|---|
Module |
(Required) Section containing all information for the SOAP input transporter. It contains a type attribute for specifying the module type. For example, transporter. |
InstanceName |
Type: string (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter. |
Name |
Type: string (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
Polling |
Section containing the polling parameters, Enabled and TimeInterval. |
Enabled |
Type: boolean (Required) Turns on polling for the Web Service (SOAP) Input adapter. This parameter should always be enabled for the input adapter. |
TimeInterval |
Type: integer (milliseconds) (Required) The polling interval for the Web Services (SOAP) Input adapter. |
Next |
Type: string (Required) Specify the instance name of the module that follows this one. |
Parameters |
(Required) Section containing the SOAPInputTransportParameters element. |
SOAPInputTransportParameters |
(Required) Section containing parameters for the SOAP Input transporter. |
webservice |
Type: string (Required) Specify the Web service to which the adapter connects. Include the name attribute. For example, name="StockTraderService". This section contains the urls, wsdlURL, serviceURL, serviceTimeout, serviceRetries, request, mappingFile, and security parameters. |
urls |
(Required) Section containing the wsdlURL and serviceURL parameters. |
wsdlURL |
Type: string (Required) The URL for the Web service's WSDL. |
serviceURL |
Type: string (Dependent required) Required only if you want to call the Web service at a different endpoint than what is specified in the wsdlURL parameter. For example, for testing purposes or tcpMon. |
serviceTimeout |
Type: integer (Required) Specifies the amount of time the adapter waits before timing out the connection with the Web service. |
serviceRetries |
Type: integer (Required) Specifies the number of times the adapter retries each service endpoint if it fails to connect. |
request |
Type: string (Required) Section containing the param parameter. Specifies the Web service request. Includes the action attribute which specifies the action performed by the Web service operation that is being called. |
param |
Type: string (Required) Specify the input parameters to the Web service.
You can specify multiple param
parameters. Includes these attributes:
|
mappingFile |
Type: string (Required for adapter operation and schema discovery) Specify a valid path to the mapping file for the adapter. |
security |
(Required) Section containing the adapter security configuration. The adapter supports HTTPS protocol, HTTP basic access authentication, WS policy security, and transport level security. Specify either WS policy security or transport level security. This section contains the sslTrustStore
and sslTrustStorePassword parameters,
as well as the configuration parameters for either
WSPolicy security or
TransportUsernameToken
security.
Note: You can enable only one of HTTP basic
access authentication, WS policy security, or transport
level security at a time.
|
sslTrustStore |
Type: string (Required only if ESP projects are running in SSL mode) Specify the path to the trust store file containing the server's certificate. |
BasicAccessAuthentication |
(Required only if using HTTP basic access authentication) Stores the credentials used to authenticate against a Web service that is set up with HTTP basic access authentication. Section containing the credentials, User, Password, RSAKeyStore , RSAKeyStorePassword and EncryptionAlgorithm parameters for WS policy security. |
credentials |
(Optional) Section containing the User, Password, RSAKeyStore, RSAKeyStorePassword and EncryptionAlgorithm parameters. |
User |
Type: string (Required) Specifies the user name required to connect to the Web service. |
Password |
Type: string (Required) Specifies the password required to connect to the Web service. Includes an "encrypted" attribute indicating whether the Password value is encrypted. Default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword. |
RSAKeyStore |
Type: string (Optional) Specify the location of an RSA keystore file which contains the key used to encrypt or decrypt the password set in the Password parameter. |
RSAKeyStorePassword |
Type: string (Optional) Stores the password to the RSA keystore file specified in the Keystore parameter. |
EncryptionAlgorithm |
Type: string (Optional) Specifies the algorithm that is used to decrypt the password specified in the Password parameter, if encrypted. For example, RSA. |
Parameter | Description |
---|---|
WSPolicy |
(Required only if using WS policy security) Section containing the credentials, User, Password, RSAKeyStore, RSAKeyStorePassword, policyClass, and param parameters for WS policy security. |
credentials |
(Optional) Section containing the User, Password, RSAKeyStore, and RSAKeyStorePassword parameters. |
User |
Type: string (Optional) Specifies the user name required to connect to the Web service. |
Password |
Type: string (Optional) Specifies the password required to connect to the Web service. Includes an "encrypted" attribute indicating whether the Password value is encrypted. Default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword. |
RSAKeyStore |
Type: string (Optional) Specify the location of an RSA keystore file which contains the key used to encrypt or decrypt the password set in the Password parameter. |
RSAKeyStorePassword |
Type: string (Optional) Stores the password to the RSA keystore file specified in the Keystore parameter. |
policyClass |
Type: string (Required only if using WS policy security) Specifies the plugin class to use that provides the policy information to the system. This class must extend from the class com.sap.esp.adapter.ws.security.WSPolicy. |
param |
Type: string (Optional) Specifies the parameters needed by the security mechanism of the WS policy. Includes "name" and "value" attributes. |
Parameter | Description |
---|---|
TransportUsernameToken |
(Required only if using transport level security) Section containing the credentials, User, Password, RSAKeyStore, RSAKeyStorePassword, and EncryptionAlgorithm parameters. This type of security uses a username/token which is signed at the transport level. |
credentials |
(Required) Section containing the User, Password, RSAKeyStore, RSAKeyStorePassword, and EncryptionAlgorithm parameters. Specifies credentials for transport level security. |
User |
Type: string (Required) Specifies the user name required for connecting to the Web service. |
Password |
Type: string (Required) Specifies the password required to connect to the Web service. Includes an "encrypted" attribute indicating whether the Password value is encrypted. Default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword. |
RSAKeyStore |
Type: string (Optional) Specify the location of an RSA keystore file which contains the key used to encrypt or decrypt the password set in the Password parameter. |
RSAKeyStorePassword |
Type: string (Optional) Stores the password to the RSA keystore file specified in the Keystore parameter. |
EncryptionAlgorithm |
Type: string (Optional) Specifies the algorithm that is used to decrypt the password specified in the Password parameter, if encrypted. For example, RSA. |
Parameter | Description |
---|---|
workingDir |
Type: string (Required) Section containing the proxy, host, port, and nonProxyHost parameters. The directory where temporary adapter files are written. These files are cleaned up when the adapter shuts down. |
proxy |
(Optional) Section containing the host, port, and nonProxyHosts parameters. These properties specify a proxy server address through which the HTTP traffic is routed. This is often required in corporate networks, such as SAP, as individual machines do not connect directly to the external internet. |
host |
Type: string (Optional) If the adapter needs to connect through a proxy, specify the host of the proxy through which the adapter is connecting. |
port |
Type: integer (Optional) If the adapter needs to connect through a proxy, specify the host of the proxy through which the adapter is connecting. |
nonProxyHosts |
Type: string (Optional) Specify the host names which should not be routed through the proxy host. These are addresses located within the intranet that can be reached directly. |
Parameter | Description |
---|---|
Module |
(Required) Section containing all information for this module. It contains a type attribute for specifying the module type. For example, formatter. |
InstanceName |
Type: string (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter. |
Name |
Type: string (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
Parameters |
(Required) Section containing the EspPublisherParameters parameter. |
EspPublisherParameters |
(Required) Section containing parameters for the ESP publisher. |
ProjectName |
Type: string (Required if running adapter in standalone mode; optional if running in managed mode) Name of the ESP project to which the adapter is connected. For example, EspProject2. This is the same project tag that you specify later in the adapter configuration file in the Name parameter of the Event Stream Processor (EspProjects) parameters section. 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 property 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 the ESP stream to which the adapter publishes 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 property as the adapter automatically detects the stream name. |
MaxPubPoolSize |
Type: positive integer (Optional) Specifies the maximum size of the record pool. Record pooling, also referred to as block or batch publishing, allows for faster publication since there is less overall resource cost in publishing multiple records together compared to publishing records individually. Block publishing (record pooling or batch publishing) is disabled if this value is set to 1. The default value is 256. |
UseTransactions |
Type: boolean (Optional) If set to true, pooled messages are published to Event Stream Processor in transactions. If set to false, they are published in envelopes. Default value is false. |
SafeOps |
Type: boolean (Advanced) Converts the opcodes INSERT and UPDATE to UPSERT, and converts DELETE to SAFEDELETE. The default value is false. |
SkipDels |
Type: boolean (Advanced) Skips the rows with opcodes DELETE or SAFEDELETE. The default value is false. |
Event Stream Processor parameters configure communication between Event Stream Processor and the Web Services (SOAP) Input adapter.
Parameter | Description |
---|---|
EspProjects |
Section containing parameters for connecting to Event Stream Processor. |
EspProject |
Section containing the Name and Uri parameters. 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 Event Stream Processor cluster. For example, esp://localhost:19011/ws1/p1. |
Security |
Section containing all the authentication parameters 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 espAuthType). Includes an "encrypted" attribute indicating whether the Password value is encrypted. Default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword. |
AuthType |
Type: string (Required) Specifies method used to authenticate to the
Event Stream Processor. Valid values are:
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 an 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. |