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.schema;
28
29 import com.fasterxml.jackson.databind.node.ObjectNode;
30
31 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
32 import gov.nist.secauto.metaschema.schemagen.json.impl.JsonGenerationState;
33
34 import edu.umd.cs.findbugs.annotations.NonNull;
35
36 /**
37 * A type of {@link IJsonSchema} that can represent a schema that is a global
38 * definition.
39 * <p>
40 * A schema of this type will be a global definition if
41 * {@link #isInline(JsonGenerationState)} is {@code false}.
42 */
43 public interface IDefineableJsonSchema extends IJsonSchema {
44 /**
45 * Determine if the JSON schema object is a definition.
46 *
47 * @param state
48 * the schema generation state used for context and writing
49 * @return {@code true} if the SON schema object is a definition or
50 * {@code false} otherwise
51 */
52 default boolean isDefinition(@NonNull JsonGenerationState state) {
53 return !isInline(state);
54 }
55
56 /**
57 * Get the definition's name.
58 *
59 * @param state
60 * the schema generation state used for context and writing
61 * @return the definition name
62 * @throws IllegalStateException
63 * if the JSON schema object is not a definition
64 */
65 @NonNull
66 String getDefinitionName(@NonNull JsonGenerationState state);
67
68 /**
69 * Get the definition's reference URI.
70 *
71 * @param state
72 * the schema generation state used for context and writing
73 * @return the definition's reference URI
74 * @throws IllegalStateException
75 * if the JSON schema object is not a definition
76 */
77 default String getDefinitionRef(@NonNull JsonGenerationState state) {
78 if (!isDefinition(state)) {
79 throw new IllegalStateException();
80 }
81
82 return ObjectUtils.notNull(new StringBuilder()
83 .append("#/definitions/")
84 .append(getDefinitionName(state))
85 .toString());
86 }
87
88 @Override
89 default void generateSchemaOrRef(@NonNull JsonGenerationState state, @NonNull ObjectNode obj) {
90 if (isDefinition(state)) {
91 obj.put("$ref", getDefinitionRef(state));
92 } else {
93 generateSchema(state, obj);
94 }
95 }
96
97 default void generateDefinition(@NonNull JsonGenerationState state, @NonNull ObjectNode definitionsObject) {
98 if (!isDefinition(state)) {
99 throw new IllegalStateException();
100 }
101
102 // create the definition property
103 ObjectNode definitionObj = ObjectUtils.notNull(
104 definitionsObject.putObject(getDefinitionName(state)));
105
106 // Add identifier, see usnistgov/metaschema#160
107 definitionObj.put("$id", getDefinitionRef(state));
108
109 // generate the definition object contents
110 generateSchema(state, definitionObj);
111 }
112 }