Feat: Send userAgent with client identity

This patch teaches session negotiation to send a user agent of the
form "com.bloomberg.bmq(javaXX.YY.ZZ):AA.BB.CC", where "XX.YY.ZZ" is
the version of Java this SDK is running on, and "AA.BB.CC" is the SDK
version.

It additionally sets the user agent to in the `PlainConsumerIT` and
`PlainProducerIT` integration test clients to different strings.
These clients are not simple users of this SDK, and construct the
sockets they communicate on directly.  It is thus useful to
distinguish them on the broker from normal users of the SDK.

Signed-off-by: Patrick M. Niedzielski <pniedzielski@bloomberg.net>

Author: pniedzielski

bmq-sdk/src/main/java/com/bloomberg/bmq/impl/TcpBrokerConnection.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Bloomberg Finance L.P.
+ * Copyright 2022-2025 Bloomberg Finance L.P.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -373,9 +373,16 @@ private NegotiationMessageChoice createNegoMsg() {
         clientIdentity.setClusterName("");
         clientIdentity.setClusterNodeId(-1);
         clientIdentity.setSdkLanguage(ClientLanguage.E_JAVA);
+        clientIdentity.setUserAgent(constructUserAgent());
         return negoMsgChoice;
     }
 
+    private String constructUserAgent() {
+        String javaVersion = "java" + SystemUtil.getJavaVersionString();
+        String sdkVersion  = VersionUtil.getSdkVersion();
+        return "com.bloomberg.bmq(" + javaVersion + "):" + sdkVersion;
+    }
+
     private WriteStatus negotiate() throws IOException {
         if (negotiationMsg == null) {
             negotiationMsg = createNegoMsg();

bmq-sdk/src/main/java/com/bloomberg/bmq/impl/infr/msg/ClientIdentity.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Bloomberg Finance L.P.
+ * Copyright 2022-2025 Bloomberg Finance L.P.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,6 +27,7 @@ public class ClientIdentity {
     private String clusterName;
     private Integer clusterNodeId;
     private ClientLanguage sdkLanguage;
+    private String userAgent;
 
     public ClientIdentity() {
         init();
@@ -48,6 +49,7 @@ private void init() {
         clusterName = "";
         clusterNodeId = -1;
         sdkLanguage = ClientLanguage.E_UNKNOWN;
+        userAgent = "";
     }
 
     public Integer protocolVersion() {
@@ -138,6 +140,14 @@ public void setSdkLanguage(ClientLanguage value) {
         sdkLanguage = value;
     }
 
+    public String userAgent() {
+        return userAgent;
+    }
+
+    public void setUserAgent(String value) {
+        userAgent = value;
+    }
+
     public Object createNewInstance() {
         return new ClientIdentity();
     }

bmq-sdk/src/main/java/com/bloomberg/bmq/impl/infr/util/SystemUtil.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Bloomberg Finance L.P.
+ * Copyright 2022-2025 Bloomberg Finance L.P.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -48,7 +48,7 @@ public static JavaVersion getJavaVersion() {
         JavaVersion result = JavaVersion.JAVA_UNSUPPORTED;
 
         try {
-            String version = System.getProperty("java.version");
+            String version = getJavaVersionString();
 
             result =
                     Arrays.stream(JavaVersion.values())
@@ -63,6 +63,10 @@ public static JavaVersion getJavaVersion() {
         return result;
     }
 
+    public static String getJavaVersionString() {
+        return System.getProperty("java.version");
+    }
+
     public static int getProcessId() {
         int pid = 0;
         String vmname = null;

bmq-sdk/src/test/java/com/bloomberg/bmq/impl/infr/codec/JsonDecoderUtilTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Bloomberg Finance L.P.
+ * Copyright 2022-2025 Bloomberg Finance L.P.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -84,6 +84,7 @@ void testDecodeClientIdentity() throws IOException {
         assertEquals("", ci.features());
         assertEquals("", ci.clusterName());
         assertEquals("E_JAVA", ci.sdkLanguage().toString());
+        assertEquals("user_agent", ci.userAgent());
     }
 
     @Test
@@ -128,6 +129,7 @@ void testDecodeBrokerResponse() throws IOException {
         assertEquals("", ci.features());
         assertEquals("cluster_name", ci.clusterName());
         assertEquals("E_JAVA", ci.sdkLanguage().toString());
+        assertEquals("user_agent", ci.userAgent());
     }
 
     @Test

bmq-sdk/src/test/java/com/bloomberg/bmq/impl/infr/proto/SchemaEventImplBuilderTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Bloomberg Finance L.P.
+ * Copyright 2022-2025 Bloomberg Finance L.P.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -61,6 +61,7 @@ void testBuildClientIdentityJson() throws IOException {
         clientIdentity.setClusterName("");
         clientIdentity.setClusterNodeId(-1);
         clientIdentity.setSdkLanguage(ClientLanguage.E_JAVA);
+        clientIdentity.setUserAgent("user_agent");
 
         ByteBuffer[] message;
         SchemaEventBuilder schemaBuilder = new SchemaEventBuilder();
@@ -93,6 +94,7 @@ void testBuildBrokerResponseJson() throws IOException {
         clientIdentity.setClusterNodeId(-1);
         clientIdentity.setClusterName("cluster_name");
         clientIdentity.setSdkLanguage(ClientLanguage.E_JAVA);
+        clientIdentity.setUserAgent("user_agent");
 
         ByteBuffer[] message;
         SchemaEventBuilder schemaBuilder = new SchemaEventBuilder();

bmq-sdk/src/test/java/com/bloomberg/bmq/it/PlainConsumerIT.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Bloomberg Finance L.P.
+ * Copyright 2022-2025 Bloomberg Finance L.P.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -115,6 +115,7 @@ public static ByteBuffer[] getLastMessage(int port, Uri uri)
         clientIdentity.setClusterName("");
         clientIdentity.setClusterNodeId(-1);
         clientIdentity.setSdkLanguage(ClientLanguage.E_JAVA);
+        clientIdentity.setUserAgent("com.bloomberg.bmq.it.PlainConsumerIT");
 
         SchemaEventBuilder schemaBuilder = new SchemaEventBuilder();
 

bmq-sdk/src/test/java/com/bloomberg/bmq/it/PlainProducerIT.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Bloomberg Finance L.P.
+ * Copyright 2022-2025 Bloomberg Finance L.P.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -117,6 +117,7 @@ public static void sendMessage(
         clientIdentity.setClusterName("");
         clientIdentity.setClusterNodeId(-1);
         clientIdentity.setSdkLanguage(ClientLanguage.E_JAVA);
+        clientIdentity.setUserAgent("com.bloomberg.bmq.it.PlainProducerIT");
 
         SchemaEventBuilder schemaBuilder = new SchemaEventBuilder();