[INJIOB-1862] deprecate verifyCredentials and introduce verify method

verifyCredentials method has been deprecated because it is not extensible for future use cases of supporting different VC format's verification. To support this usecase new method has been introduced - verify(credential: String, credentialFormat: CredentialFormat): Boolean The introduction of the new method `verify` will be used further to identify the verification logic that needs to be applied over the `credential` based on the input `credentialFormat`, providing support for other credential formats (as per CredentialFormat constant exposed) Signed-off-by: KiruthikaJeyashankar <[email protected]>
mosip · Oct 9, 2024 · 4263031 · 4263031
1 parent 80aa456
commit 4263031
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 8 deletions.
diff --git a/...rifier/kotlin/vcverifier/src/main/java/io/mosip/vercred/vcverifier/CredentialsVerifier.kt b/...rifier/kotlin/vcverifier/src/main/java/io/mosip/vercred/vcverifier/CredentialsVerifier.kt
@@ -3,18 +3,26 @@ package io.mosip.vercred.vcverifier
 import android.util.Log
 import io.mosip.vercred.vcverifier.constants.CredentialFormat
 import io.mosip.vercred.vcverifier.credentialverifier.CredentialVerifierFactory
-import io.mosip.vercred.vcverifier.credentialverifier.types.LdpVcCredentialVerifier
-import io.mosip.vercred.vcverifier.utils.Util
 
 
 class CredentialsVerifier {
     private val tag: String = CredentialsVerifier::class.java.name
 
+    /**
+     * @deprecated This method has been deprecated because it is not extensible for future use cases of supporting different VC format's verification
+     * Please use verify(credentials: String, format: CredentialFormat) instead, which is designed for supporting different VC formats.
+     */
+    @Deprecated("This method has been deprecated because it is not extensible for future use cases of supporting different VC format's verification")
     fun verifyCredentials(credentials: String?): Boolean {
         if(credentials==null){
             Log.e(tag, "Error - Input credential is null")
             throw RuntimeException("Input credential is null")
         }
         return CredentialVerifierFactory().verify(credentials,CredentialFormat.LDP_VC)
     }
+
+
+    fun verify(credential: String, credentialFormat: CredentialFormat): Boolean {
+        return CredentialVerifierFactory().verify(credential,credentialFormat)
+    }
 }
diff --git a/...kotlin/vcverifier/src/main/java/io/mosip/vercred/vcverifier/constants/CredentialFormat.kt b/...kotlin/vcverifier/src/main/java/io/mosip/vercred/vcverifier/constants/CredentialFormat.kt
@@ -2,5 +2,4 @@ package io.mosip.vercred.vcverifier.constants
 
 enum class CredentialFormat(val value: String) {
     LDP_VC("ldp_vc"),
-    MSO_MDOC("mso_mdoc"),
 }
diff --git a/...src/main/java/io/mosip/vercred/vcverifier/credentialverifier/CredentialVerifierFactory.kt b/...src/main/java/io/mosip/vercred/vcverifier/credentialverifier/CredentialVerifierFactory.kt
@@ -4,10 +4,11 @@ import io.mosip.vercred.vcverifier.constants.CredentialFormat
 import io.mosip.vercred.vcverifier.credentialverifier.types.LdpVcCredentialVerifier
 
 class CredentialVerifierFactory {
-    fun verify(credentials: String, credentialFormat: CredentialFormat): Boolean {
-        if (credentialFormat == CredentialFormat.LDP_VC) {
-            return LdpVcCredentialVerifier().verify(credentials)
+    fun verify(credential: String, credentialFormat: CredentialFormat): Boolean {
+        return when (credentialFormat) {
+            CredentialFormat.LDP_VC -> LdpVcCredentialVerifier().verify(
+                credential = credential
+            )
         }
-        return false
     }
 }
diff --git a/...er/kotlin/vcverifier/src/test/java/io/mosip/vercred/vcverifier/CredentialsVerifierTest.kt b/...er/kotlin/vcverifier/src/test/java/io/mosip/vercred/vcverifier/CredentialsVerifierTest.kt