EndzeitBegins commented on code in PR #8049: URL: https://github.com/apache/nifi/pull/8049#discussion_r1409749624
########## nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/FilterAttribute.java: ########## @@ -0,0 +1,273 @@ +/* + * 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.standard; + +import org.apache.nifi.annotation.behavior.DefaultRunDuration; +import org.apache.nifi.annotation.behavior.InputRequirement; +import org.apache.nifi.annotation.behavior.SideEffectFree; +import org.apache.nifi.annotation.behavior.SupportsBatching; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.documentation.UseCase; +import org.apache.nifi.annotation.lifecycle.OnScheduled; +import org.apache.nifi.components.AllowableValue; +import org.apache.nifi.components.PropertyDescriptor; +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.processor.util.StandardValidators; + +import java.util.Arrays; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Set; +import java.util.function.Predicate; +import java.util.regex.Pattern; +import java.util.stream.Collectors; + +@SideEffectFree +@SupportsBatching(defaultDuration = DefaultRunDuration.TWENTY_FIVE_MILLIS) +@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED) +@Tags({"attributes", "modification", "filter", "retain", "remove", "delete", "regex", "regular expression", "Attribute Expression Language"}) +@CapabilityDescription("Filters the Attributes of a FlowFile according to a specified strategy") +@UseCase( + description = "Retain all FlowFile attributes matching a regular expression", + configuration = """ + Set "Filter mode" to "Retain". + Set "Attribute matching strategy" to "Use regular expression". + Specify the "Regular expression to filter attributes", e.g. "my-property|a-prefix[.].*". + """ +) +@UseCase( + description = "Remove only a specified set of FlowFile attributes", + configuration = """ + Set "Filter mode" to "Remove". + Set "Attribute matching strategy" to "Enumerate attributes". + Specify the set of "Set of attributes to filter" using the delimiter comma ',', e.g. "my-property,other,filename". + """ +) +public class FilterAttribute extends AbstractProcessor { + + public static final Relationship REL_SUCCESS = new Relationship.Builder() + .description("All successful FlowFiles are routed to this relationship").name("success").build(); + + private final static Set<Relationship> relationships = Collections.singleton(REL_SUCCESS); + + + public static final AllowableValue FILTER_MODE_VALUE_RETAIN = new AllowableValue( + "RETAIN", + "Retain", + "Retains only the attributes matching the filter, all other attributes are removed." + ); + + public static final AllowableValue FILTER_MODE_VALUE_REMOVE = new AllowableValue( + "REMOVE", + "Remove", + "Removes the attributes matching the filter, all other attributes are retained." + ); + + public static final PropertyDescriptor FILTER_MODE = new PropertyDescriptor.Builder() + .name("FILTER_MODE") + .displayName("Filter mode") + .description("Specifies the strategy to apply on filtered attributes. Either 'Remove' or 'Retain' only the matching attributes.") + .required(true) + .allowableValues(FILTER_MODE_VALUE_RETAIN, FILTER_MODE_VALUE_REMOVE) + .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) Review Comment: These are some good remarks, thank you. I assume there won't be a lot of users that wish to use EL for the FILTER_MODE. I removed the support for now. In case using EL for this property is more desired than anticipated right now, it should be relatively easy to introduce proper support in one of the ways you mentioned. -- 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-unsubscr...@nifi.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
