View Javadoc
1   /*
2    * Portions of this software was developed by employees of the National Institute
3    * of Standards and Technology (NIST), an agency of the Federal Government and is
4    * being made available as a public service. Pursuant to title 17 United States
5    * Code Section 105, works of NIST employees are not subject to copyright
6    * protection in the United States. This software may be subject to foreign
7    * copyright. Permission in the United States and in foreign countries, to the
8    * extent that NIST may hold copyright, to use, copy, modify, create derivative
9    * works, and distribute this software and its documentation without fee is hereby
10   * granted on a non-exclusive basis, provided that this notice and disclaimer
11   * of warranty appears in all copies.
12   *
13   * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14   * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15   * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17   * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18   * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
19   * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20   * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21   * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22   * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23   * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24   * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25   */
26  
27  package gov.nist.secauto.metaschema.schemagen.json.datatype;
28  
29  import com.fasterxml.jackson.databind.JsonNode;
30  import com.fasterxml.jackson.databind.ObjectMapper;
31  import com.fasterxml.jackson.databind.node.ObjectNode;
32  
33  import gov.nist.secauto.metaschema.core.model.xml.ModuleLoader;
34  import gov.nist.secauto.metaschema.core.util.CollectionUtil;
35  import gov.nist.secauto.metaschema.core.util.ObjectUtils;
36  import gov.nist.secauto.metaschema.schemagen.SchemaGenerationException;
37  import gov.nist.secauto.metaschema.schemagen.datatype.AbstractDatatypeManager;
38  
39  import java.io.IOException;
40  import java.io.InputStream;
41  import java.util.List;
42  import java.util.Map;
43  import java.util.Set;
44  import java.util.concurrent.ConcurrentHashMap;
45  import java.util.regex.Matcher;
46  import java.util.regex.Pattern;
47  import java.util.stream.Collectors;
48  import java.util.stream.Stream;
49  
50  import edu.umd.cs.findbugs.annotations.NonNull;
51  
52  public class JsonDatatypeManager
53      extends AbstractDatatypeManager {
54    private static final Map<String, List<String>> DATATYPE_DEPENDENCY_MAP = new ConcurrentHashMap<>();
55    private static final Pattern DEFINITION_REF_PATTERN = Pattern.compile("^#/definitions/(.+)$");
56    private static final Map<String, JsonNode> JSON_DATATYPES = new ConcurrentHashMap<>();
57  
58    static {
59      JsonNode jsonData;
60      try (InputStream is
61          = ModuleLoader.class.getResourceAsStream("/schema/json/metaschema-datatypes.json")) {
62        ObjectMapper objectMapper = new ObjectMapper();
63        jsonData = objectMapper.readTree(is);
64      } catch (IOException ex) {
65        throw new IllegalStateException(ex);
66      }
67  
68      // analyze datatypes for dependencies
69      for (String ref : getDatatypeTranslationMap().values()) {
70        JsonNode refNode = jsonData.at("/definitions/" + ref);
71        if (!refNode.isMissingNode()) {
72          JSON_DATATYPES.put(ref, refNode);
73  
74          List<String> dependencies = getDependencies(refNode).collect(Collectors.toList());
75          if (!dependencies.isEmpty()) {
76            DATATYPE_DEPENDENCY_MAP.put(ref, dependencies);
77          }
78        }
79      }
80    }
81  
82    private static Stream<String> getDependencies(@NonNull JsonNode node) {
83      Stream<String> retval = Stream.empty();
84      for (Map.Entry<String, JsonNode> entry : CollectionUtil.toIterable(ObjectUtils.notNull(node.fields()))) {
85        JsonNode value = entry.getValue();
86        assert value != null;
87        if ("$ref".equals(entry.getKey())) {
88          Matcher matcher = DEFINITION_REF_PATTERN.matcher(value.asText());
89          if (matcher.matches()) {
90            String dependency = matcher.group(1);
91            retval = Stream.concat(retval, Stream.of(dependency));
92          }
93        }
94  
95        if (value.isArray()) {
96          for (JsonNode child : CollectionUtil.toIterable(ObjectUtils.notNull(value.elements()))) {
97            assert child != null;
98            retval = Stream.concat(retval, getDependencies(child));
99          }
100       }
101     }
102     return retval;
103   }
104 
105   public void generateDatatypes(@NonNull ObjectNode definitionsObject) {
106     Set<String> requiredJsonDatatypes = getUsedTypes();
107     // resolve dependencies
108     for (String datatype : CollectionUtil.toIterable(ObjectUtils.notNull(
109         requiredJsonDatatypes.stream()
110             .flatMap(datatype -> {
111               Stream<String> result;
112               List<String> dependencies = DATATYPE_DEPENDENCY_MAP.get(datatype);
113               if (dependencies == null) {
114                 result = Stream.of(datatype);
115               } else {
116                 result = Stream.concat(Stream.of(datatype), dependencies.stream());
117               }
118               return result;
119             }).distinct()
120             .sorted()
121             .iterator()))) {
122 
123       JsonNode definition = JSON_DATATYPES.get(datatype);
124       if (definition == null) {
125         throw new SchemaGenerationException("Missing JSON datatype definition for: /definitions/" + datatype);
126       }
127       definitionsObject.set(datatype, definition);
128     }
129   }
130 
131 }