In this section:
The Parasoft Kafka Transport Extension adds support for the Apache Kafka transport to applicable messaging client tools in SOAtest. This enables you to take full advantage of SOAtest's rich interface when configuring, sending, and validating messages sent over Kafka.
This artifact can be installed from the UI or the command line.
Add the kafka.jar file to the system.properties.classpath property in your localsettings properties file. For example:
system.properties.classpath=<path to jar>/kafka-transport-1.1.jar
You can configure you message client tools (e.g., SOAP Client, EDI Client, and Messaging Client) to use the Kafka Transport by enabling it in the tool's Transport tab. Choose Kafka from the Transport drop-down menu and configure the available options.
If your system has more than one custom extension, choose Kafka from the Select implementation drop-down menu.
The transport can be configured as a producer, consumer, or both. To configure the transport as a producer only, leave the consumer configuration settings empty. To configure the transport as a consumer only, leave the producer configuration settings empty.
| Brokers | Specify a comma-separated list of servers where Kafka is running, including the ports. |
|---|---|
| Security Protocol | Specifies the security protocol. You can specify following values:
The Transport Layer Security (TLS) settings will be applied when this Security Protocol is set to either SASL_PLAINTEXT and SASL_SSLYou cannot fully configure the
Specify the file in the Additional Settings File Path field under the Producer Settings or Consumer Settings. |
| Log Level | Specify how much information you want logged to the console. The default is |
| Topic | Specify the name of a topic to which the producer will write messages. |
|---|---|
| Partition | Specify the integer number for the partition in a topic (e.g., If empty, the record key will be used to generate a partition number. |
| Record Key Serializer | Specify whether the key should be written/sent as a string or as null. The default value is string. |
| Record Key | Specify the record key. |
| Idempotent | Specify |
| Request Timeout | Specify the how long to wait in milliseconds to send and receive an acknowledgment before timing out. Default is 30000. |
| Additional Settings File Path | Specify a properties file containing additional settings that may be required to connect to your application. This setting is optional. If this field is empty, SOAtest will use default Kafka settings for any additional settings your application may require that are not available in the UI. |
| Topic | Specify the name of a topic or a comma-separated list of topics to which the consumer should subscribe. You can specify a partition within the topic with a colon and the integer number for the partition. For example, |
|---|---|
| Group id | Specify the group to which the consumer belongs. This property is required when partition is not specified with the topic. |
| Offset | Specify the position within a topic/partition to begin reading records. |
| Poll interval | Specify a duration in milliseconds between polling. Default is 100. |
| Max Poll Records | Specify the maximum number of records to poll between intervals. Default is 500. |
| Commit Offsets | Specify a mode for committing offsets. Commits are points in the partition at which the consumer can resume processing records.
Default is |
| Timeout | Specify how many milliseconds the consumer should wait for messages to be published to the subscribed topic/partition before disconnecting. Default is 30000. |
| Additional Settings File Path | Specify a properties file containing additional settings that may be required to connect to your application. This setting is optional. If this field is empty, SOAtest will use default Kafka settings for any additional settings your application may require that are not available in the UI. |
| TLS Protocol | Defines the Transport Layer Protocol to use when establishing a secure connection. Default: |
|---|---|
| Security Provider | The name of the security provider used for TLS connections. Default value is the default security provider of the JVM. |
| Key Store File Location | Defines an absolute or relative path to the asset (.tst, .pva, .pvn) key store file. |
| Key Store Type | Defines the type of Key Store File provided. Different Key Store Types can be handled depending on the security providers that have been loaded into the JVM. If additional security providers have been added to the JVM, check the security provider's documentation to gather the available Key Store Type names. |
| Key Store Password | Defines the password to be used to extract the keys/certificates from the Key Store File. If left blank, an attempt will be made to extract the keys without a password. |
| Key Password | Specifies the password of the private key in the key store file. This setting is optional for clients. |
| Trust Store File Location | Defines an absolute or relative path to the asset (.tst, .pva, .pvn) Trust Store file. Default: |
| Trust Store Type | Defines the type of Trust Store File provided. Different Trust Store Types can be handled depending on the security providers that have been loaded into the JVM. If additional security providers have been added to the JVM, check the security provider's documentation to gather the available Trust Store Type names. |
| Trust Store Password | Defines the password to be used to extract the keys/certificates from the Trust Store File. If left blank, an attempt will be made to extract the keys without a password. |
Keep connection alive | Enable this option to keep the client connection alive and reused for subsequent publishing. |
|---|---|
Close connection after test execution | Enable this option to close the client connection directly after publishing. |
This extension includes items that have been sourced from third parties as outlined below.
Additional license details are available in this plugin's licenses folder.