turcsanyip commented on code in PR #6279: URL: https://github.com/apache/nifi/pull/6279#discussion_r949435611
########## nifi-nar-bundles/nifi-smb-bundle/nifi-smb-processors/src/main/java/org/apache/nifi/processors/smb/FetchSmb.java: ########## @@ -0,0 +1,230 @@ +/* + * 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.processors.smb; + +import static java.util.Arrays.asList; +import static org.apache.nifi.processor.util.StandardValidators.NON_EMPTY_EL_VALIDATOR; + +import java.io.IOException; +import java.io.InputStream; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Optional; +import java.util.Set; +import org.apache.nifi.annotation.behavior.InputRequirement; +import org.apache.nifi.annotation.behavior.WritesAttribute; +import org.apache.nifi.annotation.behavior.WritesAttributes; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.SeeAlso; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyDescriptor.Builder; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.expression.ExpressionLanguageScope; +import org.apache.nifi.flowfile.FlowFile; +import org.apache.nifi.processor.AbstractProcessor; +import org.apache.nifi.processor.ProcessContext; +import org.apache.nifi.processor.ProcessSession; +import org.apache.nifi.processor.Relationship; +import org.apache.nifi.processor.exception.ProcessException; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.serialization.MalformedRecordException; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.record.Record; +import org.apache.nifi.services.smb.SmbClientProviderService; +import org.apache.nifi.services.smb.SmbClientService; +import org.apache.nifi.services.smb.SmbException; + +@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED) +@Tags({"samba, smb, cifs, files", "fetch"}) +@CapabilityDescription("Fetches files from a SMB Share. Designed to be used in tandem with ListSmb.") +@SeeAlso({ListSmb.class, PutSmbFile.class, GetSmbFile.class}) +@WritesAttributes({ + @WritesAttribute(attribute = FetchSmb.ERROR_CODE_ATTRIBUTE, description = "The error code returned by SMB when the fetch of a file fails"), + @WritesAttribute(attribute = FetchSmb.ERROR_MESSAGE_ATTRIBUTE, description = "The error message returned by SMB when the fetch of a file fails") +}) +public class FetchSmb extends AbstractProcessor { + + public static final String ERROR_CODE_ATTRIBUTE = "error.code"; + public static final String ERROR_MESSAGE_ATTRIBUTE = "error.message"; + + public static final PropertyDescriptor REMOTE_FILE = new PropertyDescriptor + .Builder().name("remote-file") + .displayName("Remote File") + .description("The full path of the file to be retrieved from the remote server.") + .required(true) + .defaultValue("${absolute.path}/${filename}") + .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) + .addValidator(NON_EMPTY_EL_VALIDATOR) + .build(); + + public static final PropertyDescriptor REMOTE_FILE_FIELD = new PropertyDescriptor + .Builder().name("remote-file-field") + .displayName("Remote File Field") + .description("The name of the filed in a record to use as the remote file name. This field is being used " + + "when record reader is set.") + .required(true) + .defaultValue("identifier") + .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) + .addValidator(NON_EMPTY_EL_VALIDATOR) + .build(); + + public static final PropertyDescriptor SMB_CLIENT_PROVIDER_SERVICE = new Builder() + .name("smb-client-provider-service") + .displayName("SMB Client Provider Service") + .description("Specifies the SMB client provider to use for creating SMB connections.") + .required(true) + .identifiesControllerService(SmbClientProviderService.class) + .build(); + + static final PropertyDescriptor RECORD_READER = new PropertyDescriptor.Builder() + .name("record-reader") + .displayName("Record Reader") + .description( + "Specifies the Controller Service to use for reading incoming NiFi Records. Each record should contain \"identifier\"" + + " attribute set to the path and name of the file to fetch." + + " If not set, the Processor expects as attributes of a separate flowfile for each File to fetch.") + .identifiesControllerService(RecordReaderFactory.class) + .required(false) + .build(); + + public static final Relationship REL_SUCCESS = + new Relationship.Builder() + .name("success") + .description("A flowfile will be routed here for each successfully fetched File.") + .build(); + + public static final Relationship REL_FAILURE = + new Relationship.Builder().name("failure") + .description( + "A flowfile will be routed here for each File for which fetch was attempted but failed.") + .build(); + + public static final Relationship REL_INPUT_FAILURE = + new Relationship.Builder().name("input_failure") + .description("The incoming flowfile will be routed here if its content could not be processed.") + .build(); + + public static final Set<Relationship> relationships = Collections.unmodifiableSet(new HashSet<>(asList( + REL_SUCCESS, + REL_FAILURE, + REL_INPUT_FAILURE + ))); + + private static final List<PropertyDescriptor> PROPERTIES = asList( + REMOTE_FILE, + REMOTE_FILE_FIELD, + SMB_CLIENT_PROVIDER_SERVICE, + RECORD_READER + ); + + @Override + public Set<Relationship> getRelationships() { + return relationships; + } + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + return PROPERTIES; + } + + @Override + public void onTrigger(ProcessContext context, ProcessSession session) throws ProcessException { + FlowFile flowFile = session.get(); + if (flowFile == null) { + return; + } + + boolean shouldDeleteFlowFile = false; + + final SmbClientProviderService clientProviderService = + context.getProperty(SMB_CLIENT_PROVIDER_SERVICE).asControllerService(SmbClientProviderService.class); + + try (SmbClientService client = clientProviderService.getClient()) { + + if (context.getProperty(RECORD_READER).isSet()) { + final RecordReaderFactory recordReaderFactory = + context.getProperty(RECORD_READER).asControllerService(RecordReaderFactory.class); + + try (InputStream inFlowFile = session.read(flowFile); + RecordReader reader = recordReaderFactory.createRecordReader(flowFile, inFlowFile, getLogger()) + ) { + final String fieldName = context.getProperty(REMOTE_FILE_FIELD).getValue(); + Record record; + while ((record = reader.nextRecord()) != null) { + final String fileName = record.getAsString(fieldName); + final FlowFile outFlowFile = session.create(flowFile); + fetchAndTransfer(session, client, outFlowFile, fileName); + } + shouldDeleteFlowFile = true; + } catch (Exception e) { + handleInputError(e, session, flowFile); + } Review Comment: In case of "input error", the session needs to be rolled back I think, because some FFs might have already been processed and sent to SUCCESS/FAILURE. After rollback, the original FF can be sent to REL_INPUT_FAILURE. In "input error" case, I think only this output needs to be produced. -- 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]
