Interface CompatibilityChecker
-
- All Known Implementing Classes:
AvroCompatibilityChecker
,JsonSchemaCompatibilityChecker
,NoopCompatibilityChecker
,ProtobufCompatibilityChecker
public interface CompatibilityChecker
An interface that is used to determine whether a proposed artifact's content is compatible and return a set of incompatible differences with older version(s) of the same content, based on a given compatibility level.- Author:
- Ales Justin
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default CompatibilityExecutionResult
testCompatibility(CompatibilityLevel compatibilityLevel, List<ContentHandle> existingArtifacts, ContentHandle proposedArtifact)
CompatibilityExecutionResult
testCompatibility(CompatibilityLevel compatibilityLevel, List<String> existingArtifacts, String proposedArtifact)
-
-
-
Method Detail
-
testCompatibility
default CompatibilityExecutionResult testCompatibility(CompatibilityLevel compatibilityLevel, List<ContentHandle> existingArtifacts, ContentHandle proposedArtifact)
- Parameters:
compatibilityLevel
- MUST NOT be nullexistingArtifacts
- MUST NOT be null and MUST NOT contain null elements, but may be empty if the rule is executed and the artifact does not exist (e.g. a global COMPATIBILITY rule withio.apicurio.registry.rules.RuleApplicationType#CREATE
)proposedArtifact
- MUST NOT be null
-
testCompatibility
CompatibilityExecutionResult testCompatibility(CompatibilityLevel compatibilityLevel, List<String> existingArtifacts, String proposedArtifact)
- Parameters:
compatibilityLevel
- MUST NOT be nullexistingArtifacts
- MUST NOT be null and MUST NOT contain null elements, but may be empty if the rule is executed and the artifact does not exist (e.g. a global COMPATIBILITY rule withio.apicurio.registry.rules.RuleApplicationType#CREATE
)proposedArtifact
- MUST NOT be null
-
-