adding javadoc for discoverConfiguration method and DiscoveredConfigu…

…ration class
Evolveum · May 24, 2022 · eb96a07 · eb96a07
1 parent 53f81e5
commit eb96a07
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/...ing-api/src/main/java/com/evolveum/midpoint/provisioning/api/DiscoveredConfiguration.java b/...ing-api/src/main/java/com/evolveum/midpoint/provisioning/api/DiscoveredConfiguration.java
@@ -19,7 +19,9 @@
 import java.util.Set;
 
 /**
- * TODO
+ * Suggested configuration properties of connector.
+ * Contains collection of PrismProperties with suggested configuration properties.
+ * Collection is empty if connector can't determine any suggestions.
  */
 public class DiscoveredConfiguration implements Serializable, DebugDumpable {
 

diff --git a/...sioning-api/src/main/java/com/evolveum/midpoint/provisioning/api/ProvisioningService.java b/...sioning-api/src/main/java/com/evolveum/midpoint/provisioning/api/ProvisioningService.java
@@ -522,7 +522,14 @@ Object executeScript(String resourceOid, ProvisioningScriptType script, Task tas
     }
 
     /**
-     * TODO please document this method
+     * Discovers additional configuration properties. The resource object should contain minimal connector
+     * configuration properties to connect to the resource, then use the connection
+     * to discover additional configuration properties. Discovered configuration properties are returned
+     * from this method as Prism properties wrapped in DiscoveredConfiguration.
+     * DiscoveredConfiguration will be empty if it does not exist.
+     *
+     * @param resource resource with minimal connector configuration
+     * @return Suggested configuration properties wrapped in DiscoveredConfiguration.
      */
     @NotNull DiscoveredConfiguration discoverConfiguration(
             @NotNull PrismObject<ResourceType> resource, @NotNull OperationResult parentResult);