org.apache.nifi.schemaregistry.services

Interface SchemaRegistry

All Superinterfaces:

ConfigurableComponent, ControllerService

public interface SchemaRegistry
extends ControllerService

Represents ControllerService strategy to expose internal and/or integrate with external Schema Registry

Method Summary

Modifier and Type	Method and Description
Set<SchemaField>	getSuppliedSchemaFields()
RecordSchema	retrieveSchema(long schemaId, int version) Retrieves the schema with the given ID and version.
RecordSchema	retrieveSchema(String schemaName) Retrieves and returns the RecordSchema based on the provided name of the schema available in Schema Registry.
String	retrieveSchemaText(long schemaId, int version) Retrieves the textual representation of the schema with the given ID and version
String	retrieveSchemaText(String schemaName) Retrieves and returns the textual representation of the schema based on the provided name of the schema available in Schema Registry.

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Method Detail

retrieveSchemaText

String retrieveSchemaText(String schemaName)
                   throws IOException,
                          SchemaNotFoundException

Retrieves and returns the textual representation of the schema based on the provided name of the schema available in Schema Registry.

Returns:

the text that corresponds to the latest version of the schema with the given name

Throws:

IOException - if unable to communicate with the backing store

SchemaNotFoundException - if unable to find the schema with the given name

retrieveSchemaText

String retrieveSchemaText(long schemaId,
                          int version)
                   throws IOException,
                          SchemaNotFoundException

Retrieves the textual representation of the schema with the given ID and version

Parameters:

schemaId - the unique identifier for the desired schema

version - the version of the desired schema

Returns:

the textual representation of the schema with the given ID and version

Throws:

IOException - if unable to communicate with the backing store

SchemaNotFoundException - if unable to find the schema with the given id and version

retrieveSchema

RecordSchema retrieveSchema(String schemaName)
                     throws IOException,
                            SchemaNotFoundException

Retrieves and returns the RecordSchema based on the provided name of the schema available in Schema Registry. The RecordSchema that is returned must have the Schema's name populated in its SchemaIdentifier. I.e., a call to RecordSchema.getIdentifier().getName() will always return an Optional that is not empty.

Returns:

the latest version of the schema with the given name, or null if no schema can be found with the given name.

Throws:

SchemaNotFoundException - if unable to find the schema with the given name

IOException

retrieveSchema

RecordSchema retrieveSchema(long schemaId,
                            int version)
                     throws IOException,
                            SchemaNotFoundException

Retrieves the schema with the given ID and version. The RecordSchema that is returned must have the Schema's identifier and version populated in its SchemaIdentifier. I.e., a call to RecordSchema.getIdentifier().getIdentifier() will always return an Optional that is not empty, as will a call to RecordSchema.getIdentifier().getVersion().

Parameters:

schemaId - the unique identifier for the desired schema

version - the version of the desired schema

Returns:

the schema with the given ID and version or null if no schema can be found with the given ID and version

Throws:

IOException - if unable to communicate with the backing store

SchemaNotFoundException - if unable to find the schema with the given id and version

getSuppliedSchemaFields

Set<SchemaField> getSuppliedSchemaFields()

Returns:

the set of all Schema Fields that are supplied by the RecordSchema that is returned from retrieveSchema(String) and retrieveSchema(long, int)