Merge branch 'feature/SHIBUI-701' of bitbucket.org:unicon/shib-idp-ui…

… into feature/SHIBUI-701
TIER · Nov 9, 2018 · c62258c · c62258c
2 parents 9c52f0c + 42fbab0
commit c62258c
Show file tree

Hide file tree

Showing 5 changed files with 160 additions and 3 deletions.
diff --git a/...ternet2/tier/shibboleth/admin/ui/controller/MetadataResolverUiDefinitionController.groovy b/...ternet2/tier/shibboleth/admin/ui/controller/MetadataResolverUiDefinitionController.groovy
@@ -0,0 +1,69 @@
+package edu.internet2.tier.shibboleth.admin.ui.controller
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation
+import edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocationRegistry
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.http.ResponseEntity
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+
+import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaLocationLookup.filesystemMetadataProviderSchema
+//import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaLocationLookup.localDynamicMetadataProviderSchema
+//import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaLocationLookup.dynamicHttpMetadataProviderSchema
+import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR
+import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType
+
+/**
+ * Controller implementing REST resource responsible for exposing structure definition for metadata resolvers user
+ * interface in terms of JSON schema.
+ *
+ * @author Dmitriy Kopylenko
+ * @author Bill Smith (wsmith@unicon.net)
+ */
+@RestController
+@RequestMapping('/api/ui/MetadataResolver')
+class MetadataResolverUiDefinitionController {
+
+    @Autowired
+    JsonSchemaResourceLocationRegistry jsonSchemaResourceLocationRegistry
+
+    JsonSchemaResourceLocation jsonSchemaLocation
+
+    @Autowired
+    ObjectMapper jacksonObjectMapper
+
+    @GetMapping(value = "/{resolverType}")
+    ResponseEntity<?> getUiDefinitionJsonSchema(@PathVariable String resolverType) {
+        switch (SchemaType.valueOf(resolverType)) {
+            case SchemaType.FILESYSTEM_METADATA_RESOLVER:
+                jsonSchemaLocation = filesystemMetadataProviderSchema(this.jsonSchemaResourceLocationRegistry)
+                break
+/*            case SchemaType.LOCAL_DYNAMIC_METADATA_RESOLVER:
+                jsonSchemaLocation = localDynamicMetadataProviderSchema(this.jsonSchemaResourceLocationRegistry)
+                break*/
+/*            case SchemaType.DYNAMIC_HTTP_METADATA_RESOLVER:
+                jsonSchemaLocation = dynamicHttpMetadataProviderSchema(this.jsonSchemaResourceLocationRegistry)
+                break*/
+            default:
+                throw new UnsupportedOperationException("Json schema for an unsupported metadata resolver (" + resolverType + ") was requested")
+        }
+        try {
+            def parsedJson = jacksonObjectMapper.readValue(this.jsonSchemaLocation.url, Map)
+            return ResponseEntity.ok(parsedJson)
+        }
+        catch (Exception e) {
+            e.printStackTrace()
+            return ResponseEntity.status(INTERNAL_SERVER_ERROR)
+                    .body([jsonParseError              : e.getMessage(),
+                           sourceUiSchemaDefinitionFile: this.jsonSchemaLocation.url])
+        }
+    }
+
+    @GetMapping(value = "/types")
+    ResponseEntity<?> getResolverTypes() {
+        return ResponseEntity.ok(SchemaType.getResolverTypes())
+    }
+}
diff --git a/...u/internet2/tier/shibboleth/admin/ui/configuration/JsonSchemaComponentsConfiguration.java b/...u/internet2/tier/shibboleth/admin/ui/configuration/JsonSchemaComponentsConfiguration.java
@@ -12,6 +12,9 @@
 import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.*;
 import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.ENTITY_ATTRIBUTES_FILTERS;
 import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.METADATA_SOURCES;
+import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.FILESYSTEM_METADATA_RESOLVER;
+//import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.LOCAL_DYNAMIC_METADATA_RESOLVER;
+//import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.DYNAMIC_HTTP_METADATA_RESOLVER;
 
 /**
  * @author Dmitriy Kopylenko
@@ -30,6 +33,21 @@ public class JsonSchemaComponentsConfiguration {
     @Setter
     private String entityAttributesFiltersUiSchemaLocation = "classpath:entity-attributes-filters-ui-schema.json";
 
+    //Configured via @ConfigurationProperties (using setter method) with 'shibui.filesystem-metadata-provider-ui-schema-location' property and
+    // default value set here if that property is not explicitly set in application.properties
+    @Setter
+    private String filesystemMetadataResolverUiSchemaLocation = "classpath:file-system-metadata-provider.schema.json";
+
+/* TODO: Will be added as part of SHIBUI-703
+    @Setter
+    private String localDynamicMetadataResolverUiSchemaLocation = "classpath:local-dynamic-metadata-provider.schema.json";
+*/
+
+/* TODO: Will be added as part of SHIBUI-704
+    @Setter
+    private String dynamicHttpMetadataResolverUiSchemaLocation = "classpath:dynamic-http-metadata-provider.schema.json";
+*/
+
     @Bean
     public JsonSchemaResourceLocationRegistry jsonSchemaResourceLocationRegistry(ResourceLoader resourceLoader, ObjectMapper jacksonMapper) {
         return JsonSchemaResourceLocationRegistry.inMemory()
@@ -44,7 +62,25 @@ public JsonSchemaResourceLocationRegistry jsonSchemaResourceLocationRegistry(Res
                         .resourceLoader(resourceLoader)
                         .jacksonMapper(jacksonMapper)
                         .detectMalformedJson(true)
+                        .build())
+                .register(FILESYSTEM_METADATA_RESOLVER, JsonSchemaLocationBuilder.with()
+                        .jsonSchemaLocation(filesystemMetadataResolverUiSchemaLocation)
+                        .resourceLoader(resourceLoader)
+                        .jacksonMapper(jacksonMapper)
+                        .detectMalformedJson(true)
                         .build());
+                /*.register(DYNAMIC_HTTP_METADATA_RESOLVER, JsonSchemaLocationBuilder.with()
+                        .jsonSchemaLocation(dynamicHttpMetadataResolverUiSchemaLocation)
+                        .resourceLoader(resourceLoader)
+                        .jacksonMapper(jacksonMapper)
+                        .detectMalformedJson(true)
+                        .build())
+                .register(LOCAL_DYNAMIC_METADATA_RESOLVER, JsonSchemaLocationBuilder.with()
+                        .jsonSchemaLocation(localDynamicMetadataResolverUiSchemaLocation)
+                        .resourceLoader(resourceLoader)
+                        .jacksonMapper(jacksonMapper)
+                        .detectMalformedJson(true)
+                        .build());*/
 
     }
 

diff --git a/...main/java/edu/internet2/tier/shibboleth/admin/ui/jsonschema/JsonSchemaLocationLookup.java b/...main/java/edu/internet2/tier/shibboleth/admin/ui/jsonschema/JsonSchemaLocationLookup.java
@@ -2,6 +2,9 @@
 
 import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.ENTITY_ATTRIBUTES_FILTERS;
 import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.METADATA_SOURCES;
+import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.FILESYSTEM_METADATA_RESOLVER;
+//import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.LOCAL_DYNAMIC_METADATA_RESOLVER;
+//import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.DYNAMIC_HTTP_METADATA_RESOLVER;
 
 /**
  * Utility methods for common JSON schema types lookups.
@@ -27,12 +30,37 @@ public static JsonSchemaResourceLocation metadataSourcesSchema(JsonSchemaResourc
      * Searches entity attributes filters JSON schema resource location object in the given location registry.
      *
      * @param resourceLocationRegistry
-     * @returnentity attributes filters JSON schema resource location object
+     * @return entity attributes filters JSON schema resource location object
      * @throws IllegalStateException if schema is not found in the given registry
      */
     public static JsonSchemaResourceLocation entityAttributesFiltersSchema(JsonSchemaResourceLocationRegistry resourceLocationRegistry) {
         return resourceLocationRegistry
                 .lookup(ENTITY_ATTRIBUTES_FILTERS)
                 .orElseThrow(() -> new IllegalStateException("JSON schema resource location for entity attributes filters is not registered."));
     }
+
+    /**
+     * Searches filesystem metadata resolver JSON schema resource location object in the given location registry.
+     *
+     * @param resourceLocationRegistry
+     * @return filesystem metadata resolver JSON schema resource location object
+     * @throws IllegalStateException if schema is not found in the given registry
+     */
+    public static JsonSchemaResourceLocation filesystemMetadataProviderSchema(JsonSchemaResourceLocationRegistry resourceLocationRegistry) {
+        return resourceLocationRegistry
+                .lookup(FILESYSTEM_METADATA_RESOLVER)
+                .orElseThrow(() -> new IllegalStateException("JSON schema resource location for filesystem metadata resolver is not registered."));
+    }
+
+/*    public static JsonSchemaResourceLocation localDynamicMetadataProviderSchema(JsonSchemaResourceLocationRegistry resourceLocationRegistry) {
+        return resourceLocationRegistry
+                .lookup(LOCAL_DYNAMIC_METADATA_RESOLVER)
+                .orElseThrow(() -> new IllegalStateException("JSON schema resource location for local dynamic metadata resolver is not registered."));
+    }*/
+
+/*    public static JsonSchemaResourceLocation dynamicHttpMetadataProviderSchema(JsonSchemaResourceLocationRegistry resourceLocationRegistry) {
+        return resourceLocationRegistry
+                .lookup(DYNAMIC_HTTP_METADATA_RESOLVER)
+                .orElseThrow(() -> new IllegalStateException("JSON schema resource location for dynamic http metadata resolver is not registered."));
+    }*/
 }
diff --git a/...in/java/edu/internet2/tier/shibboleth/admin/ui/jsonschema/JsonSchemaResourceLocation.java b/...in/java/edu/internet2/tier/shibboleth/admin/ui/jsonschema/JsonSchemaResourceLocation.java
@@ -9,7 +9,10 @@
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 /**
  * Encapsulates arbitrary JSON schema location.
@@ -91,6 +94,19 @@ public static JsonSchemaResourceLocation newSchemaLocation(String jsonSchemaLoca
     }
 
     public enum SchemaType {
-        METADATA_SOURCES, ENTITY_ATTRIBUTES_FILTERS
+        // common types
+        METADATA_SOURCES,
+
+        // filter types
+        ENTITY_ATTRIBUTES_FILTERS,
+
+         // resolver types
+        FILESYSTEM_METADATA_RESOLVER;
+//        LOCAL_DYNAMIC_METADATA_RESOLVER,
+//        DYNAMIC_HTTP_METADATA_RESOLVER;
+
+        public static List<String> getResolverTypes() {
+            return Stream.of(SchemaType.values()).map(SchemaType::name).filter(it -> it.endsWith("RESOLVER")).collect(Collectors.toList());
+        }
     }
 }
diff --git a/...h/admin/ui/controller/BadJSONMetadataSourcesUiDefinitionControllerIntegrationTests.groovy b/...h/admin/ui/controller/BadJSONMetadataSourcesUiDefinitionControllerIntegrationTests.groovy
@@ -13,6 +13,7 @@ import spock.lang.Specification
 
 import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.*
 import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.ENTITY_ATTRIBUTES_FILTERS
+import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.FILESYSTEM_METADATA_RESOLVER
 import static edu.internet2.tier.shibboleth.admin.ui.jsonschema.JsonSchemaResourceLocation.SchemaType.METADATA_SOURCES
 
 /**
@@ -50,12 +51,19 @@ class BadJSONMetadataSourcesUiDefinitionControllerIntegrationTests extends Speci
                     .jacksonMapper(jacksonMapper)
                     .detectMalformedJson(false)
                     .build())
-                    .register(ENTITY_ATTRIBUTES_FILTERS, JsonSchemaLocationBuilder.with()
+                //TODO Maybe we need a separate test config here so we don't have to define all of the locations?
+                .register(ENTITY_ATTRIBUTES_FILTERS, JsonSchemaLocationBuilder.with()
                     .jsonSchemaLocation('classpath:entity-attributes-filters-ui-schema.json')
                     .resourceLoader(resourceLoader)
                     .jacksonMapper(jacksonMapper)
                     .detectMalformedJson(false)
                     .build())
+                .register(FILESYSTEM_METADATA_RESOLVER, JsonSchemaLocationBuilder.with()
+                    .jsonSchemaLocation('classpath:file-system-metadata-provider.schema.json')
+                    .resourceLoader(resourceLoader)
+                    .jacksonMapper(jacksonMapper)
+                    .detectMalformedJson(false)
+                    .build())
         }
     }
 }