Docs

Message Queue for Kafka

Java client SDK

SASL_SSL access point sending and receiving messages using SCRAM mechanism

This topic uses the Java client as an example to describe how to connect to Message Queue for Kafka using the SCRAM mechanism through SASL_SSL endpoints in VPC or public network environments, and send and receive messages.

Prerequisites

Preparatory work has been completed. For detailed explanations, refer to Preparations.

1. Install Java dependencies

Add the relevant dependencies in the Java project's pom.xml file. Here is an example of Kafka version 2.2.2.

2 Add configuration file

Create the Message Queue for Kafka configuration file config.properties.

For detailed descriptions of the configuration file fields, refer to configuration file.

tip

Under SCRAM mechanism, use a SCRAM user with corresponding Topic access rights for SASL authentication. For how to obtain the username and password, refer to 2 Collect Connection Information.

When connecting using the SCRAM mechanism through a SASL_SSL access point, an example configuration file is as follows.

bootstrap.servers=xxxxx
security.protocol=SASL_SSL
topic=my-topic
consumer.group.id=test
consumer.auto.offset.reset=earliest
consumer.enable.auto.commit=false
client.dns.lookup=use_all_dns_ips
sasl.mechanism=SCRAM-SHA-256
sasl.jaas.config=org.apache.kafka.common.security.scram.ScramLoginModule required username="xxxx" password="xxxxx";

Create the configuration file loaderKafkaConfigurer.java.

package com.volcengine.openservice.kafka;

import java.io.FileInputStream;
import java.io.InputStream;
import java.util.Properties;

public class KafkaConfigurer {

private static Properties properties;

public synchronized static Properties getKafkaProperties(String path) {
if (null != properties) {
return properties;
}
Properties kafkaProperties = new Properties();
try {
FileInputStream conf = new FileInputStream(path);
kafkaProperties.load(conf);
} catch (Exception e) {
e.printStackTrace();
}
properties = kafkaProperties;
return kafkaProperties;
}
}

3 Produce messages

implementation method

Create message production program ProducerDemo.java.

Compile and run ProducerDemo.java to produce messages.

check the running results.

the running result example is as follows.

Produce ok:sasl-0@0
Produce ok:sasl-0@1
Produce ok:sasl-0@2
Produce ok:sasl-0@3

tip

Message Queue for Kafka provides an example project Demo to help you quickly integrate. After downloading and extracting the demo, you can directly execute the following commands to send messages.

Example code

The following is example code for producing messages using the SCRAM mechanism via a SASL_SSL endpoint. You can also refer to the sample file in the demo {DemoPath}/src/main/java/com/volcengine/openservice/kafka/ProducerDemo.java to implement related business logic.

4 Consume messages

implementation method

Create a consumer subscription program ConsumerDemo.java.

Compile and run ConsumerDemo.java to consume messages.

check the running results.

the running result example is as follows.

tip

Message Queue for Kafka provides an example project Demo to help you quickly integrate. After downloading and extracting the sample project, you can directly run the following commands to consume messages.

Sample code

The following sample code demonstrates how to consume messages using the SCRAM mechanism via a SASL_SSL endpoint. You can also refer to the sample file in the demo {DemoPath}/src/main/java/com/volcengine/openservice/kafka/ConsumerDemo.java to implement related business logic.

Last updated: 2025.09.18 17:51:06