Rename IEncrypitonKeyProvider to IKeyStoreEncryptionKeyProvider

src/main/java/org/commcare/util/EncryptionKeyHelper.java

@@ -18,7 +18,7 @@ public class EncryptionKeyHelper {
     public static final String CC_KEY_ALGORITHM_RSA = "RSA";
     public static final String CC_IN_MEMORY_ENCRYPTION_KEY_ALIAS = "cc-in-memory-encryption-key-alias";
 
-    private static IEncryptionKeyProvider encryptionKeyProvider = EncryptionKeyServiceProvider.getInstance().serviceImpl();
+    private static IKeyStoreEncryptionKeyProvider keyStoreEncryptionKeyProvider = KeyStoreEncryptionKeyServiceProvider.getInstance().serviceImpl();
 
     /**
      * Converts a Base64 encoded key into a SecretKey depending on the algorithm
@@ -46,16 +46,16 @@ public static EncryptionKeyAndTransformation getKey(String base64encodedKey)
     }
 
     public static boolean isKeyStoreAvailable() {
-        return encryptionKeyProvider != null &&
-                Security.getProvider(encryptionKeyProvider.getKeyStoreName()) != null;
+        return keyStoreEncryptionKeyProvider != null &&
+                Security.getProvider(keyStoreEncryptionKeyProvider.getKeyStoreName()) != null;
     }
 
     private static KeyStore keystoreSingleton = null;
 
     private static KeyStore getKeyStore() throws EncryptionKeyException {
         if (keystoreSingleton == null) {
             try {
-                keystoreSingleton = KeyStore.getInstance(encryptionKeyProvider.getKeyStoreName());
+                keystoreSingleton = KeyStore.getInstance(keyStoreEncryptionKeyProvider.getKeyStoreName());
                 keystoreSingleton.load(null);
             } catch (KeyStoreException | CertificateException | IOException |
                      NoSuchAlgorithmException e) {
@@ -92,13 +92,13 @@ public static EncryptionKeyAndTransformation retrieveKeyFromKeyStore(String keyA
                     key = ((KeyStore.SecretKeyEntry)keyEntry).getSecretKey();
                 }
             } else {
-                key = encryptionKeyProvider.generateCryptographicKeyInKeyStore(keyAlias, cryptographicOperation);
+                key = keyStoreEncryptionKeyProvider.generateCryptographicKeyInKeyStore(keyAlias, cryptographicOperation);
             }
         } catch (KeyStoreException| NoSuchAlgorithmException | UnrecoverableEntryException e) {
             throw new EncryptionKeyException("Error retrieving key from KeyStore: ", e);
         }
         if (key != null) {
-            return new EncryptionKeyAndTransformation(key, encryptionKeyProvider.getTransformationString());
+            return new EncryptionKeyAndTransformation(key, keyStoreEncryptionKeyProvider.getTransformationString());
         } else {
             throw new EncryptionKeyException("Key couldn't be found in the keyStore");
         }

src/main/java/org/commcare/util/IEncryptionKeyProvider.java → src/main/java/org/commcare/util/IKeyStoreEncryptionKeyProvider.java

@@ -8,7 +8,7 @@
  * @author avazirna
  */
 
-public interface IEncryptionKeyProvider {
+public interface IKeyStoreEncryptionKeyProvider {
 
     Key generateCryptographicKeyInKeyStore(String keyAlias,
                                            EncryptionHelper.CryptographicOperation cryptographicOperation)

src/main/java/org/commcare/util/KeyStoreEncryptionKeyServiceProvider.java

@@ -0,0 +1,36 @@
+package org.commcare.util;
+
+import java.util.ServiceLoader;
+
+/**
+ * Utility class responsible for finding implementations of IEncryptionKeyProvider during runtime
+ * and loading them in memory
+ *
+ * @author avazirna
+ */
+
+public class KeyStoreEncryptionKeyServiceProvider {
+    private static KeyStoreEncryptionKeyServiceProvider serviceProvider;
+    private ServiceLoader<IKeyStoreEncryptionKeyProvider> loader;
+
+    private KeyStoreEncryptionKeyServiceProvider() {
+        loader = ServiceLoader.load(IKeyStoreEncryptionKeyProvider.class);
+    }
+
+    public static KeyStoreEncryptionKeyServiceProvider getInstance() {
+        if (serviceProvider == null) {
+            serviceProvider = new KeyStoreEncryptionKeyServiceProvider();
+        }
+        return serviceProvider;
+    }
+
+    public IKeyStoreEncryptionKeyProvider serviceImpl() {
+        IKeyStoreEncryptionKeyProvider service = null;
+        if (loader.iterator().hasNext()) {
+            service = loader.iterator().next();
+        }
+
+        return service;
+    }
+}
+