Skip to main content
Version: 1.0.0

Example

Overview

Inlong-dataproxy-sdk provides access api for TCP and HTTP protocols. When using TCP or HTTP access, you need to ensure that the dataproxy server has the access configuration of the corresponding protocol (ie the TCP or HTTP source service). If the user needs to use the UDP protocol to access, the user needs to packets data according to the bytes arrays transmitted by TCP, and send them to the dataproxy server using the UDP protocol. and dataproxy server will handle messages in the same way as TCP. In addition, access demo codes for TCP, HTTP, and UDP protocols are provided in the example directory of inlong dataproxy SDK, which you can refer to when accessing.

To view detailed API information overview.

Add Dependency

   <dependency>
<groupId>org.apache.inlong</groupId>
<artifactId>dataproxy-sdk</artifactId>
<version>${inlong_version}</version>
</dependency>

TCP Example

Create a messageSender

    public DefaultMessageSender getMessageSender(String localIP, String inLongManagerAddr, String inLongManagerPort,
String netTag, String dataProxyGroup, boolean isLocalVisit, boolean isReadProxyIPFromLocal,
String configBasePath, int msgType) {
ProxyClientConfig dataProxyConfig = null;
DefaultMessageSender messageSender = null;
try {
dataProxyConfig = new ProxyClientConfig(localIP, isLocalVisit, inLongManagerAddr,
Integer.valueOf(inLongManagerPort), dataProxyGroup, netTag);
if (StringUtils.isNotEmpty(configBasePath)) {
dataProxyConfig.setConfStoreBasePath(configBasePath);
}
dataProxyConfig.setReadProxyIPFromLocal(isReadProxyIPFromLocal);
messageSender = DefaultMessageSender.generateSenderByClusterId(dataProxyConfig);
messageSender.setMsgtype(msgType);
} catch (Exception e) {
logger.error("getMessageSender has exception e = {}", e);
}
return messageSender;
}

The parameter description is as follows:

parameter nametypeinstruction
inLongManagerAddrStringinlong admin server address
inLongManagerPortStringinlong admin server port
netTagStringNetwork label, not used yet, you can pass an empty string
dataProxyGroupStringdataProxy group name, the name used for local configuration when the user enables local configuration
isLocalVisitbooleanWhether to use local configuration, true use https to access the console, false use http to request the console
isReadProxyIPFromLocalbooleanWhether to obtain the address information of the Dataproxy server from the local configuration file, local self-test, can be set to true if the management console cannot be accessede
configBasePathStringThe path of the local configuration file. The default is ./inlong. When isReadProxyIPFromLocal is true, the configuration file is searched from this directory
msgtypeintMessage assembly type, value (3, 5, 7, 8), it is recommended to use 7, each message type represents a message assembly protocol during the transmission process, please refer to the code implementation of SDK for details

When isReadProxyIPFromLocal is true, the configuration information of Dataproxy will be obtained from the local configuration file.

The path to the local file is :

    ${configBasePath}

The file name is :

    ${dataProxyGroup}.local

For example:

    configBasePath = /data/inlong
dataProxyGroup = inlong_test

Then the full path of the local file is:

    /data/inlong/inlong_test.local

The file configuration content is (json format), where host is the address of the DataProxy server, and port is the corresponding port, which requires at least two configurations (the same two items can be configured):

    {"isInterVisit":1,"cluster_id":"1","size":1,"switch":1,"address":[{"host":"127.0.0.1","port":"46802"},{"host":"127.0.0.1","port":"46802"}]}

Send Message

    public void sendTcpMessage(DefaultMessageSender sender, String inlongGroupId,
String inlongStreamId, String messageBody, long dt) throws Exception {
SendResult result = sender.sendMessage(messageBody.getBytes("utf8"),inlongGroupId, inlongStreamId,
0, String.valueOf(dt), 20,TimeUnit.SECONDS);
logger.info("messageSender {} ", result);
}

The parameter description is as follows:

parameter nametypeinstruction
senderHttpProxySenderThe sender created in the first step
inlongGroupIdStringinglongGroupId
inlongStreamIdStringinlongStreamId
messageBodyStringSent message content
dtlongtimestamp

HTTP Example

Create MessageSender

    public HttpProxySender getMessageSender(String localIP, String inLongManagerAddr, String inLongManagerPort,
String netTag, String dataProxyGroup, boolean isLocalVisit, boolean isReadProxyIPFromLocal,
String configBasePath) {
ProxyClientConfig proxyConfig = null;
HttpProxySender sender = null;
try {
proxyConfig = new ProxyClientConfig(localIP, isLocalVisit, inLongManagerAddr,
Integer.valueOf(inLongManagerPort),
dataProxyGroup, netTag);
proxyConfig.setGroupId(dataProxyGroup);
proxyConfig.setConfStoreBasePath(configBasePath);
proxyConfig.setReadProxyIPFromLocal(isReadProxyIPFromLocal);
proxyConfig.setDiscardOldMessage(true);
sender = new HttpProxySender(proxyConfig);
} catch (ProxysdkException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
return sender;
}

The parameter description is as follows:

parameter nametypeinstruction
inLongManagerAddrStringinlong admin server address
inLongManagerPortStringinlong admin server port
netTagStringNetwork label, not used yet, you can pass an empty string
dataProxyGroupStringdataProxy group name, the name used for local configuration when the user enables local configuration
isLocalVisitbooleanWhether to use local configuration, true use https to access the console, false use http to request the console
isReadProxyIPFromLocalbooleanWhether to obtain the address information of the Dataproxy server from the local configuration file, local self-test, can be set to true if the management console cannot be accessed
configBasePathStringThe path of the local configuration file. The default is ./inlong. When isReadProxyIPFromLocal is true, the configuration file is searched from this directory.

When isReadProxyIPFromLocal is set true, the configuration information of Dataproxy will be obtained from the local configuration file.

The path to the local file is:

    ${configBasePath}

The file name is:

    ${dataProxyGroup}.local<br/>

For example:

    configBasePath = /data/inlong
dataProxyGroup = inlong_test

Then the full path name of the local file is:

    /data/inlong/inlong_test.local

The file configuration content is (json format), where host is the address of the DataProxy server, and port is the corresponding port, which requires at least two configurations (the same two items can be configured):

    {"isInterVisit":1,"cluster_id":"1","size":1,"switch":1,"address":[{"host":"127.0.0.1","port":"46802"},{"host":"127.0.0.1","port":"46802"}]}

Send Message

    public void sendHttpMessage(HttpProxySender sender, String inlongGroupId,
String inlongStreamId, String messageBody) throws Exception {
List<String> bodyList = new ArrayList<>();
bodyList.add(messageBody);
sender.asyncSendMessage(bodyList, inlongGroupId, inlongStreamId, System.currentTimeMillis(),
20, TimeUnit.SECONDS, new MyMessageCallBack());
}

The parameter description is as follows:

parameter nametypeinstruction
senderHttpProxySenderThe sender created in the first step
inlongGroupIdStringinglongGroupId
inlongStreamIdStringinlongStreamId
messageBodyStringSent message content

UDP Example

inlong-dataproxy-sdk does not support sending messages of UDP protocol. If users need it, they need to assemble them according to the message assembly method in SDK. Organize binary arrays and send them in upd mode. For specific examples, refer to the relevant example codes in inlong-sdk/dataporxy-sdk.