Package io.confluent.kafka.schemaregistry.client

Class CachedSchemaRegistryClient

java.lang.Object

io.confluent.kafka.schemaregistry.client.CachedSchemaRegistryClient

All Implemented Interfaces:

SchemaRegistryClient, SchemaVersionFetcher, Closeable, AutoCloseable

public class CachedSchemaRegistryClient
extends Object
implements SchemaRegistryClient

Thread-safe Schema Registry Client with client side caching.

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<String,String>	DEFAULT_REQUEST_PROPERTIES

Constructor Summary

Constructors

Constructor	Description
CachedSchemaRegistryClient(RestService restService, int cacheCapacity)
CachedSchemaRegistryClient(RestService restService, int cacheCapacity, List<SchemaProvider> providers, Map<String,?> configs, Map<String,String> httpHeaders)
CachedSchemaRegistryClient(RestService restService, int cacheCapacity, List<SchemaProvider> providers, Map<String,?> configs, Map<String,String> httpHeaders, com.google.common.base.Ticker ticker)
CachedSchemaRegistryClient(RestService restService, int cacheCapacity, Map<String,?> configs)
CachedSchemaRegistryClient(RestService restService, int cacheCapacity, Map<String,?> originals, Map<String,String> httpHeaders)
CachedSchemaRegistryClient(String baseUrl, int cacheCapacity)
CachedSchemaRegistryClient(String baseUrls, int identityMapCapacity, List<SchemaProvider> providers, Map<String,?> originals)
CachedSchemaRegistryClient(String baseUrls, int cacheCapacity, List<SchemaProvider> providers, Map<String,?> originals, Map<String,String> httpHeaders)
CachedSchemaRegistryClient(String baseUrl, int cacheCapacity, Map<String,?> originals)
CachedSchemaRegistryClient(String baseUrl, int cacheCapacity, Map<String,?> originals, Map<String,String> httpHeaders)
CachedSchemaRegistryClient(List<String> baseUrls, int cacheCapacity)
CachedSchemaRegistryClient(List<String> baseUrls, int cacheCapacity, List<SchemaProvider> providers, Map<String,?> originals)
CachedSchemaRegistryClient(List<String> baseUrls, int cacheCapacity, List<SchemaProvider> providers, Map<String,?> originals, Map<String,String> httpHeaders)
CachedSchemaRegistryClient(List<String> baseUrls, int cacheCapacity, Map<String,?> originals)
CachedSchemaRegistryClient(List<String> baseUrls, int cacheCapacity, Map<String,?> originals, Map<String,String> httpHeaders)

Method Summary

Modifier and Type	Method	Description
void	close()
void	deleteConfig(String subject)
void	deleteMode(String subject)
Integer	deleteSchemaVersion(String subject, String version, boolean isPermanent)
Integer	deleteSchemaVersion(Map<String,String> requestProperties, String subject, String version, boolean isPermanent)
List<Integer>	deleteSubject(String subject, boolean isPermanent)
List<Integer>	deleteSubject(Map<String,String> requestProperties, String subject, boolean isPermanent)
Collection<String>	getAllContexts()
Collection<String>	getAllSubjects()
Collection<String>	getAllSubjects(boolean lookupDeletedSubject)
Collection<String>	getAllSubjectsById(int id)
Collection<String>	getAllSubjectsByPrefix(String subjectPrefix)
List<Integer>	getAllVersions(String subject)
List<Integer>	getAllVersions(String subject, boolean lookupDeletedSchema)
Collection<SubjectVersion>	getAllVersionsById(int id)
Schema	getByVersion(String subject, int version, boolean lookupDeletedSchema)
Config	getConfig(String subject)
String	getGuid(String subject, ParsedSchema schema)
String	getGuid(String subject, ParsedSchema schema, boolean normalize)
int	getId(String subject, ParsedSchema schema)
int	getId(String subject, ParsedSchema schema, boolean normalize)
RegisterSchemaResponse	getIdWithResponse(String subject, ParsedSchema schema, boolean normalize)
SchemaMetadata	getLatestSchemaMetadata(String subject)
SchemaMetadata	getLatestWithMetadata(String subject, Map<String,String> metadata, boolean lookupDeletedSchema)
String	getMode()
String	getMode(String subject)
ParsedSchema	getSchemaByGuid(String guid, String format)
protected ParsedSchema	getSchemaByGuidFromRegistry(String guid, String format)
ParsedSchema	getSchemaById(int id)
protected ParsedSchema	getSchemaByIdFromRegistry(int id, String subject)
ParsedSchema	getSchemaBySubjectAndId(String subject, int id)
SchemaMetadata	getSchemaMetadata(String subject, int version)
SchemaMetadata	getSchemaMetadata(String subject, int version, boolean lookupDeletedSchema)
Map<String,SchemaProvider>	getSchemaProviders()
SchemaRegistryDeployment	getSchemaRegistryDeployment()
SchemaRegistryServerVersion	getSchemaRegistryServerVersion()
List<ParsedSchema>	getSchemas(String subjectPrefix, boolean lookupDeletedSchema, boolean latestOnly)
int	getVersion(String subject, ParsedSchema schema)
int	getVersion(String subject, ParsedSchema schema, boolean normalize)
Optional<ParsedSchema>	parseSchema(Schema schema)
Optional<ParsedSchema>	parseSchema(String schemaType, String schemaString, List<SchemaReference> references)
ParsedSchema	parseSchemaOrElseThrow(Schema schema)
int	register(String subject, ParsedSchema schema)
int	register(String subject, ParsedSchema schema, boolean normalize)
int	register(String subject, ParsedSchema schema, int version, int id)
RegisterSchemaResponse	registerWithResponse(String subject, ParsedSchema schema, boolean normalize, boolean propagateSchemaTags)
void	reset()
String	setMode(String mode)
String	setMode(String mode, String subject)
String	setMode(String mode, String subject, boolean force)
boolean	testCompatibility(String subject, ParsedSchema schema)
List<String>	testCompatibilityVerbose(String subject, ParsedSchema schema)
List<String>	testCompatibilityVerbose(String subject, ParsedSchema schema, boolean normalize)
com.google.common.base.Ticker	ticker()
Config	updateConfig(String subject, Config config)

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.client.SchemaRegistryClient

createAssociation, createOrUpdateAssociation, deleteAssociations, deleteCompatibility, deleteSchemaVersion, deleteSchemaVersion, deleteSubject, deleteSubject, getAssociationsByResourceId, getAssociationsBySubject, getById, getByID, getBySubjectAndId, getBySubjectAndID, getCompatibility, getId, getVersion, parseSchema, register, register, registerWithResponse, tenant, testCompatibility, updateCompatibility

Field Details

DEFAULT_REQUEST_PROPERTIES

public static final Map<String,String> DEFAULT_REQUEST_PROPERTIES

Constructor Details

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(String baseUrl,
 int cacheCapacity)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(List<String> baseUrls,
 int cacheCapacity)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(RestService restService,
 int cacheCapacity)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(String baseUrl,
 int cacheCapacity,
 Map<String,?> originals)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(List<String> baseUrls,
 int cacheCapacity,
 Map<String,?> originals)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(List<String> baseUrls,
 int cacheCapacity,
 List<SchemaProvider> providers,
 Map<String,?> originals)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(String baseUrls,
 int identityMapCapacity,
 List<SchemaProvider> providers,
 Map<String,?> originals)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(RestService restService,
 int cacheCapacity,
 Map<String,?> configs)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(String baseUrl,
 int cacheCapacity,
 Map<String,?> originals,
 Map<String,String> httpHeaders)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(List<String> baseUrls,
 int cacheCapacity,
 Map<String,?> originals,
 Map<String,String> httpHeaders)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(List<String> baseUrls,
 int cacheCapacity,
 List<SchemaProvider> providers,
 Map<String,?> originals,
 Map<String,String> httpHeaders)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(String baseUrls,
 int cacheCapacity,
 List<SchemaProvider> providers,
 Map<String,?> originals,
 Map<String,String> httpHeaders)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(RestService restService,
 int cacheCapacity,
 Map<String,?> originals,
 Map<String,String> httpHeaders)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(RestService restService,
 int cacheCapacity,
 List<SchemaProvider> providers,
 Map<String,?> configs,
 Map<String,String> httpHeaders)

CachedSchemaRegistryClient

public CachedSchemaRegistryClient(RestService restService,
 int cacheCapacity,
 List<SchemaProvider> providers,
 Map<String,?> configs,
 Map<String,String> httpHeaders,
 com.google.common.base.Ticker ticker)

Method Details

ticker

public com.google.common.base.Ticker ticker()

Specified by:

ticker in interface SchemaRegistryClient

parseSchema

public Optional<ParsedSchema> parseSchema(String schemaType,
 String schemaString,
 List<SchemaReference> references)

Specified by:

parseSchema in interface SchemaRegistryClient

parseSchema

public Optional<ParsedSchema> parseSchema(Schema schema)

Specified by:

parseSchema in interface SchemaRegistryClient

parseSchemaOrElseThrow

public ParsedSchema parseSchemaOrElseThrow(Schema schema)
                                    throws IOException

Specified by:

parseSchemaOrElseThrow in interface SchemaRegistryClient

Throws:

IOException

getSchemaProviders

public Map<String,SchemaProvider> getSchemaProviders()

getSchemaByIdFromRegistry

protected ParsedSchema getSchemaByIdFromRegistry(int id,
 String subject)
                                          throws IOException,
RestClientException

Throws:

IOException

RestClientException

getSchemaByGuidFromRegistry

protected ParsedSchema getSchemaByGuidFromRegistry(String guid,
 String format)
                                            throws IOException,
RestClientException

Throws:

IOException

RestClientException

register

public int register(String subject,
 ParsedSchema schema)
             throws IOException,
RestClientException

Specified by:

register in interface SchemaRegistryClient

Throws:

IOException

RestClientException

register

public int register(String subject,
 ParsedSchema schema,
 boolean normalize)
             throws IOException,
RestClientException

Specified by:

register in interface SchemaRegistryClient

Throws:

IOException

RestClientException

register

public int register(String subject,
 ParsedSchema schema,
 int version,
 int id)
             throws IOException,
RestClientException

Specified by:

register in interface SchemaRegistryClient

Throws:

IOException

RestClientException

registerWithResponse

public RegisterSchemaResponse registerWithResponse(String subject,
 ParsedSchema schema,
 boolean normalize,
 boolean propagateSchemaTags)
                                            throws IOException,
RestClientException

Specified by:

registerWithResponse in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getSchemaById

public ParsedSchema getSchemaById(int id)
                           throws IOException,
RestClientException

Specified by:

getSchemaById in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getSchemaBySubjectAndId

public ParsedSchema getSchemaBySubjectAndId(String subject,
 int id)
                                     throws IOException,
RestClientException

Specified by:

getSchemaBySubjectAndId in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getSchemaByGuid

public ParsedSchema getSchemaByGuid(String guid,
 String format)
                             throws IOException,
RestClientException

Specified by:

getSchemaByGuid in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getSchemas

public List<ParsedSchema> getSchemas(String subjectPrefix,
 boolean lookupDeletedSchema,
 boolean latestOnly)
                              throws IOException,
RestClientException

Specified by:

getSchemas in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getAllSubjectsById

public Collection<String> getAllSubjectsById(int id)
                                      throws IOException,
RestClientException

Specified by:

getAllSubjectsById in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getAllVersionsById

public Collection<SubjectVersion> getAllVersionsById(int id)
                                              throws IOException,
RestClientException

Specified by:

getAllVersionsById in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getByVersion

public Schema getByVersion(String subject,
 int version,
 boolean lookupDeletedSchema)

Specified by:

getByVersion in interface SchemaRegistryClient

Specified by:

getByVersion in interface SchemaVersionFetcher

getSchemaMetadata

public SchemaMetadata getSchemaMetadata(String subject,
 int version)
                                 throws IOException,
RestClientException

Specified by:

getSchemaMetadata in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getSchemaMetadata

public SchemaMetadata getSchemaMetadata(String subject,
 int version,
 boolean lookupDeletedSchema)
                                 throws IOException,
RestClientException

Specified by:

getSchemaMetadata in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getLatestSchemaMetadata

public SchemaMetadata getLatestSchemaMetadata(String subject)
                                       throws IOException,
RestClientException

Specified by:

getLatestSchemaMetadata in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getLatestWithMetadata

public SchemaMetadata getLatestWithMetadata(String subject,
 Map<String,String> metadata,
 boolean lookupDeletedSchema)
                                     throws IOException,
RestClientException

Specified by:

getLatestWithMetadata in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getVersion

public int getVersion(String subject,
 ParsedSchema schema)
               throws IOException,
RestClientException

Specified by:

getVersion in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getVersion

public int getVersion(String subject,
 ParsedSchema schema,
 boolean normalize)
               throws IOException,
RestClientException

Specified by:

getVersion in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getAllVersions

public List<Integer> getAllVersions(String subject)
                             throws IOException,
RestClientException

Specified by:

getAllVersions in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getAllVersions

public List<Integer> getAllVersions(String subject,
 boolean lookupDeletedSchema)
                             throws IOException,
RestClientException

Specified by:

getAllVersions in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getId

public int getId(String subject,
 ParsedSchema schema)
          throws IOException,
RestClientException

Specified by:

getId in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getId

public int getId(String subject,
 ParsedSchema schema,
 boolean normalize)
          throws IOException,
RestClientException

Specified by:

getId in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getGuid

public String getGuid(String subject,
 ParsedSchema schema)
               throws IOException,
RestClientException

Specified by:

getGuid in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getGuid

public String getGuid(String subject,
 ParsedSchema schema,
 boolean normalize)
               throws IOException,
RestClientException

Specified by:

getGuid in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getIdWithResponse

public RegisterSchemaResponse getIdWithResponse(String subject,
 ParsedSchema schema,
 boolean normalize)
                                         throws IOException,
RestClientException

Specified by:

getIdWithResponse in interface SchemaRegistryClient

Throws:

IOException

RestClientException

deleteSubject

public List<Integer> deleteSubject(String subject,
 boolean isPermanent)
                            throws IOException,
RestClientException

Specified by:

deleteSubject in interface SchemaRegistryClient

Throws:

IOException

RestClientException

deleteSubject

public List<Integer> deleteSubject(Map<String,String> requestProperties,
 String subject,
 boolean isPermanent)
                            throws IOException,
RestClientException

Specified by:

deleteSubject in interface SchemaRegistryClient

Throws:

IOException

RestClientException

deleteSchemaVersion

public Integer deleteSchemaVersion(String subject,
 String version,
 boolean isPermanent)
                            throws IOException,
RestClientException

Specified by:

deleteSchemaVersion in interface SchemaRegistryClient

Throws:

IOException

RestClientException

deleteSchemaVersion

public Integer deleteSchemaVersion(Map<String,String> requestProperties,
 String subject,
 String version,
 boolean isPermanent)
                            throws IOException,
RestClientException

Specified by:

deleteSchemaVersion in interface SchemaRegistryClient

Throws:

IOException

RestClientException

testCompatibility

public boolean testCompatibility(String subject,
 ParsedSchema schema)
                          throws IOException,
RestClientException

Specified by:

testCompatibility in interface SchemaRegistryClient

Throws:

IOException

RestClientException

testCompatibilityVerbose

public List<String> testCompatibilityVerbose(String subject,
 ParsedSchema schema)
                                      throws IOException,
RestClientException

Specified by:

testCompatibilityVerbose in interface SchemaRegistryClient

Throws:

IOException

RestClientException

testCompatibilityVerbose

public List<String> testCompatibilityVerbose(String subject,
 ParsedSchema schema,
 boolean normalize)
                                      throws IOException,
RestClientException

Specified by:

testCompatibilityVerbose in interface SchemaRegistryClient

Throws:

IOException

RestClientException

updateConfig

public Config updateConfig(String subject,
 Config config)
                    throws IOException,
RestClientException

Specified by:

updateConfig in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getConfig

public Config getConfig(String subject)
                 throws IOException,
RestClientException

Specified by:

getConfig in interface SchemaRegistryClient

Throws:

IOException

RestClientException

deleteConfig

public void deleteConfig(String subject)
                  throws IOException,
RestClientException

Specified by:

deleteConfig in interface SchemaRegistryClient

Throws:

IOException

RestClientException

setMode

public String setMode(String mode)
               throws IOException,
RestClientException

Specified by:

setMode in interface SchemaRegistryClient

Throws:

IOException

RestClientException

setMode

public String setMode(String mode,
 String subject)
               throws IOException,
RestClientException

Specified by:

setMode in interface SchemaRegistryClient

Throws:

IOException

RestClientException

setMode

public String setMode(String mode,
 String subject,
 boolean force)
               throws IOException,
RestClientException

Specified by:

setMode in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getMode

public String getMode()
               throws IOException,
RestClientException

Specified by:

getMode in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getMode

public String getMode(String subject)
               throws IOException,
RestClientException

Specified by:

getMode in interface SchemaRegistryClient

Throws:

IOException

RestClientException

deleteMode

public void deleteMode(String subject)
                throws IOException,
RestClientException

Specified by:

deleteMode in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getAllContexts

public Collection<String> getAllContexts()
                                  throws IOException,
RestClientException

Specified by:

getAllContexts in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getSchemaRegistryDeployment

public SchemaRegistryDeployment getSchemaRegistryDeployment()
                                                     throws IOException,
RestClientException

Specified by:

getSchemaRegistryDeployment in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getSchemaRegistryServerVersion

public SchemaRegistryServerVersion getSchemaRegistryServerVersion()
                                                           throws IOException,
RestClientException

Specified by:

getSchemaRegistryServerVersion in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getAllSubjects

public Collection<String> getAllSubjects()
                                  throws IOException,
RestClientException

Specified by:

getAllSubjects in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getAllSubjects

public Collection<String> getAllSubjects(boolean lookupDeletedSubject)
                                  throws IOException,
RestClientException

Specified by:

getAllSubjects in interface SchemaRegistryClient

Throws:

IOException

RestClientException

getAllSubjectsByPrefix

public Collection<String> getAllSubjectsByPrefix(String subjectPrefix)
                                          throws IOException,
RestClientException

Specified by:

getAllSubjectsByPrefix in interface SchemaRegistryClient

Throws:

IOException

RestClientException

reset

public void reset()

Specified by:

reset in interface SchemaRegistryClient

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface SchemaRegistryClient

Throws:

IOException