com.hortonworks.registries.schemaregistry.client

Class SchemaRegistryClient

java.lang.Object

com.hortonworks.registries.schemaregistry.client.SchemaRegistryClient

All Implemented Interfaces:

ISchemaRegistryClient, ISchemaRegistryService, AutoCloseable

public class SchemaRegistryClient
extends Object
implements ISchemaRegistryClient

This is the default implementation of ISchemaRegistryClient which connects to the given rootCatalogURL.

An instance of SchemaRegistryClient can be instantiated by passing configuration properties like below.

     SchemaRegistryClient schemaRegistryClient = new SchemaRegistryClient(config);
 

There are different options available as mentioned in SchemaRegistryClient.Configuration like

 - SchemaRegistryClient.Configuration.SCHEMA_REGISTRY_URL.
 - SchemaRegistryClient.Configuration.SCHEMA_METADATA_CACHE_SIZE.
 - SchemaRegistryClient.Configuration.SCHEMA_METADATA_CACHE_EXPIRY_INTERVAL_SECS.
 - SchemaRegistryClient.Configuration.SCHEMA_VERSION_CACHE_SIZE.
 - SchemaRegistryClient.Configuration.SCHEMA_VERSION_CACHE_EXPIRY_INTERVAL_SECS.
 - SchemaRegistryClient.Configuration.SCHEMA_TEXT_CACHE_SIZE.
 - SchemaRegistryClient.Configuration.SCHEMA_TEXT_CACHE_EXPIRY_INTERVAL_SECS.

 and many other properties like ClientProperties
 

 This can be used to
      - register schema metadata
      - add new versions of a schema
      - fetch different versions of schema
      - fetch latest version of a schema
      - check whether the given schema text is compatible with a latest version of the schema
      - register serializer/deserializer for a schema
      - fetch serializer/deserializer for a schema
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchemaRegistryClient.Configuration

Constructor Summary

Constructors

Constructor and Description
SchemaRegistryClient(File confFile) Creates SchemaRegistryClient instance with the given yaml config.
SchemaRegistryClient(Map<String,?> conf)

Method Summary

Modifier and Type	Method and Description
Long	addSchemaMetadata(SchemaMetadata schemaMetadata)
SchemaIdVersion	addSchemaVersion(SchemaMetadata schemaMetadata, SchemaVersion schemaVersion, boolean disableCanonicalCheck)
SchemaIdVersion	addSchemaVersion(String schemaBranchName, SchemaMetadata schemaMetadata, SchemaVersion schemaVersion, boolean disableCanonicalCheck)
SchemaIdVersion	addSchemaVersion(String schemaName, SchemaVersion schemaVersion, boolean disableCanonicalCheck)
SchemaIdVersion	addSchemaVersion(String schemaBranchName, String schemaName, SchemaVersion schemaVersion, boolean disableCanonicalCheck)
Long	addSerDes(SerDesPair serDesPair)
void	archiveSchemaVersion(Long schemaVersionId)
CompatibilityResult	checkCompatibility(String schemaName, String toSchemaText)
CompatibilityResult	checkCompatibility(String schemaBranchName, String schemaName, String toSchemaText)
SchemaRegistryVersion	clientVersion()
void	close()
protected com.hortonworks.registries.shaded.org.glassfish.jersey.client.ClientConfig	createClientConfig(Map<String,?> conf)
<T> T	createDeserializerInstance(SerDesInfo serDesInfo)
SchemaBranch	createSchemaBranch(Long schemaVersionId, SchemaBranch schemaBranch)
<T> T	createSerializerInstance(SerDesInfo serDesInfo)
protected SSLContext	createSSLContext(Map<String,String> sslConfigurations)
void	deleteSchema(String schemaName)
void	deleteSchemaBranch(Long schemaBranchId)
void	deleteSchemaVersion(Long schemaVersionId)
void	deleteSchemaVersion(SchemaVersionKey schemaVersionKey)
void	disableSchemaVersion(Long schemaVersionId)
InputStream	downloadFile(String fileId)
void	enableSchemaVersion(Long schemaVersionId)
Collection<SchemaVersionKey>	findSchemasByFields(SchemaFieldQuery schemaFieldQuery)
Collection<SchemaVersionInfo>	getAllVersions(String schemaName)
Collection<SchemaVersionInfo>	getAllVersions(String schemaBranchName, String schemaName)
Collection<SchemaVersionInfo>	getAllVersions(String schemaBranchName, String schemaName, List<Byte> stateIds)
SchemaRegistryClient.Configuration	getConfiguration()
<T> T	getDefaultDeserializer(String type)
<T> T	getDefaultSerializer(String type)
SchemaVersionInfo	getLatestSchemaVersionInfo(String schemaName)
SchemaVersionInfo	getLatestSchemaVersionInfo(String schemaBranchName, String schemaName)
Collection<SchemaBranch>	getSchemaBranches(String schemaName)
SchemaMetadataInfo	getSchemaMetadataInfo(Long schemaMetadataId)
SchemaMetadataInfo	getSchemaMetadataInfo(String schemaName)
SchemaVersionInfo	getSchemaVersionInfo(SchemaIdVersion schemaIdVersion)
SchemaVersionInfo	getSchemaVersionInfo(SchemaVersionKey schemaVersionKey)
SchemaVersionLifecycleStateMachineInfo	getSchemaVersionLifecycleStateMachineInfo()
Collection<SerDesInfo>	getSerDes(String schemaName)
Collection<SchemaProviderInfo>	getSupportedSchemaProviders()
protected void	initializeSecurityContext()
boolean	isCompatibleWithAllVersions(String schemaName, String toSchemaText)
boolean	isCompatibleWithAllVersions(String schemaBranchName, String schemaName, String toSchemaText)
void	mapSchemaWithSerDes(String schemaName, Long serDesId)
SchemaVersionMergeResult	mergeSchemaVersion(Long schemaVersionId, boolean disableCanonicalCheck)
static CatalogResponse	readCatalogResponse(String msg)
Long	registerSchemaMetadata(SchemaMetadata schemaMetadata)
void	startSchemaVersionReview(Long schemaVersionId)
void	transitionState(Long schemaVersionId, Byte targetStateId, byte[] transitionDetails)
SchemaMetadataInfo	updateSchemaMetadata(String schemaName, SchemaMetadata schemaMetadata)
String	uploadFile(InputStream inputStream)
SchemaIdVersion	uploadSchemaVersion(String schemaName, String description, InputStream schemaVersionTextFile)
SchemaIdVersion	uploadSchemaVersion(String schemaBranchName, String schemaName, String description, InputStream schemaVersionInputStream)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

addSchemaVersion, addSchemaVersion, addSchemaVersion, addSchemaVersion, mergeSchemaVersion

Constructor Detail

SchemaRegistryClient

public SchemaRegistryClient(File confFile)
                     throws IOException

Creates SchemaRegistryClient instance with the given yaml config.

Parameters:

confFile - config file which contains the configuration entries.

Throws:

IOException - when any IOException occurs while reading the given confFile

SchemaRegistryClient

public SchemaRegistryClient(Map<String,?> conf)

Method Detail

initializeSecurityContext

protected void initializeSecurityContext()

createSSLContext

protected SSLContext createSSLContext(Map<String,String> sslConfigurations)

createClientConfig

protected com.hortonworks.registries.shaded.org.glassfish.jersey.client.ClientConfig createClientConfig(Map<String,?> conf)

getConfiguration

public SchemaRegistryClient.Configuration getConfiguration()

getSupportedSchemaProviders

public Collection<SchemaProviderInfo> getSupportedSchemaProviders()

Specified by:

getSupportedSchemaProviders in interface ISchemaRegistryService

registerSchemaMetadata

public Long registerSchemaMetadata(SchemaMetadata schemaMetadata)

Specified by:

registerSchemaMetadata in interface ISchemaRegistryService

addSchemaMetadata

public Long addSchemaMetadata(SchemaMetadata schemaMetadata)

Specified by:

addSchemaMetadata in interface ISchemaRegistryService

updateSchemaMetadata

public SchemaMetadataInfo updateSchemaMetadata(String schemaName,
                                               SchemaMetadata schemaMetadata)

Specified by:

updateSchemaMetadata in interface ISchemaRegistryService

getSchemaMetadataInfo

public SchemaMetadataInfo getSchemaMetadataInfo(String schemaName)

Specified by:

getSchemaMetadataInfo in interface ISchemaRegistryService

getSchemaMetadataInfo

public SchemaMetadataInfo getSchemaMetadataInfo(Long schemaMetadataId)

Specified by:

getSchemaMetadataInfo in interface ISchemaRegistryService

deleteSchema

public void deleteSchema(String schemaName)
                  throws SchemaNotFoundException

Specified by:

deleteSchema in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

addSchemaVersion

public SchemaIdVersion addSchemaVersion(SchemaMetadata schemaMetadata,
                                        SchemaVersion schemaVersion,
                                        boolean disableCanonicalCheck)
                                 throws InvalidSchemaException,
                                        IncompatibleSchemaException,
                                        SchemaNotFoundException,
                                        SchemaBranchNotFoundException

Specified by:

addSchemaVersion in interface ISchemaRegistryService

Throws:

InvalidSchemaException

IncompatibleSchemaException

SchemaNotFoundException

SchemaBranchNotFoundException

addSchemaVersion

public SchemaIdVersion addSchemaVersion(String schemaBranchName,
                                        SchemaMetadata schemaMetadata,
                                        SchemaVersion schemaVersion,
                                        boolean disableCanonicalCheck)
                                 throws InvalidSchemaException,
                                        IncompatibleSchemaException,
                                        SchemaNotFoundException,
                                        SchemaBranchNotFoundException

Specified by:

addSchemaVersion in interface ISchemaRegistryService

Throws:

InvalidSchemaException

IncompatibleSchemaException

SchemaNotFoundException

SchemaBranchNotFoundException

uploadSchemaVersion

public SchemaIdVersion uploadSchemaVersion(String schemaName,
                                           String description,
                                           InputStream schemaVersionTextFile)
                                    throws InvalidSchemaException,
                                           IncompatibleSchemaException,
                                           SchemaNotFoundException,
                                           SchemaBranchNotFoundException

Specified by:

uploadSchemaVersion in interface ISchemaRegistryClient

Throws:

InvalidSchemaException

IncompatibleSchemaException

SchemaNotFoundException

SchemaBranchNotFoundException

uploadSchemaVersion

public SchemaIdVersion uploadSchemaVersion(String schemaBranchName,
                                           String schemaName,
                                           String description,
                                           InputStream schemaVersionInputStream)
                                    throws InvalidSchemaException,
                                           IncompatibleSchemaException,
                                           SchemaNotFoundException,
                                           SchemaBranchNotFoundException

Specified by:

uploadSchemaVersion in interface ISchemaRegistryClient

Throws:

InvalidSchemaException

IncompatibleSchemaException

SchemaNotFoundException

SchemaBranchNotFoundException

addSchemaVersion

public SchemaIdVersion addSchemaVersion(String schemaName,
                                        SchemaVersion schemaVersion,
                                        boolean disableCanonicalCheck)
                                 throws InvalidSchemaException,
                                        IncompatibleSchemaException,
                                        SchemaNotFoundException,
                                        SchemaBranchNotFoundException

Specified by:

addSchemaVersion in interface ISchemaRegistryService

Throws:

InvalidSchemaException

IncompatibleSchemaException

SchemaNotFoundException

SchemaBranchNotFoundException

addSchemaVersion

public SchemaIdVersion addSchemaVersion(String schemaBranchName,
                                        String schemaName,
                                        SchemaVersion schemaVersion,
                                        boolean disableCanonicalCheck)
                                 throws InvalidSchemaException,
                                        IncompatibleSchemaException,
                                        SchemaNotFoundException,
                                        SchemaBranchNotFoundException

Specified by:

addSchemaVersion in interface ISchemaRegistryService

Throws:

InvalidSchemaException

IncompatibleSchemaException

SchemaNotFoundException

SchemaBranchNotFoundException

deleteSchemaVersion

public void deleteSchemaVersion(SchemaVersionKey schemaVersionKey)
                         throws SchemaNotFoundException,
                                SchemaLifecycleException

Specified by:

deleteSchemaVersion in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

SchemaLifecycleException

readCatalogResponse

public static CatalogResponse readCatalogResponse(String msg)

getSchemaVersionInfo

public SchemaVersionInfo getSchemaVersionInfo(SchemaIdVersion schemaIdVersion)
                                       throws SchemaNotFoundException

Specified by:

getSchemaVersionInfo in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

getLatestSchemaVersionInfo

public SchemaVersionInfo getLatestSchemaVersionInfo(String schemaName)
                                             throws SchemaNotFoundException

Specified by:

getLatestSchemaVersionInfo in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

getSchemaVersionInfo

public SchemaVersionInfo getSchemaVersionInfo(SchemaVersionKey schemaVersionKey)
                                       throws SchemaNotFoundException

Specified by:

getSchemaVersionInfo in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

getLatestSchemaVersionInfo

public SchemaVersionInfo getLatestSchemaVersionInfo(String schemaBranchName,
                                                    String schemaName)
                                             throws SchemaNotFoundException

Specified by:

getLatestSchemaVersionInfo in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

getAllVersions

public Collection<SchemaVersionInfo> getAllVersions(String schemaName)
                                             throws SchemaNotFoundException

Specified by:

getAllVersions in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

enableSchemaVersion

public void enableSchemaVersion(Long schemaVersionId)
                         throws SchemaNotFoundException,
                                SchemaLifecycleException,
                                IncompatibleSchemaException

Specified by:

enableSchemaVersion in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

SchemaLifecycleException

IncompatibleSchemaException

disableSchemaVersion

public void disableSchemaVersion(Long schemaVersionId)
                          throws SchemaNotFoundException,
                                 SchemaLifecycleException

Specified by:

disableSchemaVersion in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

SchemaLifecycleException

deleteSchemaVersion

public void deleteSchemaVersion(Long schemaVersionId)
                         throws SchemaNotFoundException,
                                SchemaLifecycleException

Specified by:

deleteSchemaVersion in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

SchemaLifecycleException

archiveSchemaVersion

public void archiveSchemaVersion(Long schemaVersionId)
                          throws SchemaNotFoundException,
                                 SchemaLifecycleException

Specified by:

archiveSchemaVersion in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

SchemaLifecycleException

startSchemaVersionReview

public void startSchemaVersionReview(Long schemaVersionId)
                              throws SchemaNotFoundException,
                                     SchemaLifecycleException

Specified by:

startSchemaVersionReview in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

SchemaLifecycleException

mergeSchemaVersion

public SchemaVersionMergeResult mergeSchemaVersion(Long schemaVersionId,
                                                   boolean disableCanonicalCheck)
                                            throws SchemaNotFoundException,
                                                   IncompatibleSchemaException

Specified by:

mergeSchemaVersion in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

IncompatibleSchemaException

transitionState

public void transitionState(Long schemaVersionId,
                            Byte targetStateId,
                            byte[] transitionDetails)
                     throws SchemaNotFoundException,
                            SchemaLifecycleException

Specified by:

transitionState in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

SchemaLifecycleException

getSchemaVersionLifecycleStateMachineInfo

public SchemaVersionLifecycleStateMachineInfo getSchemaVersionLifecycleStateMachineInfo()

Specified by:

getSchemaVersionLifecycleStateMachineInfo in interface ISchemaRegistryService

createSchemaBranch

public SchemaBranch createSchemaBranch(Long schemaVersionId,
                                       SchemaBranch schemaBranch)
                                throws SchemaBranchAlreadyExistsException,
                                       SchemaNotFoundException

Specified by:

createSchemaBranch in interface ISchemaRegistryService

Throws:

SchemaBranchAlreadyExistsException

SchemaNotFoundException

getSchemaBranches

public Collection<SchemaBranch> getSchemaBranches(String schemaName)
                                           throws SchemaNotFoundException

Specified by:

getSchemaBranches in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

deleteSchemaBranch

public void deleteSchemaBranch(Long schemaBranchId)
                        throws SchemaBranchNotFoundException,
                               InvalidSchemaBranchDeletionException

Specified by:

deleteSchemaBranch in interface ISchemaRegistryService

Throws:

SchemaBranchNotFoundException

InvalidSchemaBranchDeletionException

getAllVersions

public Collection<SchemaVersionInfo> getAllVersions(String schemaBranchName,
                                                    String schemaName,
                                                    List<Byte> stateIds)
                                             throws SchemaNotFoundException,
                                                    SchemaBranchNotFoundException

Specified by:

getAllVersions in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

SchemaBranchNotFoundException

getAllVersions

public Collection<SchemaVersionInfo> getAllVersions(String schemaBranchName,
                                                    String schemaName)
                                             throws SchemaNotFoundException

Specified by:

getAllVersions in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

checkCompatibility

public CompatibilityResult checkCompatibility(String schemaName,
                                              String toSchemaText)
                                       throws SchemaNotFoundException,
                                              SchemaBranchNotFoundException

Specified by:

checkCompatibility in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

SchemaBranchNotFoundException

checkCompatibility

public CompatibilityResult checkCompatibility(String schemaBranchName,
                                              String schemaName,
                                              String toSchemaText)
                                       throws SchemaNotFoundException

Specified by:

checkCompatibility in interface ISchemaRegistryService

Throws:

SchemaNotFoundException

isCompatibleWithAllVersions

public boolean isCompatibleWithAllVersions(String schemaName,
                                           String toSchemaText)
                                    throws SchemaNotFoundException,
                                           SchemaBranchNotFoundException

Specified by:

isCompatibleWithAllVersions in interface ISchemaRegistryClient

Throws:

SchemaNotFoundException

SchemaBranchNotFoundException

isCompatibleWithAllVersions

public boolean isCompatibleWithAllVersions(String schemaBranchName,
                                           String schemaName,
                                           String toSchemaText)
                                    throws SchemaNotFoundException,
                                           SchemaBranchNotFoundException

Specified by:

isCompatibleWithAllVersions in interface ISchemaRegistryClient

Throws:

SchemaNotFoundException

SchemaBranchNotFoundException

findSchemasByFields

public Collection<SchemaVersionKey> findSchemasByFields(SchemaFieldQuery schemaFieldQuery)

Specified by:

findSchemasByFields in interface ISchemaRegistryService

uploadFile

public String uploadFile(InputStream inputStream)

Specified by:

uploadFile in interface ISchemaRegistryService

downloadFile

public InputStream downloadFile(String fileId)

Specified by:

downloadFile in interface ISchemaRegistryService

addSerDes

public Long addSerDes(SerDesPair serDesPair)

Specified by:

addSerDes in interface ISchemaRegistryService

mapSchemaWithSerDes

public void mapSchemaWithSerDes(String schemaName,
                                Long serDesId)

Specified by:

mapSchemaWithSerDes in interface ISchemaRegistryService

getDefaultSerializer

public <T> T getDefaultSerializer(String type)
                           throws SerDesException

Specified by:

getDefaultSerializer in interface ISchemaRegistryClient

Throws:

SerDesException

getDefaultDeserializer

public <T> T getDefaultDeserializer(String type)
                             throws SerDesException

Specified by:

getDefaultDeserializer in interface ISchemaRegistryClient

Throws:

SerDesException

getSerDes

public Collection<SerDesInfo> getSerDes(String schemaName)

Specified by:

getSerDes in interface ISchemaRegistryService

createSerializerInstance

public <T> T createSerializerInstance(SerDesInfo serDesInfo)

Specified by:

createSerializerInstance in interface ISchemaRegistryClient

createDeserializerInstance

public <T> T createDeserializerInstance(SerDesInfo serDesInfo)

Specified by:

createDeserializerInstance in interface ISchemaRegistryClient

close

public void close()

Specified by:

close in interface AutoCloseable

clientVersion

public SchemaRegistryVersion clientVersion()