Kafka Consumer Streams Adapter
The Kafka Consumer Streams Adapter connects with a Kafka queue to pull messages continuously.
The following table provides an overview of the Kafka Consumer Streams Adapter:
|System name||Kafka Consumer Streams Adapter|
|Description||This adapter is used to connect with a Kafka messaging queue to retrieve business documents.|
|Business usage||Use this adapter to retrieve documents from Kafka queue.|
|Usage example||Kafka Consumer Streams Adapter connects to the Kafka queue using the configuration provided and retrieve documents. The adapter also saves documents in the mailbox.|
|Requires third-party files?||No|
|Platform availability||All Sterling B2B Integrator supported platforms.|
|Application requirements||A Kafka server.|
|Initiates business processes?||This service initiates KafkaStreamServiceMailbox business processes.|
|Invocation||This service is not invoked from a business process.|
Configuring Kafka Consumer Streams Adapter
To configure the Kafka Consumer Streams Adapter, you must specify field settings in Sterling B2B Integrator:
|Name||Name this service will have in Sterling B2B Integrator. Required.|
|Description||Description of service. Required.|
|Environment||Nodes where the Kafka Consumer Streams Adapter is deployed. The values are - nodes in the cluster, adapter containers, All ASI nodes, All ASI nodes plus all Adapter Container Nodes, and All Adapter Container Nodes. To scale the Kafka Consumer Streams Adapter as and when new nodes are added to the cluster, the options All ASI nodes, All ASI nodes plus all Adapter Container Nodes, and All Adapter Container Nodes are introduced.|
|Select a Group||Select one of the options:
Note: For more information about groups, see Managing Services and Adapters.
|Topic||Topic to which the Kafka Consumer Streams Adapter connects.|
|KeyDeserializer||Deserializer class for key that implements the org.apache.kafka.common.serialization.Deserializer interface.|
|ValueDeserializer||Deserializer class for value that implements the org.apache.kafka.common.serialization.Deserializer interface.|
|BootStrapServers||A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. This list should be in the form:
|SecurityAction||Protocol used to communicate with brokers. Valid values are
|SASLMechanism||SASL mechanism used for client connections. This may be any mechanism for which a security provider is available.|
|SASLJaasConfig||JAAS login context parameters for SASL connections in the format used by JAAS configuration files. JAAS configuration file format is described here: JAAS Login Configuration File.
|TrustStorePath||The location of the trust store file.|
|TrustStorePassword||The password for the trust store file.|
|KeyStorePath||The location of the key store file. This is optional for client and can be used for two-way authentication for client.|
|KeyStorePassword||The store password for the key store file.|
|Document Storage Type||Type of storage required for the document to be stored at. It can be File System, Database or Object Store.|
|Save file to mailbox?||To store the document in the mailbox, select Yes. System default is No.|
|Mailbox User||The mailbox user for which the document must be stored.
Note: Ensure the user is given the required permissions to store the document.
|Mailbox Path||Mailbox path that the user has permission to use. If a user is set up with a virtual root, the
The following characters cannot be used in a mailbox name:
Note: For Global Mailbox enabled Trading Partner, select the mailbox path as / (forward slash).
|Use Global Mailbox||Whether to use only Global Mailbox or only traditional Sterling B2B Integrator mailboxes. The following values are valid: