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.yaml.impl;
28
29 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
30 import com.fasterxml.jackson.dataformat.yaml.YAMLFactoryBuilder;
31 import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
32
33 import gov.nist.secauto.metaschema.core.configuration.IConfiguration;
34 import gov.nist.secauto.metaschema.core.configuration.IMutableConfiguration;
35 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
36 import gov.nist.secauto.metaschema.databind.io.DeserializationFeature;
37 import gov.nist.secauto.metaschema.databind.io.SerializationFeature;
38 import gov.nist.secauto.metaschema.databind.io.json.JsonFactoryFactory;
39
40 import org.yaml.snakeyaml.LoaderOptions;
41
42 import edu.umd.cs.findbugs.annotations.NonNull;
43
44 public final class YamlFactoryFactory {
45 private YamlFactoryFactory() {
46 // disable construction
47 }
48
49 /**
50 * Create a new {@link YAMLFactory} configured to parse YAML.
51 *
52 * @param config
53 * the deserialization configuration
54 *
55 * @return the factory
56 */
57 @NonNull
58 public static YAMLFactory newParserFactoryInstance(
59 @NonNull IConfiguration<DeserializationFeature<?>> config) {
60 YAMLFactoryBuilder builder = YAMLFactory.builder();
61 LoaderOptions loaderOptions = builder.loaderOptions();
62 if (loaderOptions == null) {
63 loaderOptions = new LoaderOptions();
64 }
65
66 int codePointLimit = config.get(DeserializationFeature.YAML_CODEPOINT_LIMIT);
67 loaderOptions.setCodePointLimit(codePointLimit);
68 builder.loaderOptions(loaderOptions);
69
70 YAMLFactory retval = ObjectUtils.notNull(builder.build());
71 JsonFactoryFactory.configureJsonFactory(retval);
72 return retval;
73 }
74
75 /**
76 * Create a new {@link YAMLFactory} configured to generate YAML.
77 *
78 * @param config
79 * the serialization configuration
80 *
81 * @return the factory
82 */
83 @NonNull
84 public static YAMLFactory newGeneratorFactoryInstance(
85 @NonNull IMutableConfiguration<SerializationFeature<?>> config) {
86 YAMLFactoryBuilder builder = YAMLFactory.builder();
87 YAMLFactory retval = ObjectUtils.notNull(builder
88 .enable(YAMLGenerator.Feature.MINIMIZE_QUOTES)
89 .enable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER)
90 .enable(YAMLGenerator.Feature.ALWAYS_QUOTE_NUMBERS_AS_STRINGS)
91 .disable(YAMLGenerator.Feature.SPLIT_LINES)
92 .build());
93 JsonFactoryFactory.configureJsonFactory(retval);
94 return retval;
95 }
96 }