com.hortonworks.registries.schemaregistry.client

Class SchemaRegistryClient

java.lang.Object

com.hortonworks.registries.schemaregistry.client.SchemaRegistryClient

All Implemented Interfaces:

com.hortonworks.registries.schemaregistry.client.ISchemaRegistryClient, com.hortonworks.registries.schemaregistry.ISchemaRegistryService, java.lang.AutoCloseable

public class SchemaRegistryClient
extends java.lang.Object
implements com.hortonworks.registries.schemaregistry.client.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(java.io.File confFile) Creates SchemaRegistryClient instance with the given yaml config.
SchemaRegistryClient(java.util.Map<java.lang.String,?> conf)

Method Summary

Modifier and Type	Method and Description
java.lang.Long	addSchemaMetadata(com.hortonworks.registries.schemaregistry.SchemaMetadata schemaMetadata)
com.hortonworks.registries.schemaregistry.SchemaIdVersion	addSchemaVersion(com.hortonworks.registries.schemaregistry.SchemaMetadata schemaMetadata, com.hortonworks.registries.schemaregistry.SchemaVersion schemaVersion, boolean disableCanonicalCheck)
com.hortonworks.registries.schemaregistry.SchemaIdVersion	addSchemaVersion(java.lang.String schemaBranchName, com.hortonworks.registries.schemaregistry.SchemaMetadata schemaMetadata, com.hortonworks.registries.schemaregistry.SchemaVersion schemaVersion, boolean disableCanonicalCheck)
com.hortonworks.registries.schemaregistry.SchemaIdVersion	addSchemaVersion(java.lang.String schemaName, com.hortonworks.registries.schemaregistry.SchemaVersion schemaVersion, boolean disableCanonicalCheck)
com.hortonworks.registries.schemaregistry.SchemaIdVersion	addSchemaVersion(java.lang.String schemaBranchName, java.lang.String schemaName, com.hortonworks.registries.schemaregistry.SchemaVersion schemaVersion, boolean disableCanonicalCheck)
java.lang.Long	addSerDes(com.hortonworks.registries.schemaregistry.SerDesPair serDesPair)
void	archiveSchemaVersion(java.lang.Long schemaVersionId)
com.hortonworks.registries.schemaregistry.CompatibilityResult	checkCompatibility(java.lang.String schemaName, java.lang.String toSchemaText)
com.hortonworks.registries.schemaregistry.CompatibilityResult	checkCompatibility(java.lang.String schemaBranchName, java.lang.String schemaName, java.lang.String toSchemaText)
com.hortonworks.registries.common.SchemaRegistryVersion	clientVersion()
void	close() Closes the client and all open connections.
protected com.hortonworks.registries.shaded.org.glassfish.jersey.client.ClientConfig	createClientConfig(java.util.Map<java.lang.String,?> conf)
<T> T	createDeserializerInstance(com.hortonworks.registries.schemaregistry.SerDesInfo serDesInfo)
com.hortonworks.registries.schemaregistry.SchemaBranch	createSchemaBranch(java.lang.Long schemaVersionId, com.hortonworks.registries.schemaregistry.SchemaBranch schemaBranch)
<T> T	createSerializerInstance(com.hortonworks.registries.schemaregistry.SerDesInfo serDesInfo)
protected javax.net.ssl.SSLContext	createSSLContext(java.util.Map<java.lang.String,java.lang.String> sslConfigurations)
void	deleteSchema(java.lang.String schemaName)
void	deleteSchemaBranch(java.lang.Long schemaBranchId)
void	deleteSchemaVersion(java.lang.Long schemaVersionId)
void	deleteSchemaVersion(com.hortonworks.registries.schemaregistry.SchemaVersionKey schemaVersionKey)
void	disableSchemaVersion(java.lang.Long schemaVersionId)
java.io.InputStream	downloadFile(java.lang.String fileId)
void	enableSchemaVersion(java.lang.Long schemaVersionId)
java.util.List<com.hortonworks.registries.schemaregistry.AggregatedSchemaMetadataInfo>	findAggregatedSchemas(java.lang.String schemaName, java.lang.String schemaDescription, java.lang.String orderByFields)
java.util.List<com.hortonworks.registries.schemaregistry.SchemaMetadataInfo>	findAllSchemas()
java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaVersionKey>	findSchemasByFields(com.hortonworks.registries.schemaregistry.SchemaFieldQuery schemaFieldQuery)
java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaVersionInfo>	getAllVersions(java.lang.String schemaName)
java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaVersionInfo>	getAllVersions(java.lang.String schemaBranchName, java.lang.String schemaName)
java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaVersionInfo>	getAllVersions(java.lang.String schemaBranchName, java.lang.String schemaName, java.util.List<java.lang.Byte> stateIds)
SchemaRegistryClient.Configuration	getConfiguration()
<T> T	getDefaultDeserializer(java.lang.String type)
<T> T	getDefaultSerializer(java.lang.String type)
com.hortonworks.registries.schemaregistry.SchemaVersionInfo	getLatestSchemaVersionInfo(java.lang.String schemaName)
com.hortonworks.registries.schemaregistry.SchemaVersionInfo	getLatestSchemaVersionInfo(java.lang.String schemaBranchName, java.lang.String schemaName)
java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaBranch>	getSchemaBranches(java.lang.String schemaName)
com.hortonworks.registries.schemaregistry.SchemaMetadataInfo	getSchemaMetadataInfo(java.lang.Long schemaMetadataId)
com.hortonworks.registries.schemaregistry.SchemaMetadataInfo	getSchemaMetadataInfo(java.lang.String schemaName)
com.hortonworks.registries.schemaregistry.SchemaVersionInfo	getSchemaVersionInfo(com.hortonworks.registries.schemaregistry.SchemaIdVersion schemaIdVersion)
com.hortonworks.registries.schemaregistry.SchemaVersionInfo	getSchemaVersionInfo(com.hortonworks.registries.schemaregistry.SchemaVersionKey schemaVersionKey)
com.hortonworks.registries.schemaregistry.state.SchemaVersionLifecycleStateMachineInfo	getSchemaVersionLifecycleStateMachineInfo()
java.util.Collection<com.hortonworks.registries.schemaregistry.SerDesInfo>	getSerDes(java.lang.String schemaName)
java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaProviderInfo>	getSupportedSchemaProviders()
protected void	initializeSecurityContext() Login with kerberos or oauth2
boolean	isCompatibleWithAllVersions(java.lang.String schemaName, java.lang.String toSchemaText)
boolean	isCompatibleWithAllVersions(java.lang.String schemaBranchName, java.lang.String schemaName, java.lang.String toSchemaText)
void	mapSchemaWithSerDes(java.lang.String schemaName, java.lang.Long serDesId)
com.hortonworks.registries.schemaregistry.SchemaVersionMergeResult	mergeSchemaVersion(java.lang.Long schemaVersionId, boolean disableCanonicalCheck)
static com.hortonworks.registries.common.catalog.CatalogResponse	readCatalogResponse(java.lang.String msg)
java.lang.Long	registerSchemaMetadata(com.hortonworks.registries.schemaregistry.SchemaMetadata schemaMetadata)
void	startSchemaVersionReview(java.lang.Long schemaVersionId)
void	transitionState(java.lang.Long schemaVersionId, java.lang.Byte targetStateId, byte[] transitionDetails)
com.hortonworks.registries.schemaregistry.SchemaMetadataInfo	updateSchemaMetadata(java.lang.String schemaName, com.hortonworks.registries.schemaregistry.SchemaMetadata schemaMetadata)
java.lang.String	uploadFile(java.io.InputStream inputStream)
com.hortonworks.registries.schemaregistry.SchemaIdVersion	uploadSchemaVersion(java.lang.String schemaName, java.lang.String description, java.io.InputStream schemaVersionTextFile)
com.hortonworks.registries.schemaregistry.SchemaIdVersion	uploadSchemaVersion(java.lang.String schemaBranchName, java.lang.String schemaName, java.lang.String description, java.io.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(java.io.File confFile)
                     throws java.io.IOException

Creates SchemaRegistryClient instance with the given yaml config.

Parameters:

confFile - config file which contains the configuration entries.

Throws:

java.io.IOException - when any IOException occurs while reading the given confFile

SchemaRegistryClient

public SchemaRegistryClient(java.util.Map<java.lang.String,?> conf)

Method Detail

initializeSecurityContext

protected void initializeSecurityContext()

Login with kerberos or oauth2

createSSLContext

protected javax.net.ssl.SSLContext createSSLContext(java.util.Map<java.lang.String,java.lang.String> sslConfigurations)

createClientConfig

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

getConfiguration

public SchemaRegistryClient.Configuration getConfiguration()

getSupportedSchemaProviders

public java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaProviderInfo> getSupportedSchemaProviders()

Specified by:

getSupportedSchemaProviders in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

registerSchemaMetadata

public java.lang.Long registerSchemaMetadata(com.hortonworks.registries.schemaregistry.SchemaMetadata schemaMetadata)

Specified by:

registerSchemaMetadata in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

addSchemaMetadata

public java.lang.Long addSchemaMetadata(com.hortonworks.registries.schemaregistry.SchemaMetadata schemaMetadata)

Specified by:

addSchemaMetadata in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

updateSchemaMetadata

public com.hortonworks.registries.schemaregistry.SchemaMetadataInfo updateSchemaMetadata(java.lang.String schemaName,
                                                                                         com.hortonworks.registries.schemaregistry.SchemaMetadata schemaMetadata)

Specified by:

updateSchemaMetadata in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

getSchemaMetadataInfo

public com.hortonworks.registries.schemaregistry.SchemaMetadataInfo getSchemaMetadataInfo(java.lang.String schemaName)

Specified by:

getSchemaMetadataInfo in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

getSchemaMetadataInfo

public com.hortonworks.registries.schemaregistry.SchemaMetadataInfo getSchemaMetadataInfo(java.lang.Long schemaMetadataId)

Specified by:

getSchemaMetadataInfo in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

deleteSchema

public void deleteSchema(java.lang.String schemaName)
                  throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

Specified by:

deleteSchema in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

addSchemaVersion

public com.hortonworks.registries.schemaregistry.SchemaIdVersion addSchemaVersion(com.hortonworks.registries.schemaregistry.SchemaMetadata schemaMetadata,
                                                                                  com.hortonworks.registries.schemaregistry.SchemaVersion schemaVersion,
                                                                                  boolean disableCanonicalCheck)
                                                                           throws com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

Specified by:

addSchemaVersion in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException

com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

addSchemaVersion

public com.hortonworks.registries.schemaregistry.SchemaIdVersion addSchemaVersion(java.lang.String schemaBranchName,
                                                                                  com.hortonworks.registries.schemaregistry.SchemaMetadata schemaMetadata,
                                                                                  com.hortonworks.registries.schemaregistry.SchemaVersion schemaVersion,
                                                                                  boolean disableCanonicalCheck)
                                                                           throws com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

Specified by:

addSchemaVersion in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException

com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

uploadSchemaVersion

public com.hortonworks.registries.schemaregistry.SchemaIdVersion uploadSchemaVersion(java.lang.String schemaName,
                                                                                     java.lang.String description,
                                                                                     java.io.InputStream schemaVersionTextFile)
                                                                              throws com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException,
                                                                                     com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException,
                                                                                     com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                                                                     com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

Specified by:

uploadSchemaVersion in interface com.hortonworks.registries.schemaregistry.client.ISchemaRegistryClient

Throws:

com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException

com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

uploadSchemaVersion

public com.hortonworks.registries.schemaregistry.SchemaIdVersion uploadSchemaVersion(java.lang.String schemaBranchName,
                                                                                     java.lang.String schemaName,
                                                                                     java.lang.String description,
                                                                                     java.io.InputStream schemaVersionInputStream)
                                                                              throws com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException,
                                                                                     com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException,
                                                                                     com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                                                                     com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

Specified by:

uploadSchemaVersion in interface com.hortonworks.registries.schemaregistry.client.ISchemaRegistryClient

Throws:

com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException

com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

addSchemaVersion

public com.hortonworks.registries.schemaregistry.SchemaIdVersion addSchemaVersion(java.lang.String schemaName,
                                                                                  com.hortonworks.registries.schemaregistry.SchemaVersion schemaVersion,
                                                                                  boolean disableCanonicalCheck)
                                                                           throws com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

Specified by:

addSchemaVersion in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException

com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

addSchemaVersion

public com.hortonworks.registries.schemaregistry.SchemaIdVersion addSchemaVersion(java.lang.String schemaBranchName,
                                                                                  java.lang.String schemaName,
                                                                                  com.hortonworks.registries.schemaregistry.SchemaVersion schemaVersion,
                                                                                  boolean disableCanonicalCheck)
                                                                           throws com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                                                                  com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

Specified by:

addSchemaVersion in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.InvalidSchemaException

com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

deleteSchemaVersion

public void deleteSchemaVersion(com.hortonworks.registries.schemaregistry.SchemaVersionKey schemaVersionKey)
                         throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

Specified by:

deleteSchemaVersion in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

readCatalogResponse

public static com.hortonworks.registries.common.catalog.CatalogResponse readCatalogResponse(java.lang.String msg)

getSchemaVersionInfo

public com.hortonworks.registries.schemaregistry.SchemaVersionInfo getSchemaVersionInfo(com.hortonworks.registries.schemaregistry.SchemaIdVersion schemaIdVersion)
                                                                                 throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

Specified by:

getSchemaVersionInfo in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

getLatestSchemaVersionInfo

public com.hortonworks.registries.schemaregistry.SchemaVersionInfo getLatestSchemaVersionInfo(java.lang.String schemaName)
                                                                                       throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

Specified by:

getLatestSchemaVersionInfo in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

getSchemaVersionInfo

public com.hortonworks.registries.schemaregistry.SchemaVersionInfo getSchemaVersionInfo(com.hortonworks.registries.schemaregistry.SchemaVersionKey schemaVersionKey)
                                                                                 throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

Specified by:

getSchemaVersionInfo in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

getLatestSchemaVersionInfo

public com.hortonworks.registries.schemaregistry.SchemaVersionInfo getLatestSchemaVersionInfo(java.lang.String schemaBranchName,
                                                                                              java.lang.String schemaName)
                                                                                       throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

Specified by:

getLatestSchemaVersionInfo in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

getAllVersions

public java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaVersionInfo> getAllVersions(java.lang.String schemaName)
                                                                                                 throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

Specified by:

getAllVersions in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

enableSchemaVersion

public void enableSchemaVersion(java.lang.Long schemaVersionId)
                         throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException,
                                com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException

Specified by:

enableSchemaVersion in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException

disableSchemaVersion

public void disableSchemaVersion(java.lang.Long schemaVersionId)
                          throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                 com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

Specified by:

disableSchemaVersion in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

deleteSchemaVersion

public void deleteSchemaVersion(java.lang.Long schemaVersionId)
                         throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

Specified by:

deleteSchemaVersion in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

archiveSchemaVersion

public void archiveSchemaVersion(java.lang.Long schemaVersionId)
                          throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                 com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

Specified by:

archiveSchemaVersion in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

startSchemaVersionReview

public void startSchemaVersionReview(java.lang.Long schemaVersionId)
                              throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                     com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

Specified by:

startSchemaVersionReview in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

mergeSchemaVersion

public com.hortonworks.registries.schemaregistry.SchemaVersionMergeResult mergeSchemaVersion(java.lang.Long schemaVersionId,
                                                                                             boolean disableCanonicalCheck)
                                                                                      throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                                                                             com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException

Specified by:

mergeSchemaVersion in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.errors.IncompatibleSchemaException

transitionState

public void transitionState(java.lang.Long schemaVersionId,
                            java.lang.Byte targetStateId,
                            byte[] transitionDetails)
                     throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                            com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

Specified by:

transitionState in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.state.SchemaLifecycleException

getSchemaVersionLifecycleStateMachineInfo

public com.hortonworks.registries.schemaregistry.state.SchemaVersionLifecycleStateMachineInfo getSchemaVersionLifecycleStateMachineInfo()

Specified by:

getSchemaVersionLifecycleStateMachineInfo in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

createSchemaBranch

public com.hortonworks.registries.schemaregistry.SchemaBranch createSchemaBranch(java.lang.Long schemaVersionId,
                                                                                 com.hortonworks.registries.schemaregistry.SchemaBranch schemaBranch)
                                                                          throws com.hortonworks.registries.schemaregistry.errors.SchemaBranchAlreadyExistsException,
                                                                                 com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

Specified by:

createSchemaBranch in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaBranchAlreadyExistsException

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

getSchemaBranches

public java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaBranch> getSchemaBranches(java.lang.String schemaName)
                                                                                               throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

Specified by:

getSchemaBranches in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

deleteSchemaBranch

public void deleteSchemaBranch(java.lang.Long schemaBranchId)
                        throws com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException,
                               com.hortonworks.registries.schemaregistry.errors.InvalidSchemaBranchDeletionException

Specified by:

deleteSchemaBranch in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

com.hortonworks.registries.schemaregistry.errors.InvalidSchemaBranchDeletionException

getAllVersions

public java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaVersionInfo> getAllVersions(java.lang.String schemaBranchName,
                                                                                                        java.lang.String schemaName,
                                                                                                        java.util.List<java.lang.Byte> stateIds)
                                                                                                 throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                                                                                        com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

Specified by:

getAllVersions in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

getAllVersions

public java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaVersionInfo> getAllVersions(java.lang.String schemaBranchName,
                                                                                                        java.lang.String schemaName)
                                                                                                 throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

Specified by:

getAllVersions in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

findAggregatedSchemas

public java.util.List<com.hortonworks.registries.schemaregistry.AggregatedSchemaMetadataInfo> findAggregatedSchemas(java.lang.String schemaName,
                                                                                                                    java.lang.String schemaDescription,
                                                                                                                    java.lang.String orderByFields)

Specified by:

findAggregatedSchemas in interface com.hortonworks.registries.schemaregistry.client.ISchemaRegistryClient

findAllSchemas

public java.util.List<com.hortonworks.registries.schemaregistry.SchemaMetadataInfo> findAllSchemas()

Specified by:

findAllSchemas in interface com.hortonworks.registries.schemaregistry.client.ISchemaRegistryClient

checkCompatibility

public com.hortonworks.registries.schemaregistry.CompatibilityResult checkCompatibility(java.lang.String schemaName,
                                                                                        java.lang.String toSchemaText)
                                                                                 throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                                                                        com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

Specified by:

checkCompatibility in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

checkCompatibility

public com.hortonworks.registries.schemaregistry.CompatibilityResult checkCompatibility(java.lang.String schemaBranchName,
                                                                                        java.lang.String schemaName,
                                                                                        java.lang.String toSchemaText)
                                                                                 throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

Specified by:

checkCompatibility in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

isCompatibleWithAllVersions

public boolean isCompatibleWithAllVersions(java.lang.String schemaName,
                                           java.lang.String toSchemaText)
                                    throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                           com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

Specified by:

isCompatibleWithAllVersions in interface com.hortonworks.registries.schemaregistry.client.ISchemaRegistryClient

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

isCompatibleWithAllVersions

public boolean isCompatibleWithAllVersions(java.lang.String schemaBranchName,
                                           java.lang.String schemaName,
                                           java.lang.String toSchemaText)
                                    throws com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException,
                                           com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

Specified by:

isCompatibleWithAllVersions in interface com.hortonworks.registries.schemaregistry.client.ISchemaRegistryClient

Throws:

com.hortonworks.registries.schemaregistry.errors.SchemaNotFoundException

com.hortonworks.registries.schemaregistry.errors.SchemaBranchNotFoundException

findSchemasByFields

public java.util.Collection<com.hortonworks.registries.schemaregistry.SchemaVersionKey> findSchemasByFields(com.hortonworks.registries.schemaregistry.SchemaFieldQuery schemaFieldQuery)

Specified by:

findSchemasByFields in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

uploadFile

public java.lang.String uploadFile(java.io.InputStream inputStream)

Specified by:

uploadFile in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

downloadFile

public java.io.InputStream downloadFile(java.lang.String fileId)

Specified by:

downloadFile in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

addSerDes

public java.lang.Long addSerDes(com.hortonworks.registries.schemaregistry.SerDesPair serDesPair)

Specified by:

addSerDes in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

mapSchemaWithSerDes

public void mapSchemaWithSerDes(java.lang.String schemaName,
                                java.lang.Long serDesId)

Specified by:

mapSchemaWithSerDes in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

getDefaultSerializer

public <T> T getDefaultSerializer(java.lang.String type)
                           throws com.hortonworks.registries.schemaregistry.serde.SerDesException

Specified by:

getDefaultSerializer in interface com.hortonworks.registries.schemaregistry.client.ISchemaRegistryClient

Throws:

com.hortonworks.registries.schemaregistry.serde.SerDesException

getDefaultDeserializer

public <T> T getDefaultDeserializer(java.lang.String type)
                             throws com.hortonworks.registries.schemaregistry.serde.SerDesException

Specified by:

getDefaultDeserializer in interface com.hortonworks.registries.schemaregistry.client.ISchemaRegistryClient

Throws:

com.hortonworks.registries.schemaregistry.serde.SerDesException

getSerDes

public java.util.Collection<com.hortonworks.registries.schemaregistry.SerDesInfo> getSerDes(java.lang.String schemaName)

Specified by:

getSerDes in interface com.hortonworks.registries.schemaregistry.ISchemaRegistryService

createSerializerInstance

public <T> T createSerializerInstance(com.hortonworks.registries.schemaregistry.SerDesInfo serDesInfo)

Specified by:

createSerializerInstance in interface com.hortonworks.registries.schemaregistry.client.ISchemaRegistryClient

createDeserializerInstance

public <T> T createDeserializerInstance(com.hortonworks.registries.schemaregistry.SerDesInfo serDesInfo)

Specified by:

createDeserializerInstance in interface com.hortonworks.registries.schemaregistry.client.ISchemaRegistryClient

close

public void close()

Closes the client and all open connections.

If Kerberos was enabled this will also close the Kerberos ticket management thread. We will wait up to 1 second for the thread to close. In case the thread doesn't shut down in time, you will see a warning in the logs.

Specified by:

close in interface java.lang.AutoCloseable

clientVersion

public com.hortonworks.registries.common.SchemaRegistryVersion clientVersion()