All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.apicurio.registry.serde.strategy.ArtifactResolverStrategy Maven / Gradle / Ivy

There is a newer version: 3.0.0
Show newest version
package io.apicurio.registry.serde.strategy;

import io.apicurio.registry.resolver.ParsedSchema;
import io.apicurio.registry.resolver.data.Record;
import io.apicurio.registry.resolver.strategy.ArtifactReferenceResolverStrategy;
import io.apicurio.registry.serde.data.SerdeMetadata;
import io.apicurio.registry.serde.data.SerdeRecord;

/**
 * There is a new interface responsible with the same responsibility as this one, can be found here
 * {@link ArtifactReferenceResolverStrategy} The interface {@link ArtifactResolverStrategy} is kept for
 * backwards compatibility A {@link ArtifactResolverStrategy} is used by the Kafka serializer/deserializer to
 * determine the {@link ArtifactReference} under which the message schemas are located or should be registered
 * in the registry. The default is {@link TopicIdStrategy}.
 */
public interface ArtifactResolverStrategy extends ArtifactReferenceResolverStrategy {

    /**
     * For a given topic and message, returns the {@link ArtifactReference} under which the message schemas
     * are located or should be registered in the registry.
     *
     * @param topic the Kafka topic name to which the message is being published.
     * @param isKey true when encoding a message key, false for a message value.
     * @param schema the schema of the message being serialized/deserialized, can be null if we don't know it
     *            beforehand
     * @return the {@link ArtifactReference} under which the message schemas are located or should be
     *         registered
     */
    ArtifactReference artifactReference(String topic, boolean isKey, T schema);

    @Override
    default io.apicurio.registry.resolver.strategy.ArtifactReference artifactReference(Record data,
            ParsedSchema parsedSchema) {
        SerdeRecord kdata = (SerdeRecord) data;
        SerdeMetadata metadata = kdata.metadata();
        return artifactReference(metadata.getTopic(), metadata.isKey(),
                parsedSchema == null ? null : parsedSchema.getParsedSchema());
    }

}