com.ibm.eventstreams.serdes

Class SchemaRegistry

java.lang.Object

com.ibm.eventstreams.serdes.SchemaRegistry

public class SchemaRegistry
extends Object

Helper class for retrieving schema definitions from the Schema Registry.

Constructor Summary

Constructors

Constructor and Description
SchemaRegistry(Properties properties)
SchemaRegistry(String apiurl, String apikey, boolean skipSslValidation)

Method Summary

Modifier and Type	Method and Description
SchemaInfo	getDefaultSchema() Get the default schema as determined by the SchemaRegistryConfig.PROPERTY_SCHEMA_ID_OVERRIDE and SchemaRegistryConfig.PROPERTY_SCHEMA_VERSION_OVERRIDE configuration options.
org.apache.kafka.common.header.Headers	getOverrideHeaders() Get the Kafka headers for the default schema as determined by the SchemaRegistryConfig.PROPERTY_SCHEMA_ID_OVERRIDE and SchemaRegistryConfig.PROPERTY_SCHEMA_VERSION_OVERRIDE configuration options.
SchemaInfo	getSchema(String schemaId, int versionId) Retrieves a single schema from the Registry.
SchemaInfo	getSchema(String schemaName, String versionName) Retrieves a single schema from the Registry.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaRegistry

public SchemaRegistry(Properties properties)
               throws KeyManagementException,
                      NoSuchAlgorithmException,
                      SchemaRegistryAuthException,
                      SchemaRegistryServerErrorException,
                      SchemaRegistryApiException,
                      SchemaRegistryConnectionException,
                      SchemaNotFoundException,
                      PropertyNotFoundException,
                      InvalidPropertyValueException

Parameters:

properties - a set of configuration properties

Throws:

KeyManagementException - in the event of a failure to configure TLS for the connection to the Schema Registry

NoSuchAlgorithmException - in the event of a failure to configure TLS for the connection to the Schema Registry

SchemaRegistryAuthException - if there is a problem with the provided API key

SchemaRegistryServerErrorException - if the Schema Registry REST API returns an HTTP 500 Internal Server Error

SchemaRegistryApiException - in the event of an unexpected response from the Schema Registry

SchemaRegistryConnectionException - in the event of a failure to connect to the Schema Registry (e.g. a socket timeout)

PropertyNotFoundException - in the event a required property is not specified

InvalidPropertyValueException - in the event of a property set to an invalid value

SchemaNotFoundException

SchemaRegistry

public SchemaRegistry(String apiurl,
                      String apikey,
                      boolean skipSslValidation)
               throws KeyManagementException,
                      NoSuchAlgorithmException,
                      SchemaRegistryAuthException,
                      SchemaRegistryApiException,
                      SchemaRegistryServerErrorException,
                      SchemaRegistryConnectionException

Parameters:

apiurl - url for the Event Streams REST API

apikey - API key for use in accessing the Event Streams REST API

skipSslValidation - if true, the hostname will not be verified in certificates used for the TLS connection to the Schema Registry REST API. Available for use when the Event Streams installation is using a self-signed certificate.

Throws:

KeyManagementException - in the event of a failure to configure TLS for the connection to the Schema Registry

NoSuchAlgorithmException - in the event of a failure to configure TLS for the connection to the Schema Registry

SchemaRegistryAuthException - if there is a problem with the provided API key

SchemaRegistryServerErrorException - if the Schema Registry REST API returns an HTTP 500 Internal Server Error

SchemaRegistryApiException - in the event of an unexpected response from the Schema Registry

SchemaRegistryConnectionException - in the event of a failure to connect to the Schema Registry (e.g. a socket timeout)

Method Detail

getSchema

public SchemaInfo getSchema(String schemaId,
                            int versionId)
                     throws SchemaNotFoundException,
                            SchemaRegistryAuthException,
                            SchemaRegistryApiException,
                            SchemaRegistryServerErrorException,
                            SchemaRegistryConnectionException

Retrieves a single schema from the Registry.

Parameters:

schemaId - ID of the schema to retrieve

versionId - integer value version ID of the schema to retrieve

Throws:

SchemaNotFoundException - if the schema (or version) does not exist

SchemaRegistryAuthException - if an auth error prevented the schema being fetched

SchemaRegistryServerErrorException - if the Schema Registry failed to retrieve the schema

SchemaRegistryApiException - in the event of an unexpected response from the Schema Registry

SchemaRegistryConnectionException - in the event of a failure to connect to the Schema Registry (e.g. a socket timeout)

getSchema

public SchemaInfo getSchema(String schemaName,
                            String versionName)
                     throws SchemaNotFoundException,
                            SchemaRegistryAuthException,
                            SchemaRegistryApiException,
                            SchemaRegistryServerErrorException,
                            SchemaRegistryConnectionException

Retrieves a single schema from the Registry. This method is available to improve usability, allowing developers to get schemas based on the original name and version set, this method is not used internally by the serializer/deserializer.

Parameters:

schemaName - unique name of the schema to retrieve

versionName - version name of the schema to retrieve

Throws:

SchemaNotFoundException - if the schema (or version) does not exist

SchemaRegistryAuthException - if an auth error prevented the schema being fetched

SchemaRegistryServerErrorException - if the Schema Registry failed to retrieve the schema

SchemaRegistryApiException - in the event of an unexpected response from the Schema Registry

SchemaRegistryConnectionException - in the event of a failure to connect to the Schema Registry (e.g. a socket timeout)

getDefaultSchema

public SchemaInfo getDefaultSchema()

Get the default schema as determined by the SchemaRegistryConfig.PROPERTY_SCHEMA_ID_OVERRIDE and SchemaRegistryConfig.PROPERTY_SCHEMA_VERSION_OVERRIDE configuration options.

Returns:

The SchemaInfo for the default schema

getOverrideHeaders

public org.apache.kafka.common.header.Headers getOverrideHeaders()

Get the Kafka headers for the default schema as determined by the SchemaRegistryConfig.PROPERTY_SCHEMA_ID_OVERRIDE and SchemaRegistryConfig.PROPERTY_SCHEMA_VERSION_OVERRIDE configuration options.

Returns:

the Headers for the default schema