Merge pull request #6663 from Malith-19/refactor-username-recovery-implementation

Refactor the username recovery related implementations.

Author: sadilchamishka

components/identity-mgt/org.wso2.carbon.identity.mgt.endpoint.util/src/main/java/org/wso2/carbon/identity/mgt/endpoint/util/client/api/RecoveryApiV2.java

@@ -86,7 +86,7 @@ public void setApiClient(ApiClient apiClient) {
     /**
      * Initiate recovering the forgotten username.
      *
-     * @param recoveryInitRequest Username recovery initiating request. (required)
+     * @param recoveryInitRequest Username recovery initiating request (required).
      * @param tenantDomain        Tenant Domain which user belongs. Default "carbon.super" (optional)
      * @param headers             If reCaptcha respond is found, embedded in request header. (optional)
      * @return Account recovery options response object.

components/idp-mgt/org.wso2.carbon.idp.mgt/src/main/java/org/wso2/carbon/idp/mgt/dao/IdPManagementDAO.java

@@ -6222,8 +6222,12 @@ private void performConfigCorrectionForUsernameRecoveryConfigs(Connection dbConn
                                                                    List<IdentityProviderProperty> idpProperties)
             throws SQLException {
 
-        // Enable all recovery options when Recovery.Notification.Username.Enable value is set as enabled.
-        // This keeps functionality consistent with previous API versions for migrating customers.
+        /*
+         Enable all recovery options when Recovery.Notification.Username.Enable value is true and
+         OnDemandConfig.OnInitialUse.EnableSMSUsernameRecoveryIfConnectorEnabled config is enabled in the toml.
+         This keeps functionality consistent with previous API versions for migrating customers.
+        */
+
         idpProperties.stream().filter(
                         idp -> IdPManagementConstants.
                                 EMAIL_USERNAME_RECOVERY_PROPERTY.equals(idp.getName())).findFirst()
@@ -6233,7 +6237,7 @@ private void performConfigCorrectionForUsernameRecoveryConfigs(Connection dbConn
                             IdentityProviderProperty identityProviderProperty = new IdentityProviderProperty();
                             identityProviderProperty.setName(
                                     IdPManagementConstants.EMAIL_USERNAME_RECOVERY_PROPERTY);
-                            identityProviderProperty.setValue("true");
+                            identityProviderProperty.setValue(String.valueOf(true));
                             idpProperties.add(identityProviderProperty);
                         });
         if (Boolean.parseBoolean(IdentityUtil.getProperty(ENABLE_SMS_USERNAME_RECOVERY_IF_CONNECTOR_ENABLED))) {
@@ -6246,7 +6250,7 @@ private void performConfigCorrectionForUsernameRecoveryConfigs(Connection dbConn
                                 IdentityProviderProperty identityProviderProperty = new IdentityProviderProperty();
                                 identityProviderProperty.setName(
                                         IdPManagementConstants.SMS_USERNAME_RECOVERY_PROPERTY);
-                                identityProviderProperty.setValue("true");
+                                identityProviderProperty.setValue(String.valueOf(true));
                                 idpProperties.add(identityProviderProperty);
                             });
         }

components/idp-mgt/org.wso2.carbon.idp.mgt/src/main/java/org/wso2/carbon/idp/mgt/util/IdPManagementUtil.java

@@ -380,11 +380,11 @@ public static void validatePasswordRecoveryWithCurrentAndPreviousConfigs(Map<Str
         }
     }
 
-
     /**
-     * This method is used to validate the username recovery property values.
+     * This method is used to validate the username recovery related property values.
      *
-     * @param configurationDetails Configuration updates for governance configuration.
+     * @param configurationDetails Configuration updates for governance configuration
+     * @throws IdentityProviderManagementClientException if configurations contain invalid configurations.
      */
     public static void validateUsernameRecoveryPropertyValues(Map<String, String> configurationDetails)
             throws IdentityProviderManagementClientException {
@@ -404,11 +404,12 @@ public static void validateUsernameRecoveryPropertyValues(Map<String, String> co
             boolean usernameRecoverySmsProperty = Boolean.parseBoolean(usernameRecoverySmsProp);
 
             if (usernameRecoveryProperty &&
-                    StringUtils.isNotBlank(usernameRecoveryEmailProp) && !usernameRecoveryEmailProperty &&
-                    StringUtils.isNotBlank(usernameRecoverySmsProp) && !usernameRecoverySmsProperty) {
-                // Disabling all recovery options when recovery connector is enabled is not allowed.
-                // WARNING : Be mindful about compatibility of earlier recovery api versions when changing
-                // this behaviour.
+                    !usernameRecoveryEmailProperty && StringUtils.isNotBlank(usernameRecoveryEmailProp) &&
+                    !usernameRecoverySmsProperty && StringUtils.isNotBlank(usernameRecoverySmsProp)) {
+                /*
+                 Disabling all recovery options when recovery connector is enabled is not allowed.
+                 WARNING : Be mindful about compatibility of earlier recovery api versions when changing this behaviour.
+                 */
                 throw IdPManagementUtil
                         .handleClientException(
                                 IdPManagementConstants.ErrorMessage.ERROR_CODE_INVALID_CONNECTOR_CONFIGURATION,
@@ -417,9 +418,11 @@ public static void validateUsernameRecoveryPropertyValues(Map<String, String> co
             }
             if (StringUtils.isNotBlank(usernameRecoveryProp) && !usernameRecoveryProperty &&
                     (usernameRecoveryEmailProperty || usernameRecoverySmsProperty)) {
-                // Enabling any recovery options when connector is disabled is not allowed.
-                // WARNING : Be mindful about compatibility of earlier recovery api versions when changing
-                // this behaviour.
+                /*
+                 Enabling any recovery options when connector is disabled is not allowed.
+                 WARNING : Be mindful about compatibility of earlier recovery api versions when changing this behaviour.
+                 */
+
                 throw IdPManagementUtil
                         .handleClientException(
                                 IdPManagementConstants.ErrorMessage.ERROR_CODE_INVALID_CONNECTOR_CONFIGURATION,