io.streamnative.pulsar.handlers.kop.schemaregistry.providers.avro.Difference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulsar-kafka-schema-registry Show documentation
Kafka Compatible Schema Registry
The newest version!
/**
 * Copyright (c) 2019 - 2024 StreamNative, Inc.. 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 io.streamnative.pulsar.handlers.kop.schemaregistry.providers.avro;

import org.apache.avro.SchemaCompatibility.Incompatibility;
import org.apache.avro.SchemaCompatibility.SchemaIncompatibilityType;

public class Difference {
    private final Incompatibility incompatibility;

    public Difference(final Incompatibility incompatibility) {
        this.incompatibility = incompatibility;
    }

    public String error() {
        SchemaIncompatibilityType errorType = incompatibility.getType();
        String path = incompatibility.getLocation();

        String errorDescription = "";
        switch (errorType) {
            case FIXED_SIZE_MISMATCH:
                errorDescription = "The size of FIXED type field at path '" + path + "' in the %s "
                    + "schema does not match with the %s schema";
                break;
            case TYPE_MISMATCH:
                errorDescription = "The type (path '" + path + "') of a field in the %s schema does "
                    + "not match with the %s schema";
                break;
            case NAME_MISMATCH:
                errorDescription = "The name of the schema has changed (path '" + path + "')";
                break;
            case MISSING_ENUM_SYMBOLS:
                errorDescription =
                    "The %s schema is missing enum symbols '" + incompatibility.getMessage() + "' at path '"
                        + path + "' in the %s schema";
                break;
            case MISSING_UNION_BRANCH:
                errorDescription = "The %s schema is missing a type inside a union field at path '"
                    + path + "' in the %s schema";
                break;
            case READER_FIELD_MISSING_DEFAULT_VALUE:
                errorDescription =
                    "The field '" + incompatibility.getMessage() + "' at path '"
                        + path + "' in the %s schema has no default value and is missing in the %s schema";
                break;
            default:
                errorDescription = "";
        }

        return "{errorType:'" + errorType
            + '\''
            + ", description:'" + errorDescription + '\''
            + ", additionalInfo:'" + incompatibility.getMessage() + "'}";
    }

    public String toString() {
        return error();
    }

}