io.confluent.kafka.schemaregistry.storage

Interface LookupCache<K,V>

Type Parameters:

K - key of the store

V - value of the store

All Superinterfaces:

AutoCloseable, Store<K,V>

All Known Implementing Classes:

InMemoryCache

public interface LookupCache<K,V>
extends Store<K,V>

Internal interface that provides various indexed methods that help lookup the underlying schemas. The interface has also callback methods for various schema lifecycle events like register, delete, etc. It is important to note that these callbacks block the corresponding API that lead to the callback. Hence sufficient care must be taken to ensure that the callbacks are light weight.

Method Summary

Modifier and Type	Method and Description
Map<String,Integer>	clearSubjects(String subject) Clears the cache of deleted schemas that match the given subject.
default CompatibilityLevel	compatibilityLevel(String subject, boolean returnTopLevelIfNotFound, CompatibilityLevel defaultForTopLevel) Retrieves the config for a subject.
Config	config(String subject, boolean returnTopLevelIfNotFound, Config defaultForTopLevel) Retrieves the config for a subject.
boolean	containsSchema(Schema schema) Checks if a schema is registered in any subject.
boolean	hasSubjects(String subject, boolean lookupDeletedSubjects) Returns whether there exist schemas (that are not deleted) that match the given subject.
Mode	mode(String subject, boolean returnTopLevelIfNotFound, Mode defaultForTopLevel) Retrieves the mode for a subject.
Set<Integer>	referencesSchema(SchemaKey schema) Returns schemas that reference the given schema.
void	schemaDeleted(SchemaKey schemaKey, SchemaValue schemaValue, SchemaValue oldSchemaValue) Callback that is invoked when a schema is deleted.
SchemaIdAndSubjects	schemaIdAndSubjects(Schema schema) Provides SchemaIdAndSubjects associated with the schema.
SchemaKey	schemaKeyById(Integer id, String subject) Provides the SchemaKey for the provided schema id.
void	schemaRegistered(SchemaKey schemaKey, SchemaValue schemaValue, SchemaValue oldSchemaValue) Callback that is invoked when a schema is registered.
void	schemaTombstoned(SchemaKey schemaKey, SchemaValue schemaValue) Callback that is invoked when a schema is tombstoned.
default void	setTenant(String tenant) Can be used by subclasses to implement multi-tenancy
Set<String>	subjects(String subject, boolean lookupDeletedSubjects) Returns subjects that have schemas (that are not deleted) that match the given subject.
default String	tenant()

Methods inherited from interface io.confluent.kafka.schemaregistry.storage.Store

close, delete, flush, get, getAll, getAllKeys, init, isPersistent, put, putAll

Method Detail

schemaIdAndSubjects

SchemaIdAndSubjects schemaIdAndSubjects(Schema schema)
                                 throws StoreException

Provides SchemaIdAndSubjects associated with the schema.

Parameters:

schema - schema object; never null

Returns:

the schema id and subjects associated with the schema, null otherwise.

Throws:

StoreException

containsSchema

boolean containsSchema(Schema schema)
                throws StoreException

Checks if a schema is registered in any subject.

Parameters:

schema - schema object

Returns:

true if the schema is already registered else false

Throws:

StoreException

referencesSchema

Set<Integer> referencesSchema(SchemaKey schema)
                       throws StoreException

Returns schemas that reference the given schema.

Parameters:

schema - schema object

Returns:

the ids of schemas that reference the given schema

Throws:

StoreException

schemaKeyById

SchemaKey schemaKeyById(Integer id,
                        String subject)
                 throws StoreException

Provides the SchemaKey for the provided schema id.

Parameters:

id - the schema id; never null

subject - the qualified context or subject

Returns:

the SchemaKey if found, otherwise null.

Throws:

StoreException

schemaRegistered

void schemaRegistered(SchemaKey schemaKey,
                      SchemaValue schemaValue,
                      SchemaValue oldSchemaValue)

Callback that is invoked when a schema is registered. This can be used to update any internal data structure. This is invoked synchronously during register.

Parameters:

schemaKey - the registered SchemaKey; never null

schemaValue - the registered SchemaValue; never null

oldSchemaValue - the previous SchemaValue

schemaDeleted

void schemaDeleted(SchemaKey schemaKey,
                   SchemaValue schemaValue,
                   SchemaValue oldSchemaValue)

Callback that is invoked when a schema is deleted. This can be used to update any internal data structure. This is invoked synchronously during delete.

Parameters:

schemaKey - the deleted SchemaKey; never null

schemaValue - the deleted SchemaValue; never null

oldSchemaValue - the previous SchemaValue

schemaTombstoned

void schemaTombstoned(SchemaKey schemaKey,
                      SchemaValue schemaValue)

Callback that is invoked when a schema is tombstoned.

Parameters:

schemaKey - the tombstoned SchemaKey; never null

schemaValue - the tombstoned SchemaValue

compatibilityLevel

default CompatibilityLevel compatibilityLevel(String subject,
                                              boolean returnTopLevelIfNotFound,
                                              CompatibilityLevel defaultForTopLevel)
                                       throws StoreException

Retrieves the config for a subject.

Parameters:

subject - the subject

returnTopLevelIfNotFound - whether to return the top level scope if not found

defaultForTopLevel - default value for the top level scope

Returns:

the compatibility level if found, otherwise null

Throws:

StoreException

config

Config config(String subject,
              boolean returnTopLevelIfNotFound,
              Config defaultForTopLevel)
       throws StoreException

Retrieves the config for a subject.

Parameters:

subject - the subject

returnTopLevelIfNotFound - whether to return the top level scope if not found

defaultForTopLevel - default value for the top level scope

Returns:

the compatibility level if found, otherwise null

Throws:

StoreException

mode

Mode mode(String subject,
          boolean returnTopLevelIfNotFound,
          Mode defaultForTopLevel)
   throws StoreException

Retrieves the mode for a subject.

Parameters:

subject - the subject

returnTopLevelIfNotFound - whether to return the top level scope if not found

defaultForTopLevel - default value for the top level scope

Returns:

the mode if found, otherwise null.

Throws:

StoreException

subjects

Set<String> subjects(String subject,
                     boolean lookupDeletedSubjects)
              throws StoreException

Returns subjects that have schemas (that are not deleted) that match the given subject.

Parameters:

subject - the subject, or null for all subjects

Returns:

the subjects with matching schemas

Throws:

StoreException

hasSubjects

boolean hasSubjects(String subject,
                    boolean lookupDeletedSubjects)
             throws StoreException

Returns whether there exist schemas (that are not deleted) that match the given subject.

Parameters:

subject - the subject, or null for all subjects

Returns:

whether there exist matching schemas

Throws:

StoreException

clearSubjects

Map<String,Integer> clearSubjects(String subject)
                           throws StoreException

Clears the cache of deleted schemas that match the given subject.

Parameters:

subject - the subject, or null for all subjects

Returns:

the number of schemas cleared by schema type

Throws:

StoreException

tenant

default String tenant()

setTenant

default void setTenant(String tenant)

Can be used by subclasses to implement multi-tenancy

Parameters:

tenant - the tenant