io.confluent.kafka.schemaregistry.storage

Interface SchemaRegistry

All Superinterfaces:

SchemaVersionFetcher

All Known Implementing Classes:

KafkaSchemaRegistry

public interface SchemaRegistry
extends SchemaVersionFetcher

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TENANT

Method Summary

Modifier and Type	Method and Description
void	close()
SchemaRegistryConfig	config()
void	deleteSchemaVersion(String subject, Schema schema, boolean permanentDelete)
List<Integer>	deleteSubject(String subject, boolean permanentDelete)
SchemaString	get(int id, String subject)
Schema	get(String subject, int version, boolean returnDeletedSchema)
Iterator<SchemaKey>	getAllVersions(String subject, LookupFilter filter)
default Schema	getByVersion(String subject, int version, boolean returnDeletedSchema)
Schema	getLatestVersion(String subject)
Schema	getLatestWithMetadata(String subject, Map<String,String> metadata, boolean lookupDeletedSchema)
Iterator<ExtendedSchema>	getVersionsWithSubjectPrefix(String prefix, boolean includeAliases, LookupFilter filter, boolean latestOnly, Predicate<Schema> postFilter)
void	init()
List<String>	isCompatible(String subject, Schema newSchema, List<SchemaKey> previousSchemas, boolean normalize)
default Set<String>	listSubjects()
Set<String>	listSubjects(LookupFilter filter)
Set<String>	listSubjectsForId(int id, String subject, boolean returnDeleted)
default Schema	lookUpSchemaUnderSubject(String subject, Schema schema, boolean lookupDeletedSchema)
Schema	lookUpSchemaUnderSubject(String subject, Schema schema, boolean normalize, boolean lookupDeletedSchema)
Map<String,Object>	properties()
default Schema	register(String subject, Schema schema)
default Schema	register(String subject, Schema schema, boolean normalize)
Schema	register(String subject, Schema schema, boolean normalize, boolean propagateSchemaTags)
Set<String>	schemaTypes()
default void	setTenant(String tenant) Can be used by subclasses to implement multi-tenancy
default String	tenant()

Field Detail

DEFAULT_TENANT

static final String DEFAULT_TENANT

See Also:

Constant Field Values

Method Detail

init

void init()
   throws SchemaRegistryException

Throws:

SchemaRegistryException

schemaTypes

Set<String> schemaTypes()

register

default Schema register(String subject,
                        Schema schema)
                 throws SchemaRegistryException

Throws:

SchemaRegistryException

register

default Schema register(String subject,
                        Schema schema,
                        boolean normalize)
                 throws SchemaRegistryException

Throws:

SchemaRegistryException

register

Schema register(String subject,
                Schema schema,
                boolean normalize,
                boolean propagateSchemaTags)
         throws SchemaRegistryException

Throws:

SchemaRegistryException

getByVersion

default Schema getByVersion(String subject,
                            int version,
                            boolean returnDeletedSchema)

Specified by:

getByVersion in interface SchemaVersionFetcher

get

Schema get(String subject,
           int version,
           boolean returnDeletedSchema)
    throws SchemaRegistryException

Throws:

SchemaRegistryException

get

SchemaString get(int id,
                 String subject)
          throws SchemaRegistryException

Throws:

SchemaRegistryException

listSubjects

default Set<String> listSubjects()
                          throws SchemaRegistryException

Throws:

SchemaRegistryException

listSubjects

Set<String> listSubjects(LookupFilter filter)
                  throws SchemaRegistryException

Throws:

SchemaRegistryException

listSubjectsForId

Set<String> listSubjectsForId(int id,
                              String subject,
                              boolean returnDeleted)
                       throws SchemaRegistryException

Throws:

SchemaRegistryException

getAllVersions

Iterator<SchemaKey> getAllVersions(String subject,
                                   LookupFilter filter)
                            throws SchemaRegistryException

Throws:

SchemaRegistryException

getVersionsWithSubjectPrefix

Iterator<ExtendedSchema> getVersionsWithSubjectPrefix(String prefix,
                                                      boolean includeAliases,
                                                      LookupFilter filter,
                                                      boolean latestOnly,
                                                      Predicate<Schema> postFilter)
                                               throws SchemaRegistryException

Throws:

SchemaRegistryException

getLatestVersion

Schema getLatestVersion(String subject)
                 throws SchemaRegistryException

Throws:

SchemaRegistryException

deleteSubject

List<Integer> deleteSubject(String subject,
                            boolean permanentDelete)
                     throws SchemaRegistryException

Throws:

SchemaRegistryException

lookUpSchemaUnderSubject

default Schema lookUpSchemaUnderSubject(String subject,
                                        Schema schema,
                                        boolean lookupDeletedSchema)
                                 throws SchemaRegistryException

Throws:

SchemaRegistryException

lookUpSchemaUnderSubject

Schema lookUpSchemaUnderSubject(String subject,
                                Schema schema,
                                boolean normalize,
                                boolean lookupDeletedSchema)
                         throws SchemaRegistryException

Throws:

SchemaRegistryException

getLatestWithMetadata

Schema getLatestWithMetadata(String subject,
                             Map<String,String> metadata,
                             boolean lookupDeletedSchema)
                      throws SchemaRegistryException

Throws:

SchemaRegistryException

isCompatible

List<String> isCompatible(String subject,
                          Schema newSchema,
                          List<SchemaKey> previousSchemas,
                          boolean normalize)
                   throws SchemaRegistryException

Throws:

SchemaRegistryException

close

void close()
    throws IOException

Throws:

IOException

deleteSchemaVersion

void deleteSchemaVersion(String subject,
                         Schema schema,
                         boolean permanentDelete)
                  throws SchemaRegistryException

Throws:

SchemaRegistryException

tenant

default String tenant()

Specified by:

tenant in interface SchemaVersionFetcher

setTenant

default void setTenant(String tenant)

Can be used by subclasses to implement multi-tenancy

Parameters:

tenant - the tenant

config

SchemaRegistryConfig config()

properties

Map<String,Object> properties()