You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2021/10/25 14:08:06 UTC
[GitHub] [nifi] markap14 commented on a change in pull request #5471: NIFI-9308: Created EmailRecordSinkService for Reporting Tasks
markap14 commented on a change in pull request #5471:
URL: https://github.com/apache/nifi/pull/5471#discussion_r735637400
##########
File path: nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/main/java/org/apache/nifi/record/sink/EmailRecordSink.java
##########
@@ -0,0 +1,360 @@
+/*
+ * 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.record.sink;
+
+import org.apache.nifi.annotation.lifecycle.OnEnabled;
+import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.components.ValidationContext;
+import org.apache.nifi.components.ValidationResult;
+import org.apache.nifi.controller.AbstractControllerService;
+import org.apache.nifi.controller.ConfigurationContext;
+import org.apache.nifi.expression.ExpressionLanguageScope;
+import org.apache.nifi.processor.exception.ProcessException;
+import org.apache.nifi.processor.util.StandardValidators;
+import org.apache.nifi.schema.access.SchemaNotFoundException;
+import org.apache.nifi.serialization.RecordSetWriter;
+import org.apache.nifi.serialization.RecordSetWriterFactory;
+import org.apache.nifi.serialization.WriteResult;
+import org.apache.nifi.serialization.record.Record;
+import org.apache.nifi.serialization.record.RecordSet;
+
+import javax.mail.Authenticator;
+import javax.mail.Message;
+import javax.mail.MessagingException;
+import javax.mail.PasswordAuthentication;
+import javax.mail.Session;
+import javax.mail.Transport;
+import javax.mail.internet.AddressException;
+import javax.mail.internet.InternetAddress;
+import javax.mail.internet.MimeMessage;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Properties;
+
+public class EmailRecordSink extends AbstractControllerService implements RecordSinkService {
+
+ public static final PropertyDescriptor SMTP_HOSTNAME = new PropertyDescriptor.Builder()
+ .name("SMTP Hostname")
+ .description("The hostname of the SMTP Server that is used to send Email Notifications")
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .required(true)
+ .build();
+ public static final PropertyDescriptor SMTP_PORT = new PropertyDescriptor.Builder()
+ .name("SMTP Port")
+ .description("The Port used for SMTP communications")
+ .required(true)
+ .defaultValue("25")
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.PORT_VALIDATOR)
+ .build();
+ public static final PropertyDescriptor SMTP_USERNAME = new PropertyDescriptor.Builder()
+ .name("SMTP Username")
+ .description("Username for the SMTP account")
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .required(false)
+ .build();
+ public static final PropertyDescriptor SMTP_PASSWORD = new PropertyDescriptor.Builder()
+ .name("SMTP Password")
+ .description("Password for the SMTP account")
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .required(false)
+ .sensitive(true)
+ .build();
+ public static final PropertyDescriptor SMTP_AUTH = new PropertyDescriptor.Builder()
+ .name("SMTP Auth")
+ .description("Flag indicating whether authentication should be used")
+ .required(true)
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.BOOLEAN_VALIDATOR)
+ .defaultValue("true")
+ .build();
+ public static final PropertyDescriptor SMTP_TLS = new PropertyDescriptor.Builder()
+ .name("SMTP TLS")
+ .description("Flag indicating whether TLS should be enabled")
+ .required(true)
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.BOOLEAN_VALIDATOR)
+ .defaultValue("false")
+ .build();
+ public static final PropertyDescriptor SMTP_SOCKET_FACTORY = new PropertyDescriptor.Builder()
+ .name("SMTP Socket Factory")
+ .description("Socket Factory to use for SMTP Connection")
+ .required(true)
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .defaultValue("javax.net.ssl.SSLSocketFactory")
+ .build();
+ public static final PropertyDescriptor HEADER_XMAILER = new PropertyDescriptor.Builder()
+ .name("SMTP X-Mailer Header")
+ .description("X-Mailer used in the header of the outgoing email")
+ .required(true)
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .defaultValue("NiFi")
+ .build();
+ public static final PropertyDescriptor CONTENT_TYPE = new PropertyDescriptor.Builder()
+ .name("Content Type")
+ .description("Mime Type used to interpret the contents of the email, such as text/plain or text/html")
+ .required(true)
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .defaultValue("text/plain")
+ .build();
+ public static final PropertyDescriptor FROM = new PropertyDescriptor.Builder()
+ .name("From")
+ .description("Specifies the Email address to use as the sender")
+ .required(true)
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .build();
+ public static final PropertyDescriptor TO = new PropertyDescriptor.Builder()
+ .name("To")
+ .description("The recipients to include in the To-Line of the email")
+ .required(false)
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .build();
+ public static final PropertyDescriptor CC = new PropertyDescriptor.Builder()
+ .name("CC")
+ .description("The recipients to include in the CC-Line of the email")
+ .required(false)
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .build();
+ public static final PropertyDescriptor BCC = new PropertyDescriptor.Builder()
+ .name("BCC")
+ .description("The recipients to include in the BCC-Line of the email")
+ .required(false)
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .build();
+ public static final PropertyDescriptor SUBJECT = new PropertyDescriptor.Builder()
+ .name("Subject")
+ .description("The email subject")
+ .required(true)
+ .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY)
+ .defaultValue("Message from NiFi")
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .build();
+
+ private volatile RecordSetWriterFactory writerFactory;
+
+ /**
+ * Mapping of the mail properties to the NiFi PropertyDescriptors that will be evaluated at runtime
+ */
+ private static final Map<String, PropertyDescriptor> propertyToContext = new HashMap<>();
+
+ static {
+ propertyToContext.put("mail.smtp.host", SMTP_HOSTNAME);
+ propertyToContext.put("mail.smtp.port", SMTP_PORT);
+ propertyToContext.put("mail.smtp.socketFactory.port", SMTP_PORT);
+ propertyToContext.put("mail.smtp.socketFactory.class", SMTP_SOCKET_FACTORY);
+ propertyToContext.put("mail.smtp.auth", SMTP_AUTH);
+ propertyToContext.put("mail.smtp.starttls.enable", SMTP_TLS);
+ propertyToContext.put("mail.smtp.user", SMTP_USERNAME);
+ propertyToContext.put("mail.smtp.password", SMTP_PASSWORD);
+ }
+
+ @Override
+ protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
+ return Collections.unmodifiableList(Arrays.asList(
+ RecordSinkService.RECORD_WRITER_FACTORY,
+ SMTP_HOSTNAME,
+ SMTP_PORT,
+ SMTP_USERNAME,
+ SMTP_PASSWORD,
+ SMTP_AUTH,
+ SMTP_TLS,
+ SMTP_SOCKET_FACTORY,
+ HEADER_XMAILER,
+ CONTENT_TYPE,
+ FROM,
+ TO,
+ CC,
+ BCC,
+ SUBJECT
Review comment:
It's important to take into account the ordering of these properties. This is the order they will be presented in the UI. If configuring a component to send email, the first 3 things I would expect to configure are "To", "From", and "Subject." Here, they are listed at the bottom. We should really move those to be the first 3. And given that "To" and "From" would be at the time, it would make sense to move the "CC" and "BCC" to the top also.
--
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: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org