Fix PKCS12 API Name (#601)

* rename pkcs12 constructor * mark old function as deprecated * fix format
aws · Dec 4, 2024 · cd3c976 · cd3c976
1 parent bc6b5b0
commit cd3c976
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/documents/MQTT5_Userguide.md b/documents/MQTT5_Userguide.md
@@ -185,7 +185,7 @@ A MQTT5 direct connection can be made using a PKCS12 file rather than using a PE
 ~~~ java
 
 String clientEndpoint = "<prefix>-ats.iot.<region>.amazonaws.com";
-AwsIotMqtt5ClientBuilder builder = AwsIotMqtt5ClientBuilder.newDirectMqttBuilderWithMtlsFromPkcs11(clientEndpoint, "<PKCS12 file path>", "<PKCS12 password>");
+AwsIotMqtt5ClientBuilder builder = AwsIotMqtt5ClientBuilder.newDirectMqttBuilderWithMtlsFromPkcs12(clientEndpoint, "<PKCS12 file path>", "<PKCS12 password>");
 ~~~
 
 **Note**: Currently, TLS integration with PKCS12 is only available on MacOS devices.

diff --git a/samples/Mqtt5/PubSub/README.md b/samples/Mqtt5/PubSub/README.md
@@ -201,7 +201,7 @@ A MQTT5 direct connection can be made using a PKCS12 file rather than using a PE
 ~~~ java
 
 String clientEndpoint = "<prefix>-ats.iot.<region>.amazonaws.com";
-AwsIotMqtt5ClientBuilder builder = AwsIotMqtt5ClientBuilder.newDirectMqttBuilderWithMtlsFromPkcs11(clientEndpoint, "<PKCS12 file path>", "<PKCS12 password>");
+AwsIotMqtt5ClientBuilder builder = AwsIotMqtt5ClientBuilder.newDirectMqttBuilderWithMtlsFromPkcs12(clientEndpoint, "<PKCS12 file path>", "<PKCS12 password>");
 ~~~
 
 **Note**: Currently, TLS integration with PKCS12 is only available on MacOS devices.

diff --git a/sdk/src/main/java/software/amazon/awssdk/iot/AwsIotMqtt5ClientBuilder.java b/sdk/src/main/java/software/amazon/awssdk/iot/AwsIotMqtt5ClientBuilder.java
@@ -178,6 +178,7 @@ public static AwsIotMqtt5ClientBuilder newDirectMqttBuilderWithCustomAuth(String
     }
 
     /**
+     * @deprecated Use alternate newDirectMqttBuilderWithMtlsFromPkcs12().
      * Create a new builder with mTLS, using a PKCS12 library for private key operations.
      *
      * NOTE: MacOS only
@@ -187,7 +188,23 @@ public static AwsIotMqtt5ClientBuilder newDirectMqttBuilderWithCustomAuth(String
      * @param pkcs12Password The password of the PKCS12 file to use with the builder.
      * @return - A new AwsIotMqtt5ClientBuilder
      */
+    @Deprecated
     public static AwsIotMqtt5ClientBuilder newDirectMqttBuilderWithMtlsFromPkcs11(String hostName, String pkcs12Path, String pkcs12Password) {
+        return newDirectMqttBuilderWithMtlsFromPkcs12(hostName, pkcs12Path, pkcs12Password);
+    }
+
+
+    /**
+     * Create a new builder with mTLS, using a PKCS12 library for private key operations.
+     *
+     * NOTE: MacOS only
+     *
+     * @param hostName - AWS IoT endpoint to connect to
+     * @param pkcs12Path Path to the PKCS12 file to use with the builder.
+     * @param pkcs12Password The password of the PKCS12 file to use with the builder.
+     * @return - A new AwsIotMqtt5ClientBuilder
+     */
+    public static AwsIotMqtt5ClientBuilder newDirectMqttBuilderWithMtlsFromPkcs12(String hostName, String pkcs12Path, String pkcs12Password) {
         TlsContextOptions options = TlsContextOptions.createWithMtlsPkcs12(pkcs12Path, pkcs12Password);
         AwsIotMqtt5ClientBuilder builder = new AwsIotMqtt5ClientBuilder(hostName, DEFAULT_DIRECT_MQTT_PORT, options);
         options.close();