Adding Platform identification (#1004)

Author: rakshil14-2

…/awssdk/crt/iot/IoTDeviceSDKMetrics.java …amazon/awssdk/crt/iot/AWSIoTMetrics.javasrc/main/java/software/amazon/awssdk/crt/iot/IoTDeviceSDKMetrics.java renamed to src/main/java/software/amazon/awssdk/crt/iot/AWSIoTMetrics.java src/main/java/software/amazon/awssdk/crt/iot/IoTDeviceSDKMetrics.java renamed to src/main/java/software/amazon/awssdk/crt/iot/AWSIoTMetrics.java

@@ -25,10 +25,14 @@
  * Holds library identification and metadata entries that are appended
  * to the MQTT CONNECT packet username field.
  */
-public class IoTDeviceSDKMetrics {
+public class AWSIoTMetrics {
     private String libraryName;
     private List<IoTMetricsMetadata> metadataEntries;
 
+    // Library name constants
+    private static final String SDK_LIBRARY_NAME_JAVA = "IoTDeviceSDK/Java";
+    private static final String SDK_LIBRARY_NAME_ANDROID = "IoTDeviceSDK/Android";
+
     // Feature ID constants
     private static final String RETRY_JITTER_MODE = "A";
     private static final String SESSION_BEHAVIOR = "B";
@@ -44,12 +48,12 @@ public class IoTDeviceSDKMetrics {
 
     public static final int IOT_SDK_METRICS_FEATURE_VERSION = 1;
 
-    public IoTDeviceSDKMetrics() {
-        this.libraryName = "IoTDeviceSDK/Java";
+    public AWSIoTMetrics() {
+        this.libraryName = getDefaultLibraryName();
         this.metadataEntries = new ArrayList<>();
     }
 
-    public IoTDeviceSDKMetrics(String libraryName, List<IoTMetricsMetadata> metadataEntries) {
+    public AWSIoTMetrics(String libraryName, List<IoTMetricsMetadata> metadataEntries) {
         this.libraryName = libraryName;
         this.metadataEntries = metadataEntries;
     }
@@ -71,7 +75,7 @@ public IoTDeviceSDKMetrics(String libraryName, List<IoTMetricsMetadata> metadata
      * @param clientOptions MQTT5 client options containing connection configuration and user metrics
      * @return the merged metrics object ready to be passed to JNI
      */
-    public static IoTDeviceSDKMetrics createMetricsMqtt5(Mqtt5ClientOptions clientOptions) {
+    public static AWSIoTMetrics createMetricsMqtt5(Mqtt5ClientOptions clientOptions) {
         String crtFeatureList = getEncodedFeatureListMqtt5(clientOptions);
         return createMetrics(clientOptions.getUserMetrics(), crtFeatureList);
     }
@@ -85,7 +89,7 @@ public static IoTDeviceSDKMetrics createMetricsMqtt5(Mqtt5ClientOptions clientOp
      * @param config the MQTT3 connection configuration containing proxy, TLS, and user metrics
      * @return the merged metrics object ready to be passed to JNI
      */
-    public static IoTDeviceSDKMetrics createMetricsMqtt3(MqttConnectionConfig config) {
+    public static AWSIoTMetrics createMetricsMqtt3(MqttConnectionConfig config) {
         String crtFeatureList = getEncodedFeatureListMqtt3(config);
         return createMetrics(config.getMetrics(), crtFeatureList);
     }
@@ -250,8 +254,8 @@ private static String mergeFeatureLists(String crtFeatures, String userFeatures)
      * @param crtFeatureList encoded CRT feature list string
      * @return the final metrics object
      */
-    private static IoTDeviceSDKMetrics createMetrics(IoTDeviceSDKMetrics userMetrics, String crtFeatureList) {
-        String libraryName = (userMetrics != null) ? userMetrics.getLibraryName() : "IoTDeviceSDK/Java";
+    private static AWSIoTMetrics createMetrics(AWSIoTMetrics userMetrics, String crtFeatureList) {
+        String libraryName = (userMetrics != null) ? userMetrics.getLibraryName() : getDefaultLibraryName();
 
         String crtVersion = new PackageInfo().version.toString();
         LinkedHashMap<String, String> metadata = new LinkedHashMap<>();
@@ -285,7 +289,7 @@ private static IoTDeviceSDKMetrics createMetrics(IoTDeviceSDKMetrics userMetrics
             entries.add(new IoTMetricsMetadata(entry.getKey(), entry.getValue()));
         }
 
-        return new IoTDeviceSDKMetrics(libraryName, entries);
+        return new AWSIoTMetrics(libraryName, entries);
     }
 
     private static void parseFeatures(String featureStr, Map<String, String> map) {
@@ -306,6 +310,26 @@ private static String protocolVersionValue(boolean isMqtt5) {
         return isMqtt5 ? "5" : "3";
     }
 
+    /**
+     * Returns the default SDK library name for this platform.
+     *
+     * <p>Returns {@code "IoTDeviceSDK/Android"} when running on Android,
+     * {@code "IoTDeviceSDK/Java"} otherwise. Defaults to
+     * {@code "IoTDeviceSDK/Java"} if OS detection fails.
+     *
+     * @return the platform-appropriate default library name
+     */
+    private static String getDefaultLibraryName() {
+        try {
+            if ("android".equals(CRT.getOSIdentifier())) {
+                return SDK_LIBRARY_NAME_ANDROID;
+            }
+        } catch (Exception e) {
+            // fall through to default
+        }
+        return SDK_LIBRARY_NAME_JAVA;
+    }
+
     /**
      * @return {@code "B"} on Windows (IOCP), {@code "A"} otherwise (POSIX). Defaults to {@code "A"} if OS detection fails.
      */

src/main/java/software/amazon/awssdk/crt/mqtt/MqttClientConnection.java

@@ -17,7 +17,7 @@
 import software.amazon.awssdk.crt.mqtt5.Mqtt5Client;
 import software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions;
 import software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket;
-import software.amazon.awssdk.crt.iot.IoTDeviceSDKMetrics;
+import software.amazon.awssdk.crt.iot.AWSIoTMetrics;
 
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Consumer;
@@ -165,7 +165,7 @@ private void SetupConfig(MqttConnectionConfig config) throws MqttException {
             }
 
             if (!config.getDisableMetrics()) {
-                IoTDeviceSDKMetrics metrics = IoTDeviceSDKMetrics.createMetricsMqtt3(config);
+                AWSIoTMetrics metrics = AWSIoTMetrics.createMetricsMqtt3(config);
                 mqttClientConnectionSetMetrics(getNativeHandle(), metrics);
             }
 
@@ -509,7 +509,7 @@ private static native boolean mqttClientConnectionSetWill(long connection, Strin
     private static native void mqttClientConnectionSetLogin(long connection, String username, String password)
             throws CrtRuntimeException;
 
-    private static native void mqttClientConnectionSetMetrics(long connection, IoTDeviceSDKMetrics metrics)
+    private static native void mqttClientConnectionSetMetrics(long connection, AWSIoTMetrics metrics)
             throws CrtRuntimeException;
 
     private static native void mqttClientConnectionSetReconnectTimeout(long connection, long minTimeout,

src/main/java/software/amazon/awssdk/crt/mqtt/MqttConnectionConfig.java

@@ -9,7 +9,7 @@
 
 import software.amazon.awssdk.crt.CrtResource;
 import software.amazon.awssdk.crt.http.HttpProxyOptions;
-import software.amazon.awssdk.crt.iot.IoTDeviceSDKMetrics;
+import software.amazon.awssdk.crt.iot.AWSIoTMetrics;
 import software.amazon.awssdk.crt.io.ClientTlsContext;
 import software.amazon.awssdk.crt.io.SocketOptions;
 import software.amazon.awssdk.crt.mqtt5.Mqtt5Client;
@@ -51,7 +51,7 @@ public final class MqttConnectionConfig extends CrtResource {
 
     /* metrics */
     private boolean disableMetrics = false;
-    private IoTDeviceSDKMetrics metrics = null;
+    private AWSIoTMetrics metrics = null;
 
     public MqttConnectionConfig() {}
 
@@ -570,7 +570,7 @@ public boolean getDisableMetrics() {
      *
      * @param metrics metrics configuration from the IoT SDK layer
      */
-    public void setMetrics(IoTDeviceSDKMetrics metrics) {
+    public void setMetrics(AWSIoTMetrics metrics) {
         this.metrics = metrics;
     }
 
@@ -579,7 +579,7 @@ public void setMetrics(IoTDeviceSDKMetrics metrics) {
      *
      * @return metrics configuration, or null if not set
      */
-    public IoTDeviceSDKMetrics getMetrics() {
+    public AWSIoTMetrics getMetrics() {
         return metrics;
     }
 

src/main/java/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.java

@@ -12,7 +12,7 @@
 
 import software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket;
 import software.amazon.awssdk.crt.mqtt.MqttConnectionConfig;
-import software.amazon.awssdk.crt.iot.IoTDeviceSDKMetrics;
+import software.amazon.awssdk.crt.iot.AWSIoTMetrics;
 
 import java.util.Map;
 import java.util.function.Function;
@@ -49,8 +49,8 @@ public class Mqtt5ClientOptions {
     // Opt-out flag for AWS IoT Metrics. When true, metrics are disabled.
     // Default is false (metrics enabled).
     private boolean disableMetrics = false;
-    private IoTDeviceSDKMetrics userMetrics;
-    private IoTDeviceSDKMetrics iotDeviceSDKMetrics;
+    private AWSIoTMetrics userMetrics;
+    private AWSIoTMetrics awsIoTMetrics;
 
 
     /**
@@ -284,7 +284,7 @@ public boolean getDisableMetrics() {
      *
      * @return the user metrics, or null if none were provided
      */
-    public IoTDeviceSDKMetrics getUserMetrics() {
+    public AWSIoTMetrics getUserMetrics() {
         return this.userMetrics;
     }
 
@@ -327,9 +327,9 @@ public Mqtt5ClientOptions(Mqtt5ClientOptionsBuilder builder) {
         this.disableMetrics = builder.disableMetrics;
         this.userMetrics = builder.metrics;
         if (this.disableMetrics) {
-            this.iotDeviceSDKMetrics = null;
+            this.awsIoTMetrics = null;
         } else {
-            this.iotDeviceSDKMetrics = IoTDeviceSDKMetrics.createMetricsMqtt5(this);
+            this.awsIoTMetrics = AWSIoTMetrics.createMetricsMqtt5(this);
         }
     }
 
@@ -634,7 +634,7 @@ static final public class Mqtt5ClientOptionsBuilder {
         private PublishEvents publishEvents;
         private TopicAliasingOptions topicAliasingOptions;
         private boolean disableMetrics = false;
-        private IoTDeviceSDKMetrics metrics = null;
+        private AWSIoTMetrics metrics = null;
 
         /**
          * Sets the host name of the MQTT server to connect to.
@@ -921,7 +921,7 @@ public Mqtt5ClientOptionsBuilder withDisableMetrics(boolean disableMetrics) {
          * @param metrics metrics configuration from the IoT SDK layer
          * @return The Mqtt5ClientOptionsBuilder after setting the metrics
          */
-        public Mqtt5ClientOptionsBuilder withMetrics(IoTDeviceSDKMetrics metrics) {
+        public Mqtt5ClientOptionsBuilder withMetrics(AWSIoTMetrics metrics) {
             this.metrics = metrics;
             return this;
         }

src/main/resources/META-INF/native-image/software.amazon.awssdk/crt/aws-crt/jni-config.json

@@ -1268,7 +1268,7 @@
     ]
   },
   {
-    "name": "software.amazon.awssdk.crt.iot.IoTDeviceSDKMetrics",
+    "name": "software.amazon.awssdk.crt.iot.AWSIoTMetrics",
     "fields": [
       {
         "name": "libraryName"
@@ -1341,7 +1341,7 @@
         "name": "topicAliasingOptions"
       },
       {
-        "name": "iotDeviceSDKMetrics"
+        "name": "awsIoTMetrics"
       },
       {
         "name": "disableMetrics"

src/native/iot_device_sdk_metrics.c src/native/aws_iot_metrics.csrc/native/iot_device_sdk_metrics.c renamed to src/native/aws_iot_metrics.c

@@ -6,20 +6,20 @@
 /**
  * JNI bridge for IoT Device SDK Metrics.
  *
- * Converts a Java IoTDeviceSDKMetrics object (library name + metadata key-value
+ * Converts a Java AWSIoTMetrics object (library name + metadata key-value
  * entries) into a native aws_mqtt_iot_metrics struct that the C MQTT layer uses
  * to append SDK telemetry to the CONNECT packet username field.
  *
  */
 #include <jni.h>
 
-#include "iot_device_sdk_metrics.h"
+#include "aws_iot_metrics.h"
 #include "mqtt5_packets.h"
 #include <aws/mqtt/mqtt.h>
 #include <crt.h>
 #include <java_class_ids.h>
 
-static char s_iot_device_sdk_metrics_string[] = "IoTDeviceSDKMetrics";
+static char s_aws_iot_metrics_string[] = "AWSIoTMetrics";
 
 /* Frees all native memory associated with a parsed metrics struct. */
 void aws_mqtt_iot_metrics_java_jni_destroy(
@@ -31,7 +31,7 @@ void aws_mqtt_iot_metrics_java_jni_destroy(
     if (!java_metrics) {
         return;
     }
-    AWS_LOGF_DEBUG(AWS_LS_MQTT_GENERAL, "id=%p: Destroying IoTDeviceSDKMetrics", (void *)java_metrics);
+    AWS_LOGF_DEBUG(AWS_LS_MQTT_GENERAL, "id=%p: Destroying AWSIoTMetrics", (void *)java_metrics);
 
     /* Free the library name buffer */
     if (aws_byte_buf_is_valid(&java_metrics->library_name_buf)) {
@@ -58,19 +58,19 @@ void aws_mqtt_iot_metrics_java_jni_destroy(
     aws_mem_release(allocator, java_metrics);
 }
 
-/* Parses a Java IoTDeviceSDKMetrics object into a native metrics struct for the C MQTT layer. */
+/* Parses a Java AWSIoTMetrics object into a native metrics struct for the C MQTT layer. */
 struct aws_mqtt_iot_metrics_java_jni *aws_mqtt_iot_metrics_java_jni_create_from_java(
     JNIEnv *env,
     struct aws_allocator *allocator,
-    jobject java_iot_device_sdk_metrics) {
+    jobject java_aws_iot_metrics) {
 
     jobject metadata_list = NULL;
 
     /* Zero-initialize so all fields are safe for cleanup on any error path */
     struct aws_mqtt_iot_metrics_java_jni *java_metrics =
         aws_mem_calloc(allocator, 1, sizeof(struct aws_mqtt_iot_metrics_java_jni));
 
-    AWS_LOGF_DEBUG(AWS_LS_MQTT_GENERAL, "id=%p: Creating IoTDeviceSDKMetrics from Java object", (void *)java_metrics);
+    AWS_LOGF_DEBUG(AWS_LS_MQTT_GENERAL, "id=%p: Creating AWSIoTMetrics from Java object", (void *)java_metrics);
 
     /*
      * Extract the library name (e.g. "IoTDeviceSDK/Java").
@@ -79,25 +79,25 @@ struct aws_mqtt_iot_metrics_java_jni *aws_mqtt_iot_metrics_java_jni_create_from_
      */
     if (aws_get_string_from_jobject(
             env,
-            java_iot_device_sdk_metrics,
-            iot_device_sdk_metrics_properties.library_name_field_id,
-            s_iot_device_sdk_metrics_string,
+            java_aws_iot_metrics,
+            aws_iot_metrics_properties.library_name_field_id,
+            s_aws_iot_metrics_string,
             "library name",
             &java_metrics->library_name_buf,
             &java_metrics->metrics.library_name,
             false,
             NULL) == AWS_OP_ERR) {
-        AWS_LOGF_ERROR(AWS_LS_MQTT_GENERAL, "IoTDeviceSDKMetrics create_from_java: No library name found");
+        AWS_LOGF_ERROR(AWS_LS_MQTT_GENERAL, "AWSIoTMetrics create_from_java: No library name found");
         goto on_error;
     }
 
     /* Read the Java List<IoTMetricsMetadata> field */
-    metadata_list = (*env)->GetObjectField(
-        env, java_iot_device_sdk_metrics, iot_device_sdk_metrics_properties.metadata_entries_field_id);
+    metadata_list =
+        (*env)->GetObjectField(env, java_aws_iot_metrics, aws_iot_metrics_properties.metadata_entries_field_id);
 
     /* Null list is valid — return metrics with just library name */
     if (metadata_list == NULL || aws_jni_check_and_clear_exception(env)) {
-        AWS_LOGF_DEBUG(AWS_LS_MQTT_GENERAL, "id=%p: IoTDeviceSDKMetrics no metadata entries", (void *)java_metrics);
+        AWS_LOGF_DEBUG(AWS_LS_MQTT_GENERAL, "id=%p: AWSIoTMetrics no metadata entries", (void *)java_metrics);
         return java_metrics;
     }
 
@@ -106,7 +106,7 @@ struct aws_mqtt_iot_metrics_java_jni *aws_mqtt_iot_metrics_java_jni_create_from_
 
     /* Empty list is valid — return metrics with just library name */
     if (aws_jni_check_and_clear_exception(env) || count <= 0) {
-        AWS_LOGF_DEBUG(AWS_LS_MQTT_GENERAL, "id=%p: IoTDeviceSDKMetrics metadata list empty", (void *)java_metrics);
+        AWS_LOGF_DEBUG(AWS_LS_MQTT_GENERAL, "id=%p: AWSIoTMetrics metadata list empty", (void *)java_metrics);
         (*env)->DeleteLocalRef(env, metadata_list);
         return java_metrics;
     }
@@ -127,15 +127,15 @@ struct aws_mqtt_iot_metrics_java_jni *aws_mqtt_iot_metrics_java_jni_create_from_
         /* Call List.get(i) to get the IoTMetricsMetadata object */
         jobject entry = (*env)->CallObjectMethod(env, metadata_list, boxed_list_properties.list_get_id, i);
         if (!entry || aws_jni_check_and_clear_exception(env)) {
-            AWS_LOGF_ERROR(AWS_LS_MQTT_GENERAL, "IoTDeviceSDKMetrics: failed to get entry at index %d", (int)i);
+            AWS_LOGF_ERROR(AWS_LS_MQTT_GENERAL, "AWSIoTMetrics: failed to get entry at index %d", (int)i);
             (*env)->DeleteLocalRef(env, entry);
             goto on_error;
         }
 
         /* Read the key field. Empty string is allowed; null Java field is not. */
         jstring key_jstr = (jstring)(*env)->GetObjectField(env, entry, iot_metrics_metadata_properties.key_field_id);
         if (aws_jni_check_and_clear_exception(env) || !key_jstr) {
-            AWS_LOGF_ERROR(AWS_LS_MQTT_GENERAL, "IoTDeviceSDKMetrics: exception or null key at index %d", (int)i);
+            AWS_LOGF_ERROR(AWS_LS_MQTT_GENERAL, "AWSIoTMetrics: exception or null key at index %d", (int)i);
             (*env)->DeleteLocalRef(env, key_jstr);
             (*env)->DeleteLocalRef(env, entry);
             goto on_error;
@@ -145,7 +145,7 @@ struct aws_mqtt_iot_metrics_java_jni *aws_mqtt_iot_metrics_java_jni_create_from_
         jstring value_jstr =
             (jstring)(*env)->GetObjectField(env, entry, iot_metrics_metadata_properties.value_field_id);
         if (aws_jni_check_and_clear_exception(env) || !value_jstr) {
-            AWS_LOGF_ERROR(AWS_LS_MQTT_GENERAL, "IoTDeviceSDKMetrics: exception or null value at index %d", (int)i);
+            AWS_LOGF_ERROR(AWS_LS_MQTT_GENERAL, "AWSIoTMetrics: exception or null value at index %d", (int)i);
             (*env)->DeleteLocalRef(env, key_jstr);
             (*env)->DeleteLocalRef(env, value_jstr);
             (*env)->DeleteLocalRef(env, entry);
@@ -179,7 +179,7 @@ struct aws_mqtt_iot_metrics_java_jni *aws_mqtt_iot_metrics_java_jni_create_from_
 
         AWS_LOGF_DEBUG(
             AWS_LS_MQTT_GENERAL,
-            "IoTDeviceSDKMetrics: metadata[%d] key=\"" PRInSTR "\" value=\"" PRInSTR "\"",
+            "AWSIoTMetrics: metadata[%d] key=\"" PRInSTR "\" value=\"" PRInSTR "\"",
             (int)i,
             AWS_BYTE_CURSOR_PRI(java_metrics->metadata_entries[i].key),
             AWS_BYTE_CURSOR_PRI(java_metrics->metadata_entries[i].value));
@@ -195,7 +195,7 @@ struct aws_mqtt_iot_metrics_java_jni *aws_mqtt_iot_metrics_java_jni_create_from_
 
     AWS_LOGF_DEBUG(
         AWS_LS_MQTT_GENERAL,
-        "id=%p: IoTDeviceSDKMetrics creation complete, %d metadata entries",
+        "id=%p: AWSIoTMetrics creation complete, %d metadata entries",
         (void *)java_metrics,
         (int)count);
 

src/native/iot_device_sdk_metrics.h src/native/aws_iot_metrics.hsrc/native/iot_device_sdk_metrics.h renamed to src/native/aws_iot_metrics.h

@@ -2,8 +2,8 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0.
  */
-#ifndef AWS_JNI_IOT_DEVICE_SDK_METRICS_H
-#define AWS_JNI_IOT_DEVICE_SDK_METRICS_H
+#ifndef AWS_JNI_AWS_IOT_METRICS_H
+#define AWS_JNI_AWS_IOT_METRICS_H
 
 #include <aws/mqtt/mqtt.h>
 #include <crt.h>
@@ -25,6 +25,6 @@ void aws_mqtt_iot_metrics_java_jni_destroy(
 struct aws_mqtt_iot_metrics_java_jni *aws_mqtt_iot_metrics_java_jni_create_from_java(
     JNIEnv *env,
     struct aws_allocator *allocator,
-    jobject java_iot_device_sdk_metrics);
+    jobject java_aws_iot_metrics);
 
-#endif /* AWS_JNI_IOT_DEVICE_SDK_METRICS_H */
+#endif /* AWS_JNI_AWS_IOT_METRICS_H */