[
https://issues.apache.org/jira/browse/NIFI-3404?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16019929#comment-16019929
]
ASF GitHub Bot commented on NIFI-3404:
--------------------------------------
Github user jfrazee commented on a diff in the pull request:
https://github.com/apache/nifi/pull/1830#discussion_r117809682
--- Diff:
nifi-nar-bundles/nifi-lookup-bundle/nifi-lookup-processors/src/main/java/org/apache/nifi/processors/lookup/LookupAttribute.java
---
@@ -0,0 +1,226 @@
+/*
+ * 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.lookup;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
+
+import org.apache.commons.lang3.StringUtils;
+
+import org.apache.nifi.annotation.behavior.DynamicProperty;
+import org.apache.nifi.annotation.behavior.EventDriven;
+import org.apache.nifi.annotation.behavior.InputRequirement;
+import org.apache.nifi.annotation.behavior.InputRequirement.Requirement;
+import org.apache.nifi.annotation.behavior.SideEffectFree;
+import org.apache.nifi.annotation.behavior.SupportsBatching;
+import org.apache.nifi.annotation.behavior.WritesAttribute;
+import org.apache.nifi.annotation.documentation.CapabilityDescription;
+import org.apache.nifi.annotation.documentation.Tags;
+import org.apache.nifi.annotation.lifecycle.OnScheduled;
+import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.components.PropertyValue;
+import org.apache.nifi.expression.AttributeExpression;
+import org.apache.nifi.flowfile.FlowFile;
+import org.apache.nifi.logging.ComponentLog;
+import org.apache.nifi.lookup.LookupFailureException;
+import org.apache.nifi.lookup.LookupService;
+import org.apache.nifi.lookup.StringLookupService;
+import org.apache.nifi.processor.AbstractProcessor;
+import org.apache.nifi.processor.ProcessContext;
+import org.apache.nifi.processor.ProcessSession;
+import org.apache.nifi.processor.ProcessorInitializationContext;
+import org.apache.nifi.processor.Relationship;
+import org.apache.nifi.processor.exception.ProcessException;
+import org.apache.nifi.processor.util.StandardValidators;
+
+@EventDriven
+@SideEffectFree
+@SupportsBatching
+@InputRequirement(Requirement.INPUT_REQUIRED)
+@Tags({"lookup", "cache", "enrich", "join", "mutable", "attributes",
"Attribute Expression Language"})
+@CapabilityDescription("Lookup attributes from a lookup service")
+@DynamicProperty(name = "The name of the attribute to add to the FlowFile",
+ value = "The name of the key or property to retrieve from the lookup
service",
+ supportsExpressionLanguage = true,
+ description = "Adds a FlowFile attribute specified by the dynamic
property's key with the value found in the lookup service using the the dynamic
property's value")
+@WritesAttribute(attribute = "See additional details", description = "This
processor may write zero or more attributes as described in additional details")
+public class LookupAttribute extends AbstractProcessor {
+
+ public static final PropertyDescriptor LOOKUP_SERVICE =
+ new PropertyDescriptor.Builder()
+ .name("lookup-service")
+ .displayName("Lookup Service")
+ .description("The lookup service to use for attribute lookups")
+ .identifiesControllerService(StringLookupService.class)
+ .required(true)
+ .build();
+
+ public static final PropertyDescriptor INCLUDE_EMPTY_VALUES =
+ new PropertyDescriptor.Builder()
+ .name("include-empty-values")
+ .displayName("Include Empty Values")
+ .description("Include null or blank values for keys that are
null or blank")
+ .addValidator(StandardValidators.BOOLEAN_VALIDATOR)
+ .allowableValues("true", "false")
+ .defaultValue("true")
+ .required(true)
+ .build();
+
+ public static final Relationship REL_SUCCESS = new
Relationship.Builder()
+ .description("FlowFiles with matching lookups are routed to
this relationship")
+ .name("success")
+ .build();
+
+ public static final Relationship REL_FAILURE = new
Relationship.Builder()
+ .description("FlowFiles with failing lookups are routed to
this relationship")
+ .name("failure")
+ .build();
+
+ public static final Relationship REL_UNMATCHED = new
Relationship.Builder()
+ .description("FlowFiles with missing lookups are routed to
this relationship")
+ .name("unmatched")
+ .build();
+
+ private List<PropertyDescriptor> descriptors;
+
+ private Set<Relationship> relationships;
+
+ private Map<PropertyDescriptor, PropertyValue> dynamicProperties;
+
+ @Override
+ protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
+ return descriptors;
+ }
+
+ @Override
+ protected PropertyDescriptor
getSupportedDynamicPropertyDescriptor(final String propertyDescriptorName) {
+ return new PropertyDescriptor.Builder()
+ .name(propertyDescriptorName)
+ .required(false)
+
.addValidator(StandardValidators.createAttributeExpressionLanguageValidator(AttributeExpression.ResultType.STRING,
true))
+
.addValidator(StandardValidators.ATTRIBUTE_KEY_PROPERTY_NAME_VALIDATOR)
+ .expressionLanguageSupported(true)
+ .dynamic(true)
+ .build();
+ }
+
+ @Override
+ public Set<Relationship> getRelationships() {
+ return relationships;
+ }
+
+ @Override
+ protected void init(final ProcessorInitializationContext context) {
+ final List<PropertyDescriptor> descriptors = new
ArrayList<PropertyDescriptor>();
+ descriptors.add(LOOKUP_SERVICE);
+ descriptors.add(INCLUDE_EMPTY_VALUES);
+ this.descriptors = Collections.unmodifiableList(descriptors);
+
+ final Set<Relationship> relationships = new
HashSet<Relationship>();
+ relationships.add(REL_SUCCESS);
+ relationships.add(REL_FAILURE);
+ relationships.add(REL_UNMATCHED);
+ this.relationships = Collections.unmodifiableSet(relationships);
+ }
+
+ @OnScheduled
+ public void onScheduled(final ProcessContext context) {
+ // Load up all the dynamic properties once for use later in
onTrigger
+ final Map<PropertyDescriptor, PropertyValue> dynamicProperties =
new HashMap<>();
+ for (final Map.Entry<PropertyDescriptor, String> e :
context.getProperties().entrySet()) {
+ final PropertyDescriptor descriptor = e.getKey();
+ if (descriptor.isDynamic()) {
+ final PropertyValue value =
context.getProperty(descriptor);
+ dynamicProperties.put(descriptor, value);
+ }
+ }
+ this.dynamicProperties =
Collections.unmodifiableMap(dynamicProperties);
+ }
+
+ @Override
+ public void onTrigger(ProcessContext context, ProcessSession session)
throws ProcessException {
+ final ComponentLog logger = getLogger();
+ final LookupService lookupService =
context.getProperty(LOOKUP_SERVICE).asControllerService(LookupService.class);
+ final boolean includeEmptyValues =
context.getProperty(INCLUDE_EMPTY_VALUES).asBoolean();
+ for (FlowFile flowFile : session.get(50)) {
+ try {
+ doOnTrigger(logger, lookupService, includeEmptyValues,
flowFile, session);
+ } catch (final IOException e) {
+ throw new ProcessException(e.getMessage(), e);
+ }
+ }
+ }
+
+ private void doOnTrigger(ComponentLog logger, LookupService
lookupService, boolean includeEmptyValues, FlowFile flowFile, ProcessSession
session) throws ProcessException, IOException {
+ try {
+ final Map<String, String> attributes = new
HashMap<>(flowFile.getAttributes());
+
+ boolean notMatched = false;
+ if (dynamicProperties.isEmpty()) {
+ try {
+ // If there aren't any dynamic properties, load the
entire lookup table
+ final Map<String, String> lookupTable =
lookupService.asMap();
--- End diff --
Will remove.
> Add lookup processor for enrichments/joins to reference data
> ------------------------------------------------------------
>
> Key: NIFI-3404
> URL: https://issues.apache.org/jira/browse/NIFI-3404
> Project: Apache NiFi
> Issue Type: Improvement
> Reporter: Joey Frazee
> Assignee: Joey Frazee
>
> NiFi doesn't currently have an easy, concise way of doing enrichment, joining
> against reference data sets or performing attribute lookups against external
> data sources.
> Since enrichments and joins are basic streaming use cases, and since
> attributes and EL are often used to parameterize processor properties, there
> is a need for an easy way to do enrichments, joins and lookups without having
> to write code or create a lengthy data flow.
> There's been some discussion of this on the mailing list [1] and I've started
> work on a LookupAttribute [2] processor that delegates the work to controller
> services.
> 1.
> https://lists.apache.org/thread.html/74321ff0e9e0b7339e43ad53b36119315dc5094991605edfb12b34d0@%3Cdev.nifi.apache.org%3E
> 2. https://github.com/jfrazee/nifi-lookup-service
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
