add javadoc

quarkusio · Jan 30, 2025 · 0ab88e3 · 0ab88e3
1 parent b582013
commit 0ab88e3
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/extensions/tls-registry/runtime/src/main/java/io/quarkus/tls/runtime/KeyStoreProvider.java b/extensions/tls-registry/runtime/src/main/java/io/quarkus/tls/runtime/KeyStoreProvider.java
@@ -2,7 +2,17 @@
 
 import io.vertx.core.Vertx;
 
+/**
+ * An interface for providing {@link KeyStoreAndKeyCertOptions} dynamically from CDI beans
+ */
+@FunctionalInterface
 public interface KeyStoreProvider {
 
+    /**
+     * Returns the keystore and options to be used for [re]loading the state of a TLS configuration
+     *
+     * @param vertx the managed vertx instance
+     * @return the keystore and options
+     */
     KeyStoreAndKeyCertOptions getKeyStore(Vertx vertx);
 }
diff --git a/extensions/tls-registry/runtime/src/main/java/io/quarkus/tls/runtime/TrustStoreProvider.java b/extensions/tls-registry/runtime/src/main/java/io/quarkus/tls/runtime/TrustStoreProvider.java
@@ -2,7 +2,17 @@
 
 import io.vertx.core.Vertx;
 
+/**
+ * An interface for providing {@link TrustStoreAndTrustOptions} dynamically from CDI beans
+ */
+@FunctionalInterface
 public interface TrustStoreProvider {
 
+    /**
+     * Returns the truststore and options to be used for [re]loading the state of a TLS configuration
+     *
+     * @param vertx the managed vertx instance
+     * @return the truststore and options
+     */
     TrustStoreAndTrustOptions getTrustStore(Vertx vertx);
 }