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.databind.io;
28
29 import gov.nist.secauto.metaschema.core.configuration.AbstractConfigurationFeature;
30 import gov.nist.secauto.metaschema.core.model.IAssemblyDefinition;
31
32 import edu.umd.cs.findbugs.annotations.NonNull;
33
34 public final class DeserializationFeature<V>
35 extends AbstractConfigurationFeature<V> {
36 public static final int YAML_CODEPOINT_LIMIT_DEFAULT = Integer.MAX_VALUE - 1; // 2 GB
37 public static final int FORMAT_DETECTION_LOOKAHEAD = 32_768; // 2 GB
38
39 /**
40 * If enabled, perform constraint validation on the deserialized bound objects.
41 */
42 @NonNull
43 public static final DeserializationFeature<Boolean> DESERIALIZE_VALIDATE_CONSTRAINTS
44 = new DeserializationFeature<>(Boolean.class, true);
45
46 /**
47 * If enabled, process the next JSON node as a field, whose name must match the
48 * {@link IAssemblyDefinition#getRootJsonName()}. If not enabled, the next JSON
49 * node is expected to be an object containing the data of the
50 * {@link IAssemblyDefinition}.
51 */
52 public static final DeserializationFeature<Boolean> DESERIALIZE_JSON_ROOT_PROPERTY
53 = new DeserializationFeature<>(Boolean.class, true);
54
55 /**
56 * Determines the max YAML codepoints that can be read.
57 */
58 @NonNull
59 public static final DeserializationFeature<Integer> YAML_CODEPOINT_LIMIT
60 = new DeserializationFeature<>(Integer.class, YAML_CODEPOINT_LIMIT_DEFAULT);
61
62 /**
63 * Determines how many bytes can be looked at to identify the format of a
64 * document.
65 */
66 @NonNull
67 public static final DeserializationFeature<Integer> FORMAT_DETECTION_LOOKAHEAD_LIMIT
68 = new DeserializationFeature<>(Integer.class, FORMAT_DETECTION_LOOKAHEAD);
69
70 private DeserializationFeature(
71 @NonNull Class<V> valueClass,
72 @NonNull V defaultValue) {
73 super(valueClass, defaultValue);
74 }
75 }