Package io.confluent.kafka.schemaregistry.storage

Class KafkaSchemaRegistry

java.lang.Object

io.confluent.kafka.schemaregistry.storage.AbstractSchemaRegistry

io.confluent.kafka.schemaregistry.storage.KafkaSchemaRegistry

All Implemented Interfaces:

SchemaVersionFetcher, SslFactory.SslFactoryCreated, LeaderAwareSchemaRegistry, SchemaRegistry

public class KafkaSchemaRegistry
extends AbstractSchemaRegistry
implements LeaderAwareSchemaRegistry

Nested Class Summary

Nested classes/interfaces inherited from class io.confluent.kafka.schemaregistry.storage.AbstractSchemaRegistry

AbstractSchemaRegistry.RawSchema, AbstractSchemaRegistry.SchemeAndPort

Field Summary

Fields inherited from class io.confluent.kafka.schemaregistry.storage.AbstractSchemaRegistry

allowModeChanges, config, contextSearchDefaultLimit, contextSearchMaxLimit, customHandler, defaultCompatibilityLevel, defaultMode, defaultValidateFields, defaultValidateNewSchemas, initialized, lookupCache, metadataEncoder, metricsContainer, newSchemaCache, oldSchemaCache, props, providers, resourceExtensions, ruleSetHandler, schemaSearchDefaultLimit, schemaSearchMaxLimit, sslFactory, store, subjectSearchDefaultLimit, subjectSearchMaxLimit, subjectVersionSearchDefaultLimit, subjectVersionSearchMaxLimit, time, updateRequestHandlers

Fields inherited from interface io.confluent.kafka.schemaregistry.storage.SchemaRegistry

DEFAULT_TENANT, FIELD_CONFLICTS_WITH_RESERVED_FIELD, MAX_VERSION, MIN_VERSION, RESERVED_FIELD_REMOVED, RESOURCE_WILDCARD

Constructor Summary

Constructors

Constructor	Description
KafkaSchemaRegistry(SchemaRegistryConfig config, Serializer<SchemaRegistryKey,SchemaRegistryValue> serializer)

Method Summary

Modifier and Type	Method	Description
void	addLeaderChangeListener(Consumer<Boolean> listener)	Add a leader change listener.
void	close()
AssociationResponse	createAssociation(String context, boolean dryRun, AssociationCreateOrUpdateRequest request)
AssociationResponse	createAssociationOrForward(String context, boolean dryRun, AssociationCreateOrUpdateRequest request, Map<String,String> headerProperties)
AssociationResponse	createOrUpdateAssociation(String context, boolean dryRun, AssociationCreateOrUpdateRequest request)
AssociationResponse	createOrUpdateAssociation(String context, boolean dryRun, AssociationCreateOrUpdateRequest request, boolean isCreateOnly)
AssociationResponse	createOrUpdateAssociationOrForward(String context, boolean dryRun, AssociationCreateOrUpdateRequest request, Map<String,String> headerProperties)
void	deleteAssociations(String resourceId, String resourceType, List<String> associationTypes, boolean cascadeLifecycle, boolean dryRun)
void	deleteAssociationsOrForward(String subject, String resourceId, String resourceType, List<String> associationTypes, boolean cascadeLifecycle, boolean dryRun, Map<String,String> headerProperties)
void	deleteConfigOrForward(String subject, Map<String,String> headerProperties)
void	deleteContext(String delimitedContext)
void	deleteContextOrForward(Map<String,String> requestProperties, String delimitedContext)
void	deleteSchemaVersion(String subject, Schema schema, boolean permanentDelete)
void	deleteSchemaVersionOrForward(Map<String,String> headerProperties, String subject, Schema schema, boolean permanentDelete)
List<Integer>	deleteSubject(String subject, boolean permanentDelete)
void	deleteSubjectConfig(String subject)
void	deleteSubjectMode(String subject)
void	deleteSubjectMode(String subject, boolean recursive)
void	deleteSubjectModeOrForward(String subject, boolean recursive, Map<String,String> headerProperties)
List<Integer>	deleteSubjectOrForward(Map<String,String> requestProperties, String subject, boolean permanentDelete)
Schema	forwardModifySchemaTagsRequestToLeader(String subject, Schema schema, TagSchemaRequest request, Map<String,String> headerProperties)
SchemaString	get(int id, String subject, String format, boolean fetchMaxId)
Association	getAssociationByGuid(String guid)
List<Association>	getAssociationsByResourceId(String resourceId, String resourceType, List<String> associationTypes, LifecyclePolicy lifecycle)
List<Association>	getAssociationsByResourceName(String resourceName, String resourceNamespace, String resourceType, List<String> associationTypes, LifecyclePolicy lifecycle)
List<Association>	getAssociationsBySubject(String subject, String resourceType, List<String> associationTypes, LifecyclePolicy lifecycle)
protected String	getContextPrefixForDeleteMode(String context)	Returns the context prefix to use for listing subjects under a given context.
String	getGroupId()
IdGenerator	getIdentityGenerator()
String	getKafkaClusterId()
KafkaStore<SchemaRegistryKey,SchemaRegistryValue>	getKafkaStore()
protected SchemaUpdateHandler	getSchemaUpdateHandler(SchemaRegistryConfig config)
Serializer<SchemaRegistryKey,SchemaRegistryValue>	getSerializer()
boolean	healthy()
protected IdGenerator	identityGenerator(SchemaRegistryConfig config)
void	init()
boolean	initialized()
boolean	isLeader()
protected KafkaStore<SchemaRegistryKey,SchemaRegistryValue>	kafkaStore(SchemaRegistryConfig config)
SchemaRegistryIdentity	leaderIdentity()	Return the identity of the SchemaRegistry that this instance thinks is current leader.
RestService	leaderRestService()
protected LookupCache<SchemaRegistryKey,SchemaRegistryValue>	lookupCache()
Schema	modifySchemaTagsOrForward(String subject, Schema schema, TagSchemaRequest request, Map<String,String> headerProperties)
AssociationBatchResponse	mutateAssociations(String context, boolean dryRun, AssociationBatchRequest request)
AssociationBatchResponse	mutateAssociationsOrForward(String context, boolean dryRun, AssociationBatchRequest request, Map<String,String> headerProperties)
SchemaRegistryIdentity	myIdentity()	Return json data encoding basic information about this SchemaRegistry instance, such as host, port, etc.
void	postInit()
Schema	register(String subject, Schema schema, boolean normalize, boolean propagateSchemaTags)	Register the given schema under the given subject.
Schema	registerOrForward(String subject, RegisterSchemaRequest request, boolean normalize, Map<String,String> headerProperties)
void	setLeader(SchemaRegistryIdentity newLeader)	'Inform' this SchemaRegistry instance which SchemaRegistry is the current leader.
void	setMode(String subject, ModeUpdateRequest request, boolean force)
void	setModeOrForward(String subject, ModeUpdateRequest mode, boolean force, Map<String,String> headerProperties)
Config	updateConfig(String subject, ConfigUpdateRequest config)
Config	updateConfigOrForward(String subject, ConfigUpdateRequest newConfig, Map<String,String> headerProperties)
void	waitForInit()

Methods inherited from class io.confluent.kafka.schemaregistry.storage.AbstractSchemaRegistry

addCustomHandler, addUpdateRequestHandler, allContexts, allVersionsIncludingAliasesWithSubjectPrefix, canonicalizeSchema, checkIfSchemaWithIdExist, checkRegisterMode, clearNewSchemaCache, clearOldSchemaCache, config, extractSchemaTags, get, get, getAllSchemaKeysDescending, getAllVersions, getByGuid, getCompositeUpdateRequestHandler, getConfig, getConfigInScope, getCustomHandler, getHostnameVerifier, getInterInstanceListener, getLatestVersion, getLatestWithMetadata, getLookupCache, getMetadataEncoder, getMetricsContainer, getMode, getModeInScope, getReferencedBy, getReferencedBy, getResourceExtensions, getRuleSetHandler, getSchemaValue, getSslFactory, getUsingContexts, getVersionsWithSubjectPrefix, hasSubjects, initProviders, initResourceExtensions, invalidateFromNewSchemaCache, invalidateFromOldSchemaCache, isCompatible, isCompatibleWithPrevious, isReadOnlyMode, isSchemaFieldValidationEnabled, isSchemaNewSchemaValidationEnabled, isSubjectVersionDeleted, listContexts, listIdsForGuid, listSubjects, listSubjectsForId, listSubjectsForId, listSubjectsWithPrefix, listVersionsForId, listVersionsForId, loadSchema, logSchemaOp, lookUpSchemaUnderSubject, lookUpSchemaUnderSubject, lookUpSchemaUnderSubjectUsingContexts, maybePopulateFromPrevious, maybeSetMetadataRuleSet, modifySchemaTags, normalizeContextLimit, normalizeLimit, normalizeSchemaLimit, normalizeSubjectLimit, normalizeSubjectVersionLimit, onKeystoreCreated, onTruststoreCreated, parseSchema, parseSchema, properties, register, registerProviders, removeCustomHandler, schemaProvider, schemaTypes, schemaVersionExists, setMode, setRuleSetHandler, subjects, toSchemaEntity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

deleteAssociations, getByVersion, listSubjects, lookUpSchemaUnderSubject, register, register, setTenant, tenant

Constructor Details

KafkaSchemaRegistry

public KafkaSchemaRegistry(SchemaRegistryConfig config,
 Serializer<SchemaRegistryKey,SchemaRegistryValue> serializer)
                    throws SchemaRegistryException

Throws:

SchemaRegistryException

Method Details

kafkaStore

protected KafkaStore<SchemaRegistryKey,SchemaRegistryValue> kafkaStore(SchemaRegistryConfig config)
                                                                throws SchemaRegistryException

Throws:

SchemaRegistryException

getSchemaUpdateHandler

protected SchemaUpdateHandler getSchemaUpdateHandler(SchemaRegistryConfig config)

lookupCache

protected LookupCache<SchemaRegistryKey,SchemaRegistryValue> lookupCache()

getSerializer

public Serializer<SchemaRegistryKey,SchemaRegistryValue> getSerializer()

identityGenerator

protected IdGenerator identityGenerator(SchemaRegistryConfig config)

getIdentityGenerator

public IdGenerator getIdentityGenerator()

init

public void init()
          throws SchemaRegistryException

Specified by:

init in interface SchemaRegistry

Throws:

SchemaRegistryException

postInit

public void postInit()
              throws SchemaRegistryException

Specified by:

postInit in interface SchemaRegistry

Throws:

SchemaRegistryException

waitForInit

public void waitForInit()
                 throws InterruptedException

Throws:

InterruptedException

initialized

public boolean initialized()

Specified by:

initialized in interface SchemaRegistry

healthy

public boolean healthy()

Specified by:

healthy in interface SchemaRegistry

addLeaderChangeListener

public void addLeaderChangeListener(Consumer<Boolean> listener)

Add a leader change listener.

Specified by:

addLeaderChangeListener in interface SchemaRegistry

Parameters:

listener - a function that takes whether this node is a leader

isLeader

public boolean isLeader()

Specified by:

isLeader in interface SchemaRegistry

setLeader

public void setLeader(@Nullable
 SchemaRegistryIdentity newLeader)
               throws SchemaRegistryTimeoutException,
SchemaRegistryStoreException,
IdGenerationException

'Inform' this SchemaRegistry instance which SchemaRegistry is the current leader. If this instance is set as the new leader, ensure it is up-to-date with data in the kafka store.

Specified by:

setLeader in interface LeaderAwareSchemaRegistry

Specified by:

setLeader in interface SchemaRegistry

Parameters:

newLeader - Identity of the current leader. null means no leader is alive.

Throws:

SchemaRegistryTimeoutException

SchemaRegistryStoreException

IdGenerationException

myIdentity

public SchemaRegistryIdentity myIdentity()

Return json data encoding basic information about this SchemaRegistry instance, such as host, port, etc.

Specified by:

myIdentity in interface SchemaRegistry

leaderIdentity

public SchemaRegistryIdentity leaderIdentity()

Return the identity of the SchemaRegistry that this instance thinks is current leader. Any request that requires writing new data gets forwarded to the leader.

Specified by:

leaderIdentity in interface SchemaRegistry

leaderRestService

public RestService leaderRestService()

Specified by:

leaderRestService in interface SchemaRegistry

register

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

Register the given schema under the given subject.

If the schema already exists, it is returned. During registration, the metadata and ruleSet may be populated by the config that is in scope.

Specified by:

register in interface SchemaRegistry

Parameters:

subject - The subject

schema - The schema

normalize - Whether to normalize the schema before registration

Returns:

A schema containing the id. If the schema is different from the input parameter, it is set in the return object.

Throws:

SchemaRegistryException

registerOrForward

public Schema registerOrForward(String subject,
 RegisterSchemaRequest request,
 boolean normalize,
 Map<String,String> headerProperties)
                         throws SchemaRegistryException

Specified by:

registerOrForward in interface SchemaRegistry

Throws:

SchemaRegistryException

modifySchemaTagsOrForward

public Schema modifySchemaTagsOrForward(String subject,
 Schema schema,
 TagSchemaRequest request,
 Map<String,String> headerProperties)
                                 throws SchemaRegistryException

Specified by:

modifySchemaTagsOrForward in interface SchemaRegistry

Throws:

SchemaRegistryException

deleteSchemaVersion

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

Specified by:

deleteSchemaVersion in interface SchemaRegistry

Throws:

SchemaRegistryException

deleteSchemaVersionOrForward

public void deleteSchemaVersionOrForward(Map<String,String> headerProperties,
 String subject,
 Schema schema,
 boolean permanentDelete)
                                  throws SchemaRegistryException

Specified by:

deleteSchemaVersionOrForward in interface SchemaRegistry

Throws:

SchemaRegistryException

deleteSubject

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

Specified by:

deleteSubject in interface SchemaRegistry

Throws:

SchemaRegistryException

deleteSubjectOrForward

public List<Integer> deleteSubjectOrForward(Map<String,String> requestProperties,
 String subject,
 boolean permanentDelete)
                                     throws SchemaRegistryException

Specified by:

deleteSubjectOrForward in interface SchemaRegistry

Throws:

SchemaRegistryException

deleteContext

public void deleteContext(String delimitedContext)
                   throws SchemaRegistryException

Specified by:

deleteContext in interface SchemaRegistry

Throws:

SchemaRegistryException

deleteContextOrForward

public void deleteContextOrForward(Map<String,String> requestProperties,
 String delimitedContext)
                            throws SchemaRegistryException

Specified by:

deleteContextOrForward in interface SchemaRegistry

Throws:

SchemaRegistryException

createAssociation

public AssociationResponse createAssociation(String context,
 boolean dryRun,
 AssociationCreateOrUpdateRequest request)
                                      throws SchemaRegistryException

Specified by:

createAssociation in interface SchemaRegistry

Throws:

SchemaRegistryException

createAssociationOrForward

public AssociationResponse createAssociationOrForward(String context,
 boolean dryRun,
 AssociationCreateOrUpdateRequest request,
 Map<String,String> headerProperties)
                                               throws SchemaRegistryException

Specified by:

createAssociationOrForward in interface SchemaRegistry

Throws:

SchemaRegistryException

mutateAssociations

public AssociationBatchResponse mutateAssociations(String context,
 boolean dryRun,
 AssociationBatchRequest request)

Specified by:

mutateAssociations in interface SchemaRegistry

mutateAssociationsOrForward

public AssociationBatchResponse mutateAssociationsOrForward(String context,
 boolean dryRun,
 AssociationBatchRequest request,
 Map<String,String> headerProperties)
                                                     throws SchemaRegistryException

Specified by:

mutateAssociationsOrForward in interface SchemaRegistry

Throws:

SchemaRegistryException

createOrUpdateAssociation

public AssociationResponse createOrUpdateAssociation(String context,
 boolean dryRun,
 AssociationCreateOrUpdateRequest request)
                                              throws SchemaRegistryException

Specified by:

createOrUpdateAssociation in interface SchemaRegistry

Throws:

SchemaRegistryException

createOrUpdateAssociation

public AssociationResponse createOrUpdateAssociation(String context,
 boolean dryRun,
 AssociationCreateOrUpdateRequest request,
 boolean isCreateOnly)
                                              throws SchemaRegistryException

Throws:

SchemaRegistryException

createOrUpdateAssociationOrForward

public AssociationResponse createOrUpdateAssociationOrForward(String context,
 boolean dryRun,
 AssociationCreateOrUpdateRequest request,
 Map<String,String> headerProperties)
                                                       throws SchemaRegistryException

Specified by:

createOrUpdateAssociationOrForward in interface SchemaRegistry

Throws:

SchemaRegistryException

getAssociationByGuid

public Association getAssociationByGuid(String guid)
                                 throws SchemaRegistryException

Specified by:

getAssociationByGuid in interface SchemaRegistry

Throws:

SchemaRegistryException

getAssociationsBySubject

public List<Association> getAssociationsBySubject(String subject,
 String resourceType,
 List<String> associationTypes,
 LifecyclePolicy lifecycle)
                                           throws SchemaRegistryException

Specified by:

getAssociationsBySubject in interface SchemaRegistry

Throws:

SchemaRegistryException

getAssociationsByResourceId

public List<Association> getAssociationsByResourceId(String resourceId,
 String resourceType,
 List<String> associationTypes,
 LifecyclePolicy lifecycle)
                                              throws SchemaRegistryException

Specified by:

getAssociationsByResourceId in interface SchemaRegistry

Throws:

SchemaRegistryException

getAssociationsByResourceName

public List<Association> getAssociationsByResourceName(String resourceName,
 String resourceNamespace,
 String resourceType,
 List<String> associationTypes,
 LifecyclePolicy lifecycle)
                                                throws SchemaRegistryException

Specified by:

getAssociationsByResourceName in interface SchemaRegistry

Throws:

SchemaRegistryException

deleteAssociations

public void deleteAssociations(String resourceId,
 String resourceType,
 List<String> associationTypes,
 boolean cascadeLifecycle,
 boolean dryRun)
                        throws SchemaRegistryException

Throws:

SchemaRegistryException

deleteAssociationsOrForward

public void deleteAssociationsOrForward(String subject,
 String resourceId,
 String resourceType,
 List<String> associationTypes,
 boolean cascadeLifecycle,
 boolean dryRun,
 Map<String,String> headerProperties)
                                 throws SchemaRegistryException

Specified by:

deleteAssociationsOrForward in interface SchemaRegistry

Throws:

SchemaRegistryException

forwardModifySchemaTagsRequestToLeader

public Schema forwardModifySchemaTagsRequestToLeader(String subject,
 Schema schema,
 TagSchemaRequest request,
 Map<String,String> headerProperties)
                                              throws SchemaRegistryRequestForwardingException

Throws:

SchemaRegistryRequestForwardingException

get

public SchemaString get(int id,
 String subject,
 String format,
 boolean fetchMaxId)
                 throws SchemaRegistryException

Specified by:

get in interface SchemaRegistry

Throws:

SchemaRegistryException

close

public void close()
           throws IOException

Specified by:

close in interface SchemaRegistry

Throws:

IOException

updateConfig

public Config updateConfig(String subject,
 ConfigUpdateRequest config)
                    throws SchemaRegistryStoreException,
OperationNotPermittedException,
UnknownLeaderException

Specified by:

updateConfig in interface SchemaRegistry

Throws:

SchemaRegistryStoreException

OperationNotPermittedException

UnknownLeaderException

updateConfigOrForward

public Config updateConfigOrForward(String subject,
 ConfigUpdateRequest newConfig,
 Map<String,String> headerProperties)
                             throws SchemaRegistryStoreException,
SchemaRegistryRequestForwardingException,
UnknownLeaderException,
OperationNotPermittedException

Specified by:

updateConfigOrForward in interface SchemaRegistry

Throws:

SchemaRegistryStoreException

SchemaRegistryRequestForwardingException

UnknownLeaderException

OperationNotPermittedException

deleteSubjectConfig

public void deleteSubjectConfig(String subject)
                         throws SchemaRegistryStoreException,
OperationNotPermittedException

Specified by:

deleteSubjectConfig in interface SchemaRegistry

Throws:

SchemaRegistryStoreException

OperationNotPermittedException

deleteConfigOrForward

public void deleteConfigOrForward(String subject,
 Map<String,String> headerProperties)
                           throws SchemaRegistryStoreException,
SchemaRegistryRequestForwardingException,
OperationNotPermittedException,
UnknownLeaderException

Specified by:

deleteConfigOrForward in interface SchemaRegistry

Throws:

SchemaRegistryStoreException

SchemaRegistryRequestForwardingException

OperationNotPermittedException

UnknownLeaderException

getKafkaClusterId

public String getKafkaClusterId()

Specified by:

getKafkaClusterId in interface SchemaRegistry

getGroupId

public String getGroupId()

Specified by:

getGroupId in interface SchemaRegistry

setMode

public void setMode(String subject,
 ModeUpdateRequest request,
 boolean force)
             throws SchemaRegistryException

Specified by:

setMode in interface SchemaRegistry

Throws:

SchemaRegistryException

setModeOrForward

public void setModeOrForward(String subject,
 ModeUpdateRequest mode,
 boolean force,
 Map<String,String> headerProperties)
                      throws SchemaRegistryException

Specified by:

setModeOrForward in interface SchemaRegistry

Throws:

SchemaRegistryException

deleteSubjectMode

public void deleteSubjectMode(String subject)
                       throws SchemaRegistryStoreException,
OperationNotPermittedException

Specified by:

deleteSubjectMode in interface SchemaRegistry

Throws:

SchemaRegistryStoreException

OperationNotPermittedException

deleteSubjectMode

public void deleteSubjectMode(String subject,
 boolean recursive)
                       throws SchemaRegistryStoreException,
OperationNotPermittedException

Specified by:

deleteSubjectMode in interface SchemaRegistry

Throws:

SchemaRegistryStoreException

OperationNotPermittedException

deleteSubjectModeOrForward

public void deleteSubjectModeOrForward(String subject,
 boolean recursive,
 Map<String,String> headerProperties)
                                throws SchemaRegistryStoreException,
SchemaRegistryRequestForwardingException,
OperationNotPermittedException,
UnknownLeaderException

Specified by:

deleteSubjectModeOrForward in interface SchemaRegistry

Throws:

SchemaRegistryStoreException

SchemaRegistryRequestForwardingException

OperationNotPermittedException

UnknownLeaderException

getContextPrefixForDeleteMode

protected String getContextPrefixForDeleteMode(String context)

Returns the context prefix to use for listing subjects under a given context. This method can be overridden in subclasses to customize prefix computation.

Parameters:

context - The normalized context string, or null for default context

Returns:

The subject prefix to use for matching subjects

getKafkaStore

public KafkaStore<SchemaRegistryKey,SchemaRegistryValue> getKafkaStore()

Specified by:

getKafkaStore in interface SchemaRegistry