aboutsummaryrefslogtreecommitdiffstats
path: root/utils/src/main/java/org/onap/policy/common/utils/coder/StandardValCoder.java
blob: 378254b886b5914a98be2ff42bf4cfdfde0a76f7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.common.utils.coder;

import com.worldturner.medeia.api.JsonSchemaVersion;
import com.worldturner.medeia.api.SchemaSource;
import com.worldturner.medeia.api.StringSchemaSource;
import com.worldturner.medeia.api.ValidationFailedException;
import com.worldturner.medeia.api.gson.MedeiaGsonApi;
import com.worldturner.medeia.schema.validation.SchemaValidator;
import java.io.Reader;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.Writer;
import lombok.NonNull;
import lombok.ToString;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Extension to the StandardCoder to support streaming validation
 * against a Draft-07 Json schema specification.
 */

@ToString
public class StandardValCoder extends StandardCoder {

    // The medeia-validator library integrates better than
    // other libraries considered with GSON, and therefore
    // the StandardCoder.

    private static final Logger logger = LoggerFactory.getLogger(StandardValCoder.class);

    private final MedeiaGsonApi validatorApi = new MedeiaGsonApi();
    private final SchemaValidator validator;

    /**
     * StandardCoder with validation.
     */
    public StandardValCoder(@NonNull String jsonSchema, @NonNull String name) {
        SchemaSource schemaSource =
                new StringSchemaSource(jsonSchema, JsonSchemaVersion.DRAFT07, null, name);
        this.validator = validatorApi.loadSchema(schemaSource);
    }

    @Override
    protected String toJson(@NonNull Object object) {
        StringWriter output = new StringWriter();
        toJson(output, object);
        return String.valueOf(output);
    }

    @Override
    protected void toJson(@NonNull Writer target, @NonNull Object object) {
        getGSON().toJson(object, object.getClass(), validatorApi.createJsonWriter(validator, target));
    }

    @Override
    protected <T> T fromJson(@NonNull Reader source, @NonNull Class<T> clazz) {
        return convertFromDouble(clazz, getGSON().fromJson(validatorApi.createJsonReader(validator, source), clazz));
    }

    @Override
    protected <T> T fromJson(String json, Class<T> clazz) {
        StringReader reader = new StringReader(json);
        return convertFromDouble(clazz, getGSON().fromJson(validatorApi.createJsonReader(validator, reader), clazz));
    }

    /**
     * Is the json conformant?.
     */
    public boolean isConformant(@NonNull String json) {
        try {
            conformance(json);
        } catch (CoderException e) {
            logger.info("JSON is not conformant to schema {}", e);
            return false;
        }
        return true;
    }

    /**
     * Check a json string for conformance against its schema definition.
     */
    public void conformance(@NonNull String json) throws CoderException {
        try {
            validatorApi.parseAll(validatorApi.createJsonReader(validator, new StringReader(json)));
        } catch (ValidationFailedException e) {
            throw new CoderException(e);
        }
    }
}