com.amazonaws.services.schemaregistry.kafkaconnect.avrodata.CompatibilityChecker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of schema-registry-kafkaconnect-converter Show documentation
The AWS Glue Schema Registry Kafka Connect Converter enables Java developers to easily integrate their Kafka Connect applications with AWS Glue Schema Registry
There is a newer version: 1.1.23
Show newest version
/*
 * Copyright 2018 Confluent Inc.
 * Portions Copyright 2020 Amazon.com, Inc. or its affiliates.
 * 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.
 */

package com.amazonaws.services.schemaregistry.kafkaconnect.avrodata;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class CompatibilityChecker {

    // Check if the new schema can be used to read data produced by the previous schema
    private static final SchemaValidator BACKWARD_VALIDATOR =
            new SchemaValidatorBuilder().canReadStrategy()
                    .validateLatest();
    public static final CompatibilityChecker BACKWARD_CHECKER = new CompatibilityChecker(
            BACKWARD_VALIDATOR);

    // Check if data produced by the new schema can be read by the previous schema
    private static final SchemaValidator FORWARD_VALIDATOR =
            new SchemaValidatorBuilder().canBeReadStrategy()
                    .validateLatest();
    public static final CompatibilityChecker FORWARD_CHECKER = new CompatibilityChecker(
            FORWARD_VALIDATOR);

    // Check if the new schema is both forward and backward compatible with the previous schema
    private static final SchemaValidator FULL_VALIDATOR =
            new SchemaValidatorBuilder().mutualReadStrategy()
                    .validateLatest();
    public static final CompatibilityChecker FULL_CHECKER = new CompatibilityChecker(FULL_VALIDATOR);

    // Check if the new schema can be used to read data produced by all earlier schemas
    private static final SchemaValidator BACKWARD_TRANSITIVE_VALIDATOR =
            new SchemaValidatorBuilder().canReadStrategy()
                    .validateAll();
    public static final CompatibilityChecker BACKWARD_TRANSITIVE_CHECKER = new CompatibilityChecker(
            BACKWARD_TRANSITIVE_VALIDATOR);

    // Check if data produced by the new schema can be read by all earlier schemas
    private static final SchemaValidator FORWARD_TRANSITIVE_VALIDATOR =
            new SchemaValidatorBuilder().canBeReadStrategy()
                    .validateAll();
    public static final CompatibilityChecker FORWARD_TRANSITIVE_CHECKER = new CompatibilityChecker(
            FORWARD_TRANSITIVE_VALIDATOR);

    // Check if the new schema is both forward and backward compatible with all earlier schemas
    private static final SchemaValidator FULL_TRANSITIVE_VALIDATOR =
            new SchemaValidatorBuilder().mutualReadStrategy()
                    .validateAll();
    public static final CompatibilityChecker FULL_TRANSITIVE_CHECKER = new CompatibilityChecker(
            FULL_TRANSITIVE_VALIDATOR);

    private static final SchemaValidator NO_OP_VALIDATOR =
            (schema, schemas) -> Collections.emptyList();

    public static final CompatibilityChecker NO_OP_CHECKER =
            new CompatibilityChecker(NO_OP_VALIDATOR);

    private final SchemaValidator validator;

    private CompatibilityChecker(SchemaValidator validator) {
        this.validator = validator;
    }

    // visible for testing
    public List isCompatible(
            ParsedSchema newSchema, List previousSchemas
    ) {
        List previousSchemasCopy = new ArrayList<>(previousSchemas);
        // Validator checks in list order, but checks should occur in reverse chronological order
        Collections.reverse(previousSchemasCopy);
        return validator.validate(newSchema, previousSchemasCopy);
    }

    public static CompatibilityChecker checker(CompatibilityLevel level) {
        switch (level) {
            case NONE:
                return CompatibilityChecker.NO_OP_CHECKER;
            case BACKWARD:
                return CompatibilityChecker.BACKWARD_CHECKER;
            case BACKWARD_TRANSITIVE:
                return CompatibilityChecker.BACKWARD_TRANSITIVE_CHECKER;
            case FORWARD:
                return CompatibilityChecker.FORWARD_CHECKER;
            case FORWARD_TRANSITIVE:
                return CompatibilityChecker.FORWARD_TRANSITIVE_CHECKER;
            case FULL:
                return CompatibilityChecker.FULL_CHECKER;
            case FULL_TRANSITIVE:
                return CompatibilityChecker.FULL_TRANSITIVE_CHECKER;
            default:
                throw new IllegalArgumentException("Invalid level " + level);
        }
    }
}