lkuchars commented on code in PR #10214: URL: https://github.com/apache/nifi/pull/10214#discussion_r2286443527
########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,296 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaAccessStrategy; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.MessageNameResolverService; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageName; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import static org.apache.commons.codec.digest.DigestUtils.sha256Hex; +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .displayName("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .displayName("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") + .displayName("Message Name Resolver Service") + .description("Controller service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") + .required(true) + .identifiesControllerService(MessageNameResolverService.class) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE) + .build(); + + volatile ProtobufSchemaCompiler schemaCompiler; + volatile MessageNameResolver messageNameResolver; + volatile SchemaReferenceReader schemaReferenceReader; + volatile SchemaRegistry schemaRegistry; + volatile String schemaAccessStrategyValue; + volatile PropertyValue schemaText; + volatile PropertyValue schemaName; + volatile PropertyValue schemaBranchName; + volatile PropertyValue schemaVersion; + + + @OnEnabled + public void onEnabled(final ConfigurationContext context) { + super.storeSchemaAccessStrategy(context); + setupMessageNameResolver(context); + schemaAccessStrategyValue = context.getProperty(SCHEMA_ACCESS_STRATEGY).getValue(); + schemaReferenceReader = context.getProperty(SCHEMA_REFERENCE_READER).asControllerService(SchemaReferenceReader.class); + schemaRegistry = context.getProperty(SCHEMA_REGISTRY).asControllerService(SchemaRegistry.class); + schemaName = context.getProperty(SCHEMA_NAME); + schemaText = context.getProperty(SCHEMA_TEXT); + schemaBranchName = context.getProperty(SCHEMA_BRANCH_NAME); + schemaVersion = context.getProperty(SCHEMA_VERSION); + schemaCompiler = new ProtobufSchemaCompiler(getLogger()); + + } + + @OnDisabled + public void onDisabled(final ConfigurationContext context) { + if (schemaCompiler != null) { + schemaCompiler.invalidateCache(); + schemaCompiler = null; + } + } + + @Override + public RecordReader createRecordReader(final Map<String, String> variables, final InputStream in, final long inputLength, final ComponentLog logger) throws IOException, SchemaNotFoundException { + final SchemaAccessStrategy schemaAccessStrategy = getSchemaAccessStrategy(); + if (SCHEMA_TEXT_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromText(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_NAME_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromRegistry(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_REFERENCE_READER_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaIdentifier schemaIdentifier = schemaReferenceReader.getSchemaIdentifier(variables, in); + final SchemaDefinition schemaDefinition = schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + if (logger.isDebugEnabled()) { + logger.debug("Using message name for schema: {}", schemaDefinition.getIdentifier()); + } + return createProtobufRecordReader(variables, in, schemaDefinition); + } + + throw new SchemaNotFoundException("Unsupported schema access strategy: " + schemaAccessStrategy.getClass().getName()); + } + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + final List<PropertyDescriptor> properties = new ArrayList<>(super.getSupportedPropertyDescriptors()); + properties.add(MESSAGE_NAME_RESOLVER_STRATEGY); + properties.add(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + properties.add(MESSAGE_NAME); + return properties; + } + + @Override + protected PropertyDescriptor buildSchemaTextProperty() { + return new PropertyDescriptor.Builder() + .fromPropertyDescriptor(SCHEMA_TEXT) + .required(true) + .clearValidators() + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .defaultValue("${proto.schema}") + .description("The text of a Proto 3 formatted Schema") + .build(); + } + + private RecordReader createProtobufRecordReader(final Map<String, String> variables, final InputStream in, final SchemaDefinition schemaDefinition) throws IOException { + final Schema schema = schemaCompiler.compileOrGetFromCache(schemaDefinition); + final ProtoSchemaParser schemaParser = new ProtoSchemaParser(schema); + final MessageName messageName = messageNameResolver.getMessageName(variables, schemaDefinition, in); + final RecordSchema recordSchema = schemaParser.createSchema(messageName.getFullyQualifiedName()); + return new ProtobufRecordReader(schema, messageName.getFullyQualifiedName(), in, recordSchema); + } + + + private void setupMessageNameResolver(final ConfigurationContext context) { + final MessageNameResolverStrategyName messageNameResolverStrategyName = context.getProperty(MESSAGE_NAME_RESOLVER_STRATEGY).asAllowableValue(MessageNameResolverStrategyName.class); + switch (messageNameResolverStrategyName) { + case MESSAGE_NAME_PROPERTY -> messageNameResolver = new PropertyMessageNameResolver(context); + case MESSAGE_NAME_RESOLVER_SERVICE -> messageNameResolver = context.getProperty(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE).asControllerService(MessageNameResolverService.class); + } + } + + private SchemaDefinition createSchemaDefinitionFromText(final Map<String, String> variables) throws SchemaNotFoundException { + final String schemaTextString = schemaText.evaluateAttributeExpressions(variables).getValue(); + validateSchemaText(schemaTextString); + + final String sha256hex = sha256Hex(schemaTextString); + final SchemaIdentifier schemaIdentifier = SchemaIdentifier.builder() + .name(sha256hex + ".proto") + .build(); + + return new StandardSchemaDefinition(schemaIdentifier, schemaTextString, SchemaDefinition.SchemaType.PROTOBUF); + } + + private SchemaDefinition createSchemaDefinitionFromRegistry(final Map<String, String> variables) throws SchemaNotFoundException, IOException { + final String schemaNameValue = schemaName.evaluateAttributeExpressions(variables).getValue(); + validateSchemaName(schemaNameValue); + + final String schemaBranchNameValue = schemaBranchName.evaluateAttributeExpressions(variables).getValue(); + final String schemaVersionValue = schemaVersion.evaluateAttributeExpressions(variables).getValue(); + + final SchemaIdentifier schemaIdentifier = buildSchemaIdentifier(schemaNameValue, schemaBranchNameValue, schemaVersionValue); + return schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + } + + private SchemaIdentifier buildSchemaIdentifier(final String schemaNameValue, final String schemaBranchNameValue, final String schemaVersionValue) throws SchemaNotFoundException { + final SchemaIdentifier.Builder identifierBuilder = SchemaIdentifier.builder().name(schemaNameValue); + + if (schemaBranchNameValue != null && !schemaBranchNameValue.isBlank()) { + identifierBuilder.branch(schemaBranchNameValue); + } + + if (schemaVersionValue != null && !schemaVersionValue.isBlank()) { + try { + identifierBuilder.version(Integer.valueOf(schemaVersionValue)); + } catch (final NumberFormatException nfe) { + throw new SchemaNotFoundException("Could not retrieve schema with name '" + schemaNameValue + + "' because a non-numeric version was supplied '" + schemaVersionValue + "'", nfe); + } + } + + return identifierBuilder.build(); + } + + private void validateSchemaText(final String schemaTextString) throws SchemaNotFoundException { + if (schemaTextString == null || schemaTextString.isBlank()) { + throw new SchemaNotFoundException("Schema text not found"); + } + } + + private void validateSchemaName(final String schemaNameValue) throws SchemaNotFoundException { + if (schemaNameValue == null || schemaNameValue.isBlank()) { + throw new SchemaNotFoundException("Schema name not provided or is blank"); + } + } + + void validateSchemaDefinitionIdentifiers(final SchemaDefinition schemaDefinition) { Review Comment: Refactored. Moved to utility class. ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,296 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaAccessStrategy; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.MessageNameResolverService; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageName; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import static org.apache.commons.codec.digest.DigestUtils.sha256Hex; +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .displayName("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .displayName("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") + .displayName("Message Name Resolver Service") + .description("Controller service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") + .required(true) + .identifiesControllerService(MessageNameResolverService.class) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE) + .build(); + + volatile ProtobufSchemaCompiler schemaCompiler; + volatile MessageNameResolver messageNameResolver; + volatile SchemaReferenceReader schemaReferenceReader; + volatile SchemaRegistry schemaRegistry; + volatile String schemaAccessStrategyValue; + volatile PropertyValue schemaText; + volatile PropertyValue schemaName; + volatile PropertyValue schemaBranchName; + volatile PropertyValue schemaVersion; + + + @OnEnabled + public void onEnabled(final ConfigurationContext context) { + super.storeSchemaAccessStrategy(context); + setupMessageNameResolver(context); + schemaAccessStrategyValue = context.getProperty(SCHEMA_ACCESS_STRATEGY).getValue(); + schemaReferenceReader = context.getProperty(SCHEMA_REFERENCE_READER).asControllerService(SchemaReferenceReader.class); + schemaRegistry = context.getProperty(SCHEMA_REGISTRY).asControllerService(SchemaRegistry.class); + schemaName = context.getProperty(SCHEMA_NAME); + schemaText = context.getProperty(SCHEMA_TEXT); + schemaBranchName = context.getProperty(SCHEMA_BRANCH_NAME); + schemaVersion = context.getProperty(SCHEMA_VERSION); + schemaCompiler = new ProtobufSchemaCompiler(getLogger()); + + } + + @OnDisabled + public void onDisabled(final ConfigurationContext context) { + if (schemaCompiler != null) { + schemaCompiler.invalidateCache(); + schemaCompiler = null; + } + } + + @Override + public RecordReader createRecordReader(final Map<String, String> variables, final InputStream in, final long inputLength, final ComponentLog logger) throws IOException, SchemaNotFoundException { + final SchemaAccessStrategy schemaAccessStrategy = getSchemaAccessStrategy(); + if (SCHEMA_TEXT_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromText(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_NAME_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromRegistry(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_REFERENCE_READER_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaIdentifier schemaIdentifier = schemaReferenceReader.getSchemaIdentifier(variables, in); + final SchemaDefinition schemaDefinition = schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + if (logger.isDebugEnabled()) { + logger.debug("Using message name for schema: {}", schemaDefinition.getIdentifier()); + } + return createProtobufRecordReader(variables, in, schemaDefinition); + } + + throw new SchemaNotFoundException("Unsupported schema access strategy: " + schemaAccessStrategy.getClass().getName()); + } + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + final List<PropertyDescriptor> properties = new ArrayList<>(super.getSupportedPropertyDescriptors()); + properties.add(MESSAGE_NAME_RESOLVER_STRATEGY); + properties.add(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + properties.add(MESSAGE_NAME); + return properties; + } + + @Override + protected PropertyDescriptor buildSchemaTextProperty() { + return new PropertyDescriptor.Builder() + .fromPropertyDescriptor(SCHEMA_TEXT) + .required(true) + .clearValidators() + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .defaultValue("${proto.schema}") + .description("The text of a Proto 3 formatted Schema") + .build(); + } + + private RecordReader createProtobufRecordReader(final Map<String, String> variables, final InputStream in, final SchemaDefinition schemaDefinition) throws IOException { + final Schema schema = schemaCompiler.compileOrGetFromCache(schemaDefinition); + final ProtoSchemaParser schemaParser = new ProtoSchemaParser(schema); + final MessageName messageName = messageNameResolver.getMessageName(variables, schemaDefinition, in); + final RecordSchema recordSchema = schemaParser.createSchema(messageName.getFullyQualifiedName()); + return new ProtobufRecordReader(schema, messageName.getFullyQualifiedName(), in, recordSchema); + } + + + private void setupMessageNameResolver(final ConfigurationContext context) { + final MessageNameResolverStrategyName messageNameResolverStrategyName = context.getProperty(MESSAGE_NAME_RESOLVER_STRATEGY).asAllowableValue(MessageNameResolverStrategyName.class); + switch (messageNameResolverStrategyName) { + case MESSAGE_NAME_PROPERTY -> messageNameResolver = new PropertyMessageNameResolver(context); + case MESSAGE_NAME_RESOLVER_SERVICE -> messageNameResolver = context.getProperty(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE).asControllerService(MessageNameResolverService.class); + } + } + + private SchemaDefinition createSchemaDefinitionFromText(final Map<String, String> variables) throws SchemaNotFoundException { + final String schemaTextString = schemaText.evaluateAttributeExpressions(variables).getValue(); + validateSchemaText(schemaTextString); + + final String sha256hex = sha256Hex(schemaTextString); + final SchemaIdentifier schemaIdentifier = SchemaIdentifier.builder() + .name(sha256hex + ".proto") + .build(); + + return new StandardSchemaDefinition(schemaIdentifier, schemaTextString, SchemaDefinition.SchemaType.PROTOBUF); + } + + private SchemaDefinition createSchemaDefinitionFromRegistry(final Map<String, String> variables) throws SchemaNotFoundException, IOException { + final String schemaNameValue = schemaName.evaluateAttributeExpressions(variables).getValue(); + validateSchemaName(schemaNameValue); + + final String schemaBranchNameValue = schemaBranchName.evaluateAttributeExpressions(variables).getValue(); + final String schemaVersionValue = schemaVersion.evaluateAttributeExpressions(variables).getValue(); + + final SchemaIdentifier schemaIdentifier = buildSchemaIdentifier(schemaNameValue, schemaBranchNameValue, schemaVersionValue); + return schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + } + + private SchemaIdentifier buildSchemaIdentifier(final String schemaNameValue, final String schemaBranchNameValue, final String schemaVersionValue) throws SchemaNotFoundException { + final SchemaIdentifier.Builder identifierBuilder = SchemaIdentifier.builder().name(schemaNameValue); + + if (schemaBranchNameValue != null && !schemaBranchNameValue.isBlank()) { + identifierBuilder.branch(schemaBranchNameValue); + } + + if (schemaVersionValue != null && !schemaVersionValue.isBlank()) { + try { + identifierBuilder.version(Integer.valueOf(schemaVersionValue)); + } catch (final NumberFormatException nfe) { + throw new SchemaNotFoundException("Could not retrieve schema with name '" + schemaNameValue + + "' because a non-numeric version was supplied '" + schemaVersionValue + "'", nfe); + } + } + + return identifierBuilder.build(); + } + + private void validateSchemaText(final String schemaTextString) throws SchemaNotFoundException { + if (schemaTextString == null || schemaTextString.isBlank()) { + throw new SchemaNotFoundException("Schema text not found"); + } + } + + private void validateSchemaName(final String schemaNameValue) throws SchemaNotFoundException { + if (schemaNameValue == null || schemaNameValue.isBlank()) { + throw new SchemaNotFoundException("Schema name not provided or is blank"); + } + } + + void validateSchemaDefinitionIdentifiers(final SchemaDefinition schemaDefinition) { + schemaCompiler.validateSchemaDefinitionIdentifiers(schemaDefinition, true); + } + + enum MessageNameResolverStrategyName implements DescribedValue { + + MESSAGE_NAME_PROPERTY("Message Name Property", "Use the 'Message Name' property value to determine the message name"), + MESSAGE_NAME_RESOLVER_SERVICE("Message Name Resolver Service", "Use a 'Message Name Resolver' controller service to dynamically determine the message name"); + + private final String name; Review Comment: Fixed -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
