[Android] Support ICD LIT Device using commissionDevice (#33975)

joonhaengHeo · restyled-commits · web-flow · commit 306f22e6d5f1 · 2024-06-19T14:42:18.000Z
* Support ICD LIT Device using commissionDevice

* Restyled by google-java-format

* Restyled by clang-format

* Update commission method using Builder

* Restyled by whitespace

* Restyled by google-java-format

* Restyled by gn

* Remove warning message in java_controller

---------

Co-authored-by: Restyled.io &lt;commits@restyled.io&gt;
diff --git a/examples/java-matter-controller/java/src/com/matter/controller/commands/pairing/PairCodeCommand.kt b/examples/java-matter-controller/java/src/com/matter/controller/commands/pairing/PairCodeCommand.kt
@@ -18,19 +18,21 @@
 package com.matter.controller.commands.pairing
 
 import chip.devicecontroller.ChipDeviceController
+import chip.devicecontroller.CommissionParameters
 import com.matter.controller.commands.common.CredentialsIssuer
 
 class PairCodeCommand(val controller: ChipDeviceController, credsIssue: CredentialsIssuer?) :
   PairingCommand(controller, "code", credsIssue, PairingModeType.CODE, PairingNetworkType.NONE) {
   override fun runCommand() {
+    val commissionParams =
+      CommissionParameters.Builder().setNetworkCredentials(getWifiNetworkCredentials()).build()
     currentCommissioner()
       .pairDeviceWithCode(
         getNodeId(),
         getOnboardingPayload(),
         getDiscoverOnce(),
         getUseOnlyOnNetworkDiscovery(),
-        null,
-        getWifiNetworkCredentials(),
+        commissionParams
       )
     currentCommissioner().setCompletionListener(this)
     waitCompleteMs(getTimeoutMillis())
diff --git a/examples/java-matter-controller/java/src/com/matter/controller/commands/pairing/PairCodeThreadCommand.kt b/examples/java-matter-controller/java/src/com/matter/controller/commands/pairing/PairCodeThreadCommand.kt
@@ -18,6 +18,7 @@
 package com.matter.controller.commands.pairing
 
 import chip.devicecontroller.ChipDeviceController
+import chip.devicecontroller.CommissionParameters
 import com.matter.controller.commands.common.CredentialsIssuer
 
 class PairCodeThreadCommand(controller: ChipDeviceController, credsIssue: CredentialsIssuer?) :
@@ -29,14 +30,15 @@ class PairCodeThreadCommand(controller: ChipDeviceController, credsIssue: Creden
     PairingNetworkType.THREAD
   ) {
   override fun runCommand() {
+    val commissionParams =
+      CommissionParameters.Builder().setNetworkCredentials(getThreadNetworkCredentials()).build()
     currentCommissioner()
       .pairDeviceWithCode(
         getNodeId(),
         getOnboardingPayload(),
         getDiscoverOnce(),
         getUseOnlyOnNetworkDiscovery(),
-        null,
-        getThreadNetworkCredentials(),
+        commissionParams
       )
     currentCommissioner().setCompletionListener(this)
     waitCompleteMs(getTimeoutMillis())
diff --git a/examples/java-matter-controller/java/src/com/matter/controller/commands/pairing/PairCodeWifiCommand.kt b/examples/java-matter-controller/java/src/com/matter/controller/commands/pairing/PairCodeWifiCommand.kt
@@ -18,6 +18,7 @@
 package com.matter.controller.commands.pairing
 
 import chip.devicecontroller.ChipDeviceController
+import chip.devicecontroller.CommissionParameters
 import com.matter.controller.commands.common.CredentialsIssuer
 
 class PairCodeWifiCommand(controller: ChipDeviceController, credsIssue: CredentialsIssuer?) :
@@ -29,14 +30,15 @@ class PairCodeWifiCommand(controller: ChipDeviceController, credsIssue: Credenti
     PairingNetworkType.WIFI
   ) {
   override fun runCommand() {
+    val commissionParams =
+      CommissionParameters.Builder().setNetworkCredentials(getWifiNetworkCredentials()).build()
     currentCommissioner()
       .pairDeviceWithCode(
         getNodeId(),
         getOnboardingPayload(),
         getDiscoverOnce(),
         getUseOnlyOnNetworkDiscovery(),
-        null,
-        getWifiNetworkCredentials(),
+        commissionParams
       )
     currentCommissioner().setCompletionListener(this)
     waitCompleteMs(getTimeoutMillis())
diff --git a/src/controller/java/BUILD.gn b/src/controller/java/BUILD.gn
@@ -616,6 +616,7 @@ android_library("java") {
     "src/chip/devicecontroller/CSRInfo.java",
     "src/chip/devicecontroller/ChipCommandType.java",
     "src/chip/devicecontroller/ChipDeviceController.java",
+    "src/chip/devicecontroller/CommissionParameters.java",
     "src/chip/devicecontroller/CommissioningWindowStatus.java",
     "src/chip/devicecontroller/ConnectionFailureException.java",
     "src/chip/devicecontroller/ControllerParams.java",
diff --git a/src/controller/java/CHIPDeviceController-JNI.cpp b/src/controller/java/CHIPDeviceController-JNI.cpp
@@ -610,7 +610,8 @@ JNI_METHOD(void, setICDCheckInDelegate)(JNIEnv * env, jobject self, jlong handle
 }
 
 JNI_METHOD(void, commissionDevice)
-(JNIEnv * env, jobject self, jlong handle, jlong deviceId, jbyteArray csrNonce, jobject networkCredentials)
+(JNIEnv * env, jobject self, jlong handle, jlong deviceId, jbyteArray csrNonce, jobject networkCredentials,
+ jobject icdRegistrationInfo)
 {
     chip::DeviceLayer::StackLock lock;
     CHIP_ERROR err                           = CHIP_NO_ERROR;
@@ -624,6 +625,10 @@ JNI_METHOD(void, commissionDevice)
         err = wrapper->ApplyNetworkCredentials(commissioningParams, networkCredentials);
         VerifyOrExit(err == CHIP_NO_ERROR, err = CHIP_ERROR_INVALID_ARGUMENT);
     }
+
+    commissioningParams.SetICDRegistrationStrategy(ICDRegistrationStrategy::kBeforeComplete);
+    wrapper->ApplyICDRegistrationInfo(commissioningParams, icdRegistrationInfo);
+
     if (wrapper->GetDeviceAttestationDelegateBridge() != nullptr)
     {
         commissioningParams.SetDeviceAttestationDelegate(wrapper->GetDeviceAttestationDelegateBridge());
diff --git a/src/controller/java/src/chip/devicecontroller/ChipDeviceController.java b/src/controller/java/src/chip/devicecontroller/ChipDeviceController.java
@@ -32,6 +32,7 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.TimeZone;
+import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
 /** Controller to interact with the CHIP device. */
@@ -156,6 +157,8 @@ public void setICDCheckInDelegate(ICDCheckInDelegate delegate) {
     setICDCheckInDelegate(deviceControllerPtr, new ICDCheckInDelegateWrapper(delegate));
   }
 
+  /* This method was deprecated. Please use {@link ChipDeviceController.pairDevice(BluetoothGatt, int, long, long, CommissionParameters)}. */
+  @Deprecated
   public void pairDevice(
       BluetoothGatt bleServer,
       int connId,
@@ -165,6 +168,8 @@ public void pairDevice(
     pairDevice(bleServer, connId, deviceId, setupPincode, null, networkCredentials, null);
   }
 
+  /* This method was deprecated. Please use {@link ChipDeviceController.pairDevice(BluetoothGatt, int, long, long, CommissionParameters)}. */
+  @Deprecated
   public void pairDevice(
       BluetoothGatt bleServer,
       int connId,
@@ -176,6 +181,8 @@ public void pairDevice(
         bleServer, connId, deviceId, setupPincode, null, networkCredentials, registrationInfo);
   }
 
+  /* This method was deprecated. Please use {@link ChipDeviceController.pairDevice(BluetoothGatt, int, long, long, CommissionParameters)}. */
+  @Deprecated
   public void pairDevice(
       BluetoothGatt bleServer,
       int connId,
@@ -199,8 +206,10 @@ public void pairDevice(
    * @param icdRegistrationInfo the informations for ICD registration. For detailed information
    *     {@link ICDRegistrationInfo}. If this value is null when commissioning an ICD device, {@link
    *     CompletionListener.onICDRegistrationInfoRequired} is called to request the
-   *     ICDRegistrationInfo value.
+   *     ICDRegistrationInfo value. This method was deprecated. Please use {@link
+   *     ChipDeviceController.pairDevice(BluetoothGatt, int, long, long, CommissionParameters)}.
    */
+  @Deprecated
   public void pairDevice(
       BluetoothGatt bleServer,
       int connId,
@@ -209,6 +218,31 @@ public void pairDevice(
       @Nullable byte[] csrNonce,
       NetworkCredentials networkCredentials,
       @Nullable ICDRegistrationInfo icdRegistrationInfo) {
+    CommissionParameters params =
+        new CommissionParameters.Builder()
+            .setCsrNonce(csrNonce)
+            .setNetworkCredentials(networkCredentials)
+            .setICDRegistrationInfo(icdRegistrationInfo)
+            .build();
+    pairDevice(bleServer, connId, deviceId, setupPincode, params);
+  }
+
+  /**
+   * Pair a device connected through BLE.
+   *
+   * @param bleServer the BluetoothGatt representing the BLE connection to the device
+   * @param connId the BluetoothGatt Id representing the BLE connection to the device
+   * @param deviceId the node ID to assign to the device
+   * @param setupPincode the pincode for the device
+   * @param params Parameters representing commissioning arguments. see detailed in {@link
+   *     CommissionParameters}
+   */
+  public void pairDevice(
+      BluetoothGatt bleServer,
+      int connId,
+      long deviceId,
+      long setupPincode,
+      @Nonnull CommissionParameters params) {
     if (connectionId == 0) {
       connectionId = connId;
 
@@ -225,15 +259,16 @@ public void pairDevice(
           deviceId,
           connectionId,
           setupPincode,
-          csrNonce,
-          networkCredentials,
-          icdRegistrationInfo);
+          params.getCsrNonce(),
+          params.getNetworkCredentials(),
+          params.getICDRegistrationInfo());
     } else {
       Log.e(TAG, "Bluetooth connection already in use.");
       completionListener.onError(new Exception("Bluetooth connection already in use."));
     }
   }
 
+  /* This method was deprecated. Please use {@link ChipDeviceController.pairDeviceWithAddress(long, String, int, int, long, CommissionParameters)}. */
   public void pairDeviceWithAddress(
       long deviceId,
       String address,
@@ -258,8 +293,11 @@ public void pairDeviceWithAddress(
    * @param icdRegistrationInfo the informations for ICD registration. For detailed information
    *     {@link ICDRegistrationInfo}. If this value is null when commissioning an ICD device, {@link
    *     CompletionListener.onICDRegistrationInfoRequired} is called to request the
-   *     ICDRegistrationInfo value.
+   *     ICDRegistrationInfo value. This method was deprecated. Please use {@link
+   *     ChipDeviceController.pairDeviceWithAddress(long, String, int, int, long,
+   *     CommissionParameters)}.
    */
+  @Deprecated
   public void pairDeviceWithAddress(
       long deviceId,
       String address,
@@ -279,6 +317,42 @@ public void pairDeviceWithAddress(
         icdRegistrationInfo);
   }
 
+  /**
+   * Pair a device connected using IP Address.
+   *
+   * @param deviceId the node ID to assign to the device
+   * @param address IP Address of the connecting device
+   * @param port the port of the connecting device
+   * @param discriminator the discriminator for connecting device
+   * @param pinCode the pincode for connecting device
+   * @param params Parameters representing commissioning arguments. see detailed in {@link
+   *     CommissionParameters}
+   */
+  public void pairDeviceWithAddress(
+      long deviceId,
+      String address,
+      int port,
+      int discriminator,
+      long pinCode,
+      @Nonnull CommissionParameters params) {
+    if (params.getNetworkCredentials() != null) {
+      Log.e(TAG, "Invalid parameter : NetworkCredentials");
+      completionListener.onError(new Exception("Invalid parameter : NetworkCredentials"));
+      return;
+    }
+    pairDeviceWithAddress(
+        deviceControllerPtr,
+        deviceId,
+        address,
+        port,
+        discriminator,
+        pinCode,
+        params.getCsrNonce(),
+        params.getICDRegistrationInfo());
+  }
+
+  /* This method was deprecated. Please use {@link ChipDeviceController.pairDeviceWithCode(long, String, boolean, boolean, CommissionParameters)}. */
+  @Deprecated
   public void pairDeviceWithCode(
       long deviceId,
       String setupCode,
@@ -312,7 +386,11 @@ public void pairDeviceWithCode(
    *     {@link ICDRegistrationInfo}. If this value is null when commissioning an ICD device, {@link
    *     CompletionListener.onICDRegistrationInfoRequired} is called to request the
    *     ICDRegistrationInfo value.
+   *     <p>This method was deprecated. Please use {@link
+   *     ChipDeviceController.pairDeviceWithCode(long, String, boolean, boolean,
+   *     CommissionParameters)}.
    */
+  @Deprecated
   public void pairDeviceWithCode(
       long deviceId,
       String setupCode,
@@ -332,6 +410,34 @@ public void pairDeviceWithCode(
         icdRegistrationInfo);
   }
 
+  /**
+   * Pair a device connected using the scanned QR code or manual entry code.
+   *
+   * @param deviceId the node ID to assign to the device
+   * @param setupCode the scanned QR code or manual entry code
+   * @param discoverOnce the flag to enable/disable PASE auto retry mechanism
+   * @param useOnlyOnNetworkDiscovery the flag to indicate the commissionable device is available on
+   *     the network
+   * @param params Parameters representing commissioning arguments. see detailed in {@link
+   *     CommissionParameters}
+   */
+  public void pairDeviceWithCode(
+      long deviceId,
+      String setupCode,
+      boolean discoverOnce,
+      boolean useOnlyOnNetworkDiscovery,
+      @Nonnull CommissionParameters params) {
+    pairDeviceWithCode(
+        deviceControllerPtr,
+        deviceId,
+        setupCode,
+        discoverOnce,
+        useOnlyOnNetworkDiscovery,
+        params.getCsrNonce(),
+        params.getNetworkCredentials(),
+        params.getICDRegistrationInfo());
+  }
+
   public void establishPaseConnection(long deviceId, int connId, long setupPincode) {
     if (connectionId == 0) {
       connectionId = connId;
@@ -371,9 +477,12 @@ public void establishPaseConnection(long deviceId, String address, int port, lon
    *
    * @param deviceId the ID of the node to be commissioned
    * @param networkCredentials the credentials (Wi-Fi or Thread) to be provisioned
+   *     <p>This method was deprecated. Please use {@link
+   *     ChipDeviceController.commissionDevice(long, CommissionParameters)}.
    */
+  @Deprecated
   public void commissionDevice(long deviceId, @Nullable NetworkCredentials networkCredentials) {
-    commissionDevice(deviceControllerPtr, deviceId, /* csrNonce= */ null, networkCredentials);
+    commissionDevice(deviceControllerPtr, deviceId, /* csrNonce= */ null, networkCredentials, null);
   }
 
   /**
@@ -384,10 +493,31 @@ public void commissionDevice(long deviceId, @Nullable NetworkCredentials network
    * @param deviceId the ID of the node to be commissioned
    * @param csrNonce a nonce to be used for the CSR request
    * @param networkCredentials the credentials (Wi-Fi or Thread) to be provisioned
+   *     <p>This method was deprecated. Please use {@link
+   *     ChipDeviceController.commissionDevice(long, CommissionParameters)}.
    */
+  @Deprecated
   public void commissionDevice(
       long deviceId, @Nullable byte[] csrNonce, @Nullable NetworkCredentials networkCredentials) {
-    commissionDevice(deviceControllerPtr, deviceId, csrNonce, networkCredentials);
+    commissionDevice(deviceControllerPtr, deviceId, csrNonce, networkCredentials, null);
+  }
+
+  /**
+   * Initiates the automatic commissioning flow using the specified network credentials. It is
+   * expected that a secure session has already been established via {@link
+   * #establishPaseConnection(long, int, long)}.
+   *
+   * @param deviceId the ID of the node to be commissioned
+   * @param params Parameters representing commissioning arguments. see detailed in {@link
+   *     CommissionParameters}
+   */
+  public void commissionDevice(long deviceId, @Nonnull CommissionParameters params) {
+    commissionDevice(
+        deviceControllerPtr,
+        deviceId,
+        params.getCsrNonce(),
+        params.getNetworkCredentials(),
+        params.getICDRegistrationInfo());
   }
 
   /**
@@ -1498,7 +1628,8 @@ private native void commissionDevice(
       long deviceControllerPtr,
       long deviceId,
       @Nullable byte[] csrNonce,
-      @Nullable NetworkCredentials networkCredentials);
+      @Nullable NetworkCredentials networkCredentials,
+      @Nullable ICDRegistrationInfo icdRegistrationInfo);
 
   private native void continueCommissioning(
       long deviceControllerPtr, long devicePtr, boolean ignoreAttestationFailure);
diff --git a/src/controller/java/src/chip/devicecontroller/CommissionParameters.java b/src/controller/java/src/chip/devicecontroller/CommissionParameters.java

Original file line number	Diff line number	Diff line change
`@@ -610,7 +610,8 @@ JNI_METHOD(void, setICDCheckInDelegate)(JNIEnv * env, jobject self, jlong handle`
`610`	`610`	`}`
`611`	`611`
`612`	`612`	`JNI_METHOD(void, commissionDevice)`
`613`		`-(JNIEnv * env, jobject self, jlong handle, jlong deviceId, jbyteArray csrNonce, jobject networkCredentials)`
	`613`	`+(JNIEnv * env, jobject self, jlong handle, jlong deviceId, jbyteArray csrNonce, jobject networkCredentials,`
	`614`	`+ jobject icdRegistrationInfo)`
`614`	`615`	`{`
`615`	`616`	`chip::DeviceLayer::StackLock lock;`
`616`	`617`	`CHIP_ERROR err = CHIP_NO_ERROR;`
`@@ -624,6 +625,10 @@ JNI_METHOD(void, commissionDevice)`
`624`	`625`	`err = wrapper->ApplyNetworkCredentials(commissioningParams, networkCredentials);`
`625`	`626`	`VerifyOrExit(err == CHIP_NO_ERROR, err = CHIP_ERROR_INVALID_ARGUMENT);`
`626`	`627`	`}`
	`628`	`+`
	`629`	`+ commissioningParams.SetICDRegistrationStrategy(ICDRegistrationStrategy::kBeforeComplete);`
	`630`	`+ wrapper->ApplyICDRegistrationInfo(commissioningParams, icdRegistrationInfo);`
	`631`	`+`
`627`	`632`	`if (wrapper->GetDeviceAttestationDelegateBridge() != nullptr)`
`628`	`633`	`{`
`629`	`634`	`commissioningParams.SetDeviceAttestationDelegate(wrapper->GetDeviceAttestationDelegateBridge());`