org.axonframework.serialization.avro

Interface SchemaIncompatibilityChecker

All Known Implementing Classes:

DefaultSchemaIncompatibilityChecker

public interface SchemaIncompatibilityChecker

Provides functionality for incompatibility checks.

Since:

4.11.0

Author:

Simon Zambrovski, Jan Galinski

Method Summary

Modifier and Type	Method and Description
default void	assertSchemaCompatibility(Class<?> readerType, org.apache.avro.Schema readerSchema, org.apache.avro.Schema writerSchema, boolean includeSchemasInStackTraces) Checks schema compatibilities and throws exception if schemas are not compatible.
default List<org.apache.avro.SchemaCompatibility.Incompatibility>	checkCompatibility(org.apache.avro.Schema readerSchema, org.apache.avro.Schema writerSchema) Performs compatibility check.

Method Detail

assertSchemaCompatibility

default void assertSchemaCompatibility(@Nonnull
                                       Class<?> readerType,
                                       @Nonnull
                                       org.apache.avro.Schema readerSchema,
                                       @Nonnull
                                       org.apache.avro.Schema writerSchema,
                                       boolean includeSchemasInStackTraces)

Checks schema compatibilities and throws exception if schemas are not compatible.

Parameters:

readerType - intended reader type.

readerSchema - schema available on the reader side.

writerSchema - schema that was used to write the data.

Throws:

SerializationException - if the schema check has not passed.

checkCompatibility

@Nonnull
default List<org.apache.avro.SchemaCompatibility.Incompatibility> checkCompatibility(@Nonnull
                                                                                              org.apache.avro.Schema readerSchema,
                                                                                              @Nonnull
                                                                                              org.apache.avro.Schema writerSchema)

Performs compatibility check.

Parameters:

readerSchema - reader schema to check.

writerSchema - writer schema to check.

Returns:

list of compatibilities if any, or empty list