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()
default RecordSchema	retrieveSchema(long schemaId, int version) Deprecated. Use retrieveSchema(SchemaIdentifier) instead 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().
RecordSchema	retrieveSchema(SchemaIdentifier schemaIdentifier) Retrieves the schema based on the provided descriptor.
default RecordSchema	retrieveSchema(String schemaName) Deprecated. Use retrieveSchema(SchemaIdentifier) instead 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.
default String	retrieveSchemaText(long schemaId, int version) Deprecated. Use retrieveSchema(SchemaIdentifier) instead Retrieves the textual representation of the schema with the given ID and version
default String	retrieveSchemaText(String schemaName) Deprecated. Use retrieveSchema(SchemaIdentifier) instead 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, isStateful

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Method Detail

retrieveSchemaText

default String retrieveSchemaText(String schemaName)
                           throws IOException,
                                  SchemaNotFoundException

Deprecated. Use retrieveSchema(SchemaIdentifier) instead 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

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

Deprecated. Use retrieveSchema(SchemaIdentifier) instead 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

default RecordSchema retrieveSchema(String schemaName)
                             throws IOException,
                                    SchemaNotFoundException

Deprecated. Use retrieveSchema(SchemaIdentifier) instead 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

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

Deprecated. Use retrieveSchema(SchemaIdentifier) instead 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

retrieveSchema

RecordSchema retrieveSchema(SchemaIdentifier schemaIdentifier)
                     throws IOException,
                            SchemaNotFoundException

Retrieves the schema based on the provided descriptor. The descriptor must contain and schemaIdentifier or name, but not both, along with a version, and an optional branch name. For implementations that do not support branching, the branch name will be ignored.

Parameters:

schemaIdentifier - a schema schemaIdentifier

Returns:

the schema for the given descriptor

Throws:

IOException - if unable to communicate with the backing store

SchemaNotFoundException - if unable to find the schema based on the given descriptor

getSuppliedSchemaFields

Set<SchemaField> getSuppliedSchemaFields()

Returns:

the set of all Schema Fields that are supplied by the RecordSchema that is returned from retrieveSchema(SchemaIdentifier)