This is an automated email from the ASF dual-hosted git repository.
exceptionfactory pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/main by this push:
new 4f399c9bb9 NIFI-12446 Refactor FilterAttribute to align with code
conventions
4f399c9bb9 is described below
commit 4f399c9bb973c98b98f21d271cb64c5665ae6ce6
Author: EndzeitBegins <16666115+endzeitbeg...@users.noreply.github.com>
AuthorDate: Thu Dec 14 21:04:04 2023 +0100
NIFI-12446 Refactor FilterAttribute to align with code conventions
This closes #8161
Signed-off-by: David Handermann <exceptionfact...@apache.org>
---
.../nifi/processors/standard/FilterAttribute.java | 183 ++++++++++++---------
.../processors/standard/TestFilterAttribute.java | 14 +-
2 files changed, 111 insertions(+), 86 deletions(-)
diff --git
a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/FilterAttribute.java
b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/FilterAttribute.java
index de612196fd..d37e28742d 100644
---
a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/FilterAttribute.java
+++
b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/FilterAttribute.java
@@ -24,7 +24,7 @@ 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.DescribedValue;
import org.apache.nifi.components.PropertyDescriptor;
import org.apache.nifi.expression.ExpressionLanguageScope;
import org.apache.nifi.flowfile.FlowFile;
@@ -36,7 +36,6 @@ 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;
@@ -52,87 +51,64 @@ import java.util.stream.Collectors;
@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[.].*".
+ Set "Filter Mode" to "Retain".
+ Set "Attribute Matching Strategy" to "Use regular expression".
+ Specify the "Filtered Attributes Pattern", 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".
+ Set "Filter Mode" to "Remove".
+ Set "Attribute Matching Strategy" to "Enumerate attributes".
+ Specify the set of "Filtered Attributes" 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."
- );
+ .name("success")
+ .description("All successful FlowFiles are routed to this
relationship")
+ .build();
- public static final AllowableValue FILTER_MODE_VALUE_REMOVE = new
AllowableValue(
- "REMOVE",
- "Remove",
- "Removes the attributes matching the filter, all other attributes
are retained."
- );
+ private final static Set<Relationship> relationships = Set.of(REL_SUCCESS);
public static final PropertyDescriptor FILTER_MODE = new
PropertyDescriptor.Builder()
- .name("FILTER_MODE")
- .displayName("Filter mode")
+ .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)
+ .allowableValues(FilterMode.class)
+ .defaultValue(FilterMode.RETAIN)
.expressionLanguageSupported(ExpressionLanguageScope.NONE)
- .defaultValue(FILTER_MODE_VALUE_RETAIN.getValue())
.build();
- public static final AllowableValue MATCHING_STRATEGY_VALUE_ENUMERATION =
new AllowableValue(
- "ENUMERATION",
- "Enumerate attributes",
- "Provides a set of attribute keys to filter for, separated by a
comma delimiter ','."
- );
-
- public static final AllowableValue MATCHING_STRATEGY_VALUE_REGEX = new
AllowableValue(
- "REGEX",
- "Use regular expression",
- "Provides a regular expression to match keys of attributes to
filter for."
- );
-
public static final PropertyDescriptor MATCHING_STRATEGY = new
PropertyDescriptor.Builder()
- .name("MATCHING_STRATEGY")
- .displayName("Attribute matching strategy")
+ .name("Attribute Matching Strategy")
+ .displayName("Attribute Matching Strategy")
.description("Specifies the strategy to filter attributes by.")
.required(true)
- .allowableValues(MATCHING_STRATEGY_VALUE_ENUMERATION,
MATCHING_STRATEGY_VALUE_REGEX)
+ .allowableValues(MatchingStrategy.class)
+ .defaultValue(MatchingStrategy.ENUMERATION)
.expressionLanguageSupported(ExpressionLanguageScope.NONE)
- .defaultValue(MATCHING_STRATEGY_VALUE_ENUMERATION.getValue())
.build();
- public static final PropertyDescriptor ATTRIBUTE_SET = new
PropertyDescriptor.Builder()
- .name("ATTRIBUTE_SET")
- .displayName("Set of attributes to filter")
+ public static final PropertyDescriptor ATTRIBUTE_ENUMERATION = new
PropertyDescriptor.Builder()
+ .name("Filtered Attributes")
+ .displayName("Filtered Attributes")
.description("A set of attribute names to filter from FlowFiles.
Each attribute name is separated by the comma delimiter ','.")
.required(true)
- .dependsOn(MATCHING_STRATEGY, MATCHING_STRATEGY_VALUE_ENUMERATION)
+ .dependsOn(MATCHING_STRATEGY, MatchingStrategy.ENUMERATION)
.addValidator(StandardValidators.NON_BLANK_VALIDATOR)
.expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES)
.build();
- public static final PropertyDescriptor ATTRIBUTE_REGEX = new
PropertyDescriptor.Builder()
- .name("ATTRIBUTE_REGEX")
- .displayName("Regular expression to filter attributes")
+ public static final PropertyDescriptor ATTRIBUTE_PATTERN = new
PropertyDescriptor.Builder()
+ .name("Filtered Attributes Pattern")
+ .displayName("Filtered Attributes Pattern")
.description("A regular expression to match names of attributes to
filter from FlowFiles.")
.required(true)
- .dependsOn(MATCHING_STRATEGY, MATCHING_STRATEGY_VALUE_REGEX)
+ .dependsOn(MATCHING_STRATEGY, MatchingStrategy.PATTERN)
.addValidator(StandardValidators.REGULAR_EXPRESSION_WITH_EL_VALIDATOR)
.expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES)
.build();
@@ -140,7 +116,9 @@ public class FilterAttribute extends AbstractProcessor {
private final static String DELIMITER_VALUE = ",";
private final static List<PropertyDescriptor> properties =
- List.of(FILTER_MODE, MATCHING_STRATEGY, ATTRIBUTE_SET,
ATTRIBUTE_REGEX);
+ List.of(FILTER_MODE, MATCHING_STRATEGY, ATTRIBUTE_ENUMERATION,
ATTRIBUTE_PATTERN);
+
+ private volatile Predicate<String> cachedMatchingPredicate;
@Override
public Set<Relationship> getRelationships() {
@@ -152,7 +130,6 @@ public class FilterAttribute extends AbstractProcessor {
return properties;
}
- private volatile Predicate<String> cachedMatchingPredicate;
@OnScheduled
public void onScheduled(final ProcessContext context) {
@@ -161,11 +138,11 @@ public class FilterAttribute extends AbstractProcessor {
cachedMatchingPredicate = null;
if (matchingStrategy == MatchingStrategy.ENUMERATION
- &&
!context.getProperty(ATTRIBUTE_SET).isExpressionLanguagePresent()) {
+ &&
!context.getProperty(ATTRIBUTE_ENUMERATION).isExpressionLanguagePresent()) {
cachedMatchingPredicate =
determineMatchingPredicateBasedOnEnumeration(context, null);
}
- if (matchingStrategy == MatchingStrategy.REGEX
- &&
!context.getProperty(ATTRIBUTE_REGEX).isExpressionLanguagePresent()) {
+ if (matchingStrategy == MatchingStrategy.PATTERN
+ &&
!context.getProperty(ATTRIBUTE_PATTERN).isExpressionLanguagePresent()) {
cachedMatchingPredicate =
determineMatchingPredicateBasedOnRegex(context, null);
}
}
@@ -200,7 +177,7 @@ public class FilterAttribute extends AbstractProcessor {
final MatchingStrategy matchingStrategy = getMatchingStrategy(context);
return switch (matchingStrategy) {
case ENUMERATION ->
determineMatchingPredicateBasedOnEnumeration(context, flowFile);
- case REGEX -> determineMatchingPredicateBasedOnRegex(context,
flowFile);
+ case PATTERN -> determineMatchingPredicateBasedOnRegex(context,
flowFile);
};
}
@@ -225,29 +202,19 @@ public class FilterAttribute extends AbstractProcessor {
/* properties */
private static FilterMode getFilterMode(ProcessContext context) {
- final String rawFilterMode = context
+ return context
.getProperty(FILTER_MODE)
- .getValue();
-
- if (FILTER_MODE_VALUE_REMOVE.getValue().equals(rawFilterMode)) {
- return FilterMode.REMOVE;
- }
- return FilterMode.RETAIN;
+ .asDescribedValue(FilterMode.class);
}
private static MatchingStrategy getMatchingStrategy(ProcessContext
context) {
- final String rawMatchingStrategy = context
+ return context
.getProperty(MATCHING_STRATEGY)
- .getValue();
-
- if
(MATCHING_STRATEGY_VALUE_REGEX.getValue().equals(rawMatchingStrategy)) {
- return MatchingStrategy.REGEX;
- }
- return MatchingStrategy.ENUMERATION;
+ .asDescribedValue(MatchingStrategy.class);
}
private static String getAttributeSet(ProcessContext context, FlowFile
flowFile) {
- return
context.getProperty(ATTRIBUTE_SET).evaluateAttributeExpressions(flowFile).getValue();
+ return
context.getProperty(ATTRIBUTE_ENUMERATION).evaluateAttributeExpressions(flowFile).getValue();
}
private static String getDelimiter() {
@@ -256,17 +223,75 @@ public class FilterAttribute extends AbstractProcessor {
private static Pattern getAttributeRegex(ProcessContext context, FlowFile
flowFile) {
return Pattern.compile(
-
context.getProperty(ATTRIBUTE_REGEX).evaluateAttributeExpressions(flowFile).getValue()
+
context.getProperty(ATTRIBUTE_PATTERN).evaluateAttributeExpressions(flowFile).getValue()
);
}
- private enum FilterMode {
- RETAIN,
- REMOVE,
+ enum FilterMode implements DescribedValue {
+ RETAIN(
+ "Retain",
+ "Retains only the attributes matching the filter, all other
attributes are removed."
+ ),
+ REMOVE(
+ "Remove",
+ "Removes the attributes matching the filter, all other
attributes are retained."
+ );
+
+ private final String value;
+ private final String description;
+
+ FilterMode(final String value, final String description) {
+ this.value = value;
+ this.description = description;
+ }
+
+ @Override
+ public String getValue() {
+ return this.value;
+ }
+
+ @Override
+ public String getDisplayName() {
+ return this.value;
+ }
+
+ @Override
+ public String getDescription() {
+ return this.description;
+ }
}
- private enum MatchingStrategy {
- ENUMERATION,
- REGEX,
+ enum MatchingStrategy implements DescribedValue {
+ ENUMERATION(
+ "Enumerate attributes",
+ "Provides a set of attribute keys to filter for, separated by
a comma delimiter ','."
+ ),
+ PATTERN(
+ "Use regular expression",
+ "Provides a regular expression to match keys of attributes to
filter for."
+ );
+
+ private final String value;
+ private final String description;
+
+ MatchingStrategy(final String value, final String description) {
+ this.value = value;
+ this.description = description;
+ }
+
+ @Override
+ public String getValue() {
+ return this.value;
+ }
+
+ @Override
+ public String getDisplayName() {
+ return this.value;
+ }
+
+ @Override
+ public String getDescription() {
+ return this.description;
+ }
}
}
diff --git
a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestFilterAttribute.java
b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestFilterAttribute.java
index d6d29d97ba..6d9b210374 100644
---
a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestFilterAttribute.java
+++
b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestFilterAttribute.java
@@ -89,7 +89,7 @@ class TestFilterAttribute {
@BeforeEach
void setUp() {
- runner.setProperty(FilterAttribute.FILTER_MODE,
FilterAttribute.FILTER_MODE_VALUE_REMOVE);
+ runner.setProperty(FilterAttribute.FILTER_MODE,
FilterAttribute.FilterMode.REMOVE.getValue());
}
@Test
@@ -198,8 +198,8 @@ class TestFilterAttribute {
}
private void runTestWith(Map<String, String> attributes, String
attributeSet, Set<String> expectedAttributes) {
- runner.setProperty(FilterAttribute.MATCHING_STRATEGY,
FilterAttribute.MATCHING_STRATEGY_VALUE_ENUMERATION);
- runner.setProperty(FilterAttribute.ATTRIBUTE_SET, attributeSet);
+ runner.setProperty(FilterAttribute.MATCHING_STRATEGY,
FilterAttribute.MatchingStrategy.ENUMERATION.getValue());
+ runner.setProperty(FilterAttribute.ATTRIBUTE_ENUMERATION,
attributeSet);
final MockFlowFile input = runner.enqueue(exampleContent,
attributes);
final Map<String, String> inputAttributes = input.getAttributes();
@@ -267,7 +267,7 @@ class TestFilterAttribute {
@BeforeEach
void setUp() {
- runner.setProperty(FilterAttribute.FILTER_MODE,
FilterAttribute.FILTER_MODE_VALUE_REMOVE);
+ runner.setProperty(FilterAttribute.FILTER_MODE,
FilterAttribute.FilterMode.REMOVE.getValue());
}
@Test
@@ -320,8 +320,8 @@ class TestFilterAttribute {
}
private void runTestWith(Map<String, String> attributes, String
regexPattern, Set<String> expectedAttributes) {
- runner.setProperty(FilterAttribute.MATCHING_STRATEGY,
FilterAttribute.MATCHING_STRATEGY_VALUE_REGEX);
- runner.setProperty(FilterAttribute.ATTRIBUTE_REGEX, regexPattern);
+ runner.setProperty(FilterAttribute.MATCHING_STRATEGY,
FilterAttribute.MatchingStrategy.PATTERN.getValue());
+ runner.setProperty(FilterAttribute.ATTRIBUTE_PATTERN,
regexPattern);
final MockFlowFile input = runner.enqueue(exampleContent,
attributes);
final Map<String, String> inputAttributes = input.getAttributes();
@@ -356,7 +356,7 @@ class TestFilterAttribute {
"bar", "" + i
));
}
- runner.setProperty(FilterAttribute.ATTRIBUTE_SET, "foo");
+ runner.setProperty(FilterAttribute.ATTRIBUTE_ENUMERATION, "foo");
runner.run(flowFileCount);
runner.assertAllFlowFilesTransferred(FilterAttribute.REL_SUCCESS,
flowFileCount);
