added javadoc

eclipse-edc · Jan 13, 2024 · cea9cbb · cea9cbb
1 parent 43342d1
commit cea9cbb
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/...ub-credentials/src/main/java/org/eclipse/edc/identityhub/core/LocalPublicKeySupplier.java b/...ub-credentials/src/main/java/org/eclipse/edc/identityhub/core/LocalPublicKeySupplier.java
@@ -31,6 +31,12 @@
 import static org.eclipse.edc.identityhub.core.CoreServicesExtension.PUBLIC_KEY_VAULT_ALIAS_PROPERTY;
 
 
+/**
+ * Provides a public key, that is resolved from the vault, a file (using the path) or a raw string, in that sequence.
+ * Typically, we use this when we have a public key configured for the STS service, so we can verify access tokens created by it. 
+ * <p>
+ * It is NOT intended for general use when resolving arbitrary public keys!
+ * /
 public class LocalPublicKeySupplier implements Supplier<PublicKey> {
     public static final String NO_PUBLIC_KEY_CONFIGURED_ERROR = "No public key was configured! Please either configure '%s', '%s' or '%s'."
             .formatted(PUBLIC_KEY_VAULT_ALIAS_PROPERTY, PUBLIC_KEY_PATH_PROPERTY, PUBLIC_KEY_VAULT_ALIAS_PROPERTY);