SHIBUI-521(622) wip

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/resolvers/MetadataResolverValidationService.java

@@ -6,6 +6,14 @@
 import java.util.List;
 import java.util.Optional;
 
+/**
+ * A facade that aggregates {@link MetadataResolverValidator}s available to call just one of them supporting the type of a given resolver.
+ * If no {@link MetadataResolverValidator}s are configured, conciders provided MetadataResolver as valid.
+ * <p>
+ * Uses chain-of-responsibility design pattern
+ *
+ * @author Dmitriy Kopylenko
+ */
 public class MetadataResolverValidationService<T extends MetadataResolver> {
 
     private List<MetadataResolverValidator> validators;

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/resolvers/MetadataResolverValidator.java

@@ -1,5 +1,14 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain.resolvers;
 
+/**
+ * An SPI to validate different types of {@link MetadataResolver}s.
+ * <p>
+ * Typical usage is - multiple validators for concrete type of resolvers are configured in Spring Application Context,
+ * aggregated by {@link MetadataResolverValidationService} facade and then that facade is injected into upstream consumers of it
+ * such as REST controllers, etc.
+ *
+ * @author Dmitriy Kopylenko
+ */
 public interface MetadataResolverValidator<T extends MetadataResolver> {
 
     boolean supports(T resolver);