NIFI-14109 Refactored remaining processors and control services to be…

… uniform when creating properties and relationships.
apache · Dec 27, 2024 · 6b945e4 · 6b945e4
1 parent 2f73167
commit 6b945e4
Show file tree

Hide file tree

Showing 90 changed files with 800 additions and 870 deletions.
diff --git a/...-amqp-processors/src/main/java/org/apache/nifi/amqp/processors/AbstractAMQPProcessor.java b/...-amqp-processors/src/main/java/org/apache/nifi/amqp/processors/AbstractAMQPProcessor.java
@@ -139,23 +139,16 @@ abstract class AbstractAMQPProcessor<T extends AMQPWorker> extends AbstractProce
             .addValidator(StandardValidators.BOOLEAN_VALIDATOR)
             .build();
 
-    private static final List<PropertyDescriptor> propertyDescriptors;
-
-    static {
-        propertyDescriptors = List.of(
-                BROKERS,
-                HOST, PORT,
-                V_HOST,
-                USER,
-                PASSWORD,
-                AMQP_VERSION,
-                SSL_CONTEXT_SERVICE,
-                USE_CERT_AUTHENTICATION);
-    }
-
-    protected static List<PropertyDescriptor> getCommonPropertyDescriptors() {
-        return propertyDescriptors;
-    }
+    protected static final List<PropertyDescriptor> PARENT_PROPERTIES = List.of(
+            BROKERS,
+            HOST, PORT,
+            V_HOST,
+            USER,
+            PASSWORD,
+            AMQP_VERSION,
+            SSL_CONTEXT_SERVICE,
+            USE_CERT_AUTHENTICATION
+    );
 
     private BlockingQueue<AMQPResource<T>> resourceQueue;
 

diff --git a/...undle/nifi-amqp-processors/src/main/java/org/apache/nifi/amqp/processors/ConsumeAMQP.java b/...undle/nifi-amqp-processors/src/main/java/org/apache/nifi/amqp/processors/ConsumeAMQP.java
@@ -40,13 +40,12 @@
 import org.apache.nifi.processor.util.StandardValidators;
 
 import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 @Tags({"amqp", "rabbit", "get", "message", "receive", "consume"})
 @InputRequirement(Requirement.INPUT_FORBIDDEN)
@@ -163,28 +162,24 @@ public class ConsumeAMQP extends AbstractAMQPProcessor<AMQPConsumer> {
         .description("All FlowFiles that are received from the AMQP queue are routed to this relationship")
         .build();
 
-    private static final List<PropertyDescriptor> propertyDescriptors;
-    private static final Set<Relationship> relationships;
-
-    private static final ObjectMapper objectMapper;
-
-    static {
-        List<PropertyDescriptor> properties = new ArrayList<>();
-        properties.add(QUEUE);
-        properties.add(AUTO_ACKNOWLEDGE);
-        properties.add(BATCH_SIZE);
-        properties.add(PREFETCH_COUNT);
-        properties.add(HEADER_FORMAT);
-        properties.add(HEADER_KEY_PREFIX);
-        properties.add(HEADER_SEPARATOR);
-        properties.add(REMOVE_CURLY_BRACES);
-        properties.addAll(getCommonPropertyDescriptors());
-        propertyDescriptors = Collections.unmodifiableList(properties);
-
-        relationships = Set.of(REL_SUCCESS);
-
-        objectMapper = new ObjectMapper();
-    }
+    private static final List<PropertyDescriptor> PROPERTIES = Stream.concat(
+          Stream.of(
+              QUEUE,
+              AUTO_ACKNOWLEDGE,
+              BATCH_SIZE,
+              PREFETCH_COUNT,
+              HEADER_FORMAT,
+              HEADER_KEY_PREFIX,
+              HEADER_SEPARATOR,
+              REMOVE_CURLY_BRACES
+          ), PARENT_PROPERTIES.stream()
+    ).toList();
+
+    private static final Set<Relationship> RELATIONSHIPS = Set.of(
+            REL_SUCCESS
+    );
+
+    private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
 
     /**
      * Will construct a {@link FlowFile} containing the body of the consumed AMQP message (if {@link GetResponse} returned by {@link AMQPConsumer} is
@@ -303,7 +298,7 @@ private static String convertMapToString(Map<String, Object> headers, String val
     }
 
     private static String convertMapToJSONString(Map<String, Object> headers) throws JsonProcessingException {
-        return objectMapper.writeValueAsString(headers);
+        return OBJECT_MAPPER.writeValueAsString(headers);
     }
 
     @Override
@@ -320,12 +315,12 @@ protected synchronized AMQPConsumer createAMQPWorker(final ProcessContext contex
 
     @Override
     protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
-        return propertyDescriptors;
+        return PROPERTIES;
     }
 
     @Override
     public Set<Relationship> getRelationships() {
-        return relationships;
+        return RELATIONSHIPS;
     }
 
     public enum OutputHeaderFormat implements DescribedValue {

diff --git a/...undle/nifi-amqp-processors/src/main/java/org/apache/nifi/amqp/processors/PublishAMQP.java b/...undle/nifi-amqp-processors/src/main/java/org/apache/nifi/amqp/processors/PublishAMQP.java
@@ -140,7 +140,7 @@ public class PublishAMQP extends AbstractAMQPProcessor<AMQPPublisher> {
                     HEADERS_PATTERN,
                     HEADER_SEPARATOR
             ),
-            getCommonPropertyDescriptors().stream()
+            PARENT_PROPERTIES.stream()
     ).toList();
 
     private final static Set<Relationship> RELATIONSHIPS = Set.of(

diff --git a/...es/src/main/java/org/apache/nifi/controller/asana/StandardAsanaClientProviderService.java b/...es/src/main/java/org/apache/nifi/controller/asana/StandardAsanaClientProviderService.java
@@ -71,7 +71,7 @@ public class StandardAsanaClientProviderService extends AbstractControllerServic
             .addValidator(StandardValidators.NON_BLANK_VALIDATOR)
             .build();
 
-    protected static final List<PropertyDescriptor> DESCRIPTORS = List.of(
+    private static final List<PropertyDescriptor> PROPERTIES = List.of(
             PROP_ASANA_API_BASE_URL,
             PROP_ASANA_PERSONAL_ACCESS_TOKEN,
             PROP_ASANA_WORKSPACE_NAME
@@ -83,7 +83,7 @@ public class StandardAsanaClientProviderService extends AbstractControllerServic
 
     @Override
     public List<PropertyDescriptor> getSupportedPropertyDescriptors() {
-        return DESCRIPTORS;
+        return PROPERTIES;
     }
 
     @OnEnabled

diff --git a/...c/main/java/org/apache/nifi/processors/aws/s3/encryption/StandardS3EncryptionService.java b/...c/main/java/org/apache/nifi/processors/aws/s3/encryption/StandardS3EncryptionService.java
@@ -45,7 +45,6 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
-import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Consumer;
@@ -110,6 +109,12 @@ STRATEGY_NAME_CSE_C, new ClientSideCEncryptionStrategy()
             .defaultValue(RegionUtilV1.createAllowableValue(Regions.DEFAULT_REGION).getValue())
             .build();
 
+    private static final List<PropertyDescriptor> PROPERTIES = List.of(
+       ENCRYPTION_STRATEGY,
+       ENCRYPTION_VALUE,
+       KMS_REGION
+    );
+
     private String keyValue = "";
     private String kmsRegion = "";
     private S3EncryptionStrategy encryptionStrategy = new NoOpEncryptionStrategy();
@@ -189,11 +194,7 @@ protected Collection<ValidationResult> customValidate(final ValidationContext va
 
     @Override
     protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
-        final List<PropertyDescriptor> properties = new ArrayList<>();
-        properties.add(ENCRYPTION_STRATEGY);
-        properties.add(ENCRYPTION_VALUE);
-        properties.add(KMS_REGION);
-        return Collections.unmodifiableList(properties);
+        return PROPERTIES;
     }
 
     @Override

diff --git a/...ry-service/src/main/java/org/apache/nifi/aws/schemaregistry/AmazonGlueSchemaRegistry.java b/...ry-service/src/main/java/org/apache/nifi/aws/schemaregistry/AmazonGlueSchemaRegistry.java
@@ -53,7 +53,6 @@
 import java.net.URI;
 import java.time.Duration;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Comparator;
 import java.util.EnumSet;
 import java.util.List;
@@ -137,7 +136,7 @@ public class AmazonGlueSchemaRegistry extends AbstractControllerService implemen
 
     private static final PropertyDescriptor PROXY_CONFIGURATION_SERVICE = ProxyConfiguration.createProxyConfigPropertyDescriptor(PROXY_SPECS);
 
-    private static final List<PropertyDescriptor> PROPERTIES = new ArrayList<>(Arrays.asList(
+    private static final List<PropertyDescriptor> PROPERTIES = List.of(
             SCHEMA_REGISTRY_NAME,
             REGION,
             COMMUNICATIONS_TIMEOUT,
@@ -146,7 +145,7 @@ public class AmazonGlueSchemaRegistry extends AbstractControllerService implemen
             AWS_CREDENTIALS_PROVIDER_SERVICE,
             PROXY_CONFIGURATION_SERVICE,
             SSL_CONTEXT_SERVICE
-    ));
+    );
 
 
     @Override

diff --git a/...c/main/java/org/apache/nifi/services/azure/StandardAzureCredentialsControllerService.java b/...c/main/java/org/apache/nifi/services/azure/StandardAzureCredentialsControllerService.java
@@ -69,7 +69,8 @@ public class StandardAzureCredentialsControllerService extends AbstractControlle
             .build();
 
     private static final List<PropertyDescriptor> PROPERTIES = List.of(
-            CREDENTIAL_CONFIGURATION_STRATEGY, MANAGED_IDENTITY_CLIENT_ID
+            CREDENTIAL_CONFIGURATION_STRATEGY,
+            MANAGED_IDENTITY_CLIENT_ID
     );
 
     private TokenCredential credentials;

diff --git a/.../main/java/org/apache/nifi/services/azure/cosmos/document/AzureCosmosDBClientService.java b/.../main/java/org/apache/nifi/services/azure/cosmos/document/AzureCosmosDBClientService.java
@@ -83,15 +83,15 @@ protected void createCosmosClient(final String uri, final String accessKey, fina
                                 .buildClient();
     }
 
-    static List<PropertyDescriptor> descriptors = List.of(
+    private static final List<PropertyDescriptor> PROPERTIES = List.of(
             AzureCosmosDBUtils.URI,
             AzureCosmosDBUtils.DB_ACCESS_KEY,
             AzureCosmosDBUtils.CONSISTENCY
     );
 
     @Override
     protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
-        return descriptors;
+        return PROPERTIES;
     }
 
     @Override

diff --git a/...rc/main/java/org/apache/nifi/services/azure/data/explorer/StandardKustoIngestService.java b/...rc/main/java/org/apache/nifi/services/azure/data/explorer/StandardKustoIngestService.java
@@ -105,7 +105,7 @@ public class StandardKustoIngestService extends AbstractControllerService implem
             .addValidator(StandardValidators.URL_VALIDATOR)
             .build();
 
-    private static final List<PropertyDescriptor> PROPERTY_DESCRIPTORS = List.of(
+    private static final List<PropertyDescriptor> PROPERTIES = List.of(
             AUTHENTICATION_STRATEGY,
             APPLICATION_CLIENT_ID,
             APPLICATION_KEY,
@@ -127,7 +127,7 @@ public class StandardKustoIngestService extends AbstractControllerService implem
 
     @Override
     public List<PropertyDescriptor> getSupportedPropertyDescriptors() {
-        return PROPERTY_DESCRIPTORS;
+        return PROPERTIES;
     }
 
     @OnEnabled

diff --git a/...src/main/java/org/apache/nifi/services/azure/data/explorer/StandardKustoQueryService.java b/...src/main/java/org/apache/nifi/services/azure/data/explorer/StandardKustoQueryService.java
@@ -83,7 +83,7 @@ public class StandardKustoQueryService extends AbstractControllerService impleme
             .dependsOn(AUTHENTICATION_STRATEGY, KustoAuthenticationStrategy.APPLICATION_CREDENTIALS)
             .build();
 
-    private static final List<PropertyDescriptor> PROPERTY_DESCRIPTORS = List.of(
+    private static final List<PropertyDescriptor> PROPERTIES = List.of(
             CLUSTER_URI,
             AUTHENTICATION_STRATEGY,
             APPLICATION_CLIENT_ID,
@@ -95,7 +95,7 @@ public class StandardKustoQueryService extends AbstractControllerService impleme
 
     @Override
     public List<PropertyDescriptor> getSupportedPropertyDescriptors() {
-        return PROPERTY_DESCRIPTORS;
+        return PROPERTIES;
     }
 
     public static final Pair<String, String> NIFI_SOURCE = Pair.of("processor", "nifi-source");

diff --git a/...essors/src/main/java/org/apache/nifi/services/azure/eventhub/AzureEventHubRecordSink.java b/...essors/src/main/java/org/apache/nifi/services/azure/eventhub/AzureEventHubRecordSink.java
@@ -125,7 +125,7 @@ public class AzureEventHubRecordSink extends AbstractControllerService implement
             .required(false)
             .build();
 
-    private static final List<PropertyDescriptor> PROPERTY_DESCRIPTORS = List.of(
+    private static final List<PropertyDescriptor> PROPERTIES = List.of(
             SERVICE_BUS_ENDPOINT,
             EVENT_HUB_NAMESPACE,
             EVENT_HUB_NAME,
@@ -143,7 +143,7 @@ public class AzureEventHubRecordSink extends AbstractControllerService implement
 
     @Override
     protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
-        return PROPERTY_DESCRIPTORS;
+        return PROPERTIES;
     }
 
     protected EventHubProducerClient createEventHubClient(final String namespace,

diff --git a/...rvice/src/main/java/org/apache/nifi/confluent/schemaregistry/ConfluentSchemaRegistry.java b/...rvice/src/main/java/org/apache/nifi/confluent/schemaregistry/ConfluentSchemaRegistry.java
@@ -148,21 +148,23 @@ public class ConfluentSchemaRegistry extends AbstractControllerService implement
             .sensitive(true)
             .build();
 
+    private static final List<PropertyDescriptor> PROPERTIES = List.of(
+        SCHEMA_REGISTRY_URLS,
+        SSL_CONTEXT,
+        TIMEOUT,
+        CACHE_SIZE,
+        CACHE_EXPIRATION,
+        AUTHENTICATION_TYPE,
+        USERNAME,
+        PASSWORD
+    );
+
     private volatile SchemaRegistryClient client;
 
 
     @Override
     protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
-        final List<PropertyDescriptor> properties = new ArrayList<>();
-        properties.add(SCHEMA_REGISTRY_URLS);
-        properties.add(SSL_CONTEXT);
-        properties.add(TIMEOUT);
-        properties.add(CACHE_SIZE);
-        properties.add(CACHE_EXPIRATION);
-        properties.add(AUTHENTICATION_TYPE);
-        properties.add(USERNAME);
-        properties.add(PASSWORD);
-        return properties;
+        return PROPERTIES;
     }
 
     private static final Validator REQUEST_HEADER_VALIDATOR = new Validator() {

diff --git a/...ices/src/main/java/org/apache/nifi/services/dropbox/StandardDropboxCredentialService.java b/...ices/src/main/java/org/apache/nifi/services/dropbox/StandardDropboxCredentialService.java
@@ -16,8 +16,6 @@
  */
 package org.apache.nifi.services.dropbox;
 
-import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import org.apache.nifi.annotation.documentation.CapabilityDescription;
 import org.apache.nifi.annotation.documentation.Tags;
@@ -77,16 +75,12 @@ public class StandardDropboxCredentialService extends AbstractControllerService
             .required(true)
             .build();
 
-    private static final List<PropertyDescriptor> PROPERTIES;
-
-    static {
-        final List<PropertyDescriptor> props = new ArrayList<>();
-        props.add(APP_KEY);
-        props.add(APP_SECRET);
-        props.add(ACCESS_TOKEN);
-        props.add(REFRESH_TOKEN);
-        PROPERTIES = Collections.unmodifiableList(props);
-    }
+    private static final List<PropertyDescriptor> PROPERTIES = List.of(
+            APP_KEY,
+            APP_SECRET,
+            ACCESS_TOKEN,
+            REFRESH_TOKEN
+    );
 
     private DropboxCredentialDetails credential;
 

diff --git a/...t-service/src/main/java/org/apache/nifi/elasticsearch/ElasticSearchClientServiceImpl.java b/...t-service/src/main/java/org/apache/nifi/elasticsearch/ElasticSearchClientServiceImpl.java
@@ -102,10 +102,30 @@ public class ElasticSearchClientServiceImpl extends AbstractControllerService im
 
     private ObjectMapper mapper;
 
-    private static final List<PropertyDescriptor> properties = List.of(HTTP_HOSTS, PATH_PREFIX, AUTHORIZATION_SCHEME, USERNAME, PASSWORD, API_KEY_ID, API_KEY,
-            PROP_SSL_CONTEXT_SERVICE, PROXY_CONFIGURATION_SERVICE, CONNECT_TIMEOUT, SOCKET_TIMEOUT, CHARSET,
-            SUPPRESS_NULLS, COMPRESSION, SEND_META_HEADER, STRICT_DEPRECATION, NODE_SELECTOR, SNIFF_CLUSTER_NODES,
-            SNIFFER_INTERVAL, SNIFFER_REQUEST_TIMEOUT, SNIFF_ON_FAILURE, SNIFFER_FAILURE_DELAY);
+    private static final List<PropertyDescriptor> PROPERTIES = List.of(
+            HTTP_HOSTS,
+            PATH_PREFIX,
+            AUTHORIZATION_SCHEME,
+            USERNAME,
+            PASSWORD,
+            API_KEY_ID,
+            API_KEY,
+            PROP_SSL_CONTEXT_SERVICE,
+            PROXY_CONFIGURATION_SERVICE,
+            CONNECT_TIMEOUT,
+            SOCKET_TIMEOUT,
+            CHARSET,
+            SUPPRESS_NULLS,
+            COMPRESSION,
+            SEND_META_HEADER,
+            STRICT_DEPRECATION,
+            NODE_SELECTOR,
+            SNIFF_CLUSTER_NODES,
+            SNIFFER_INTERVAL,
+            SNIFFER_REQUEST_TIMEOUT,
+            SNIFF_ON_FAILURE,
+            SNIFFER_FAILURE_DELAY
+    );
 
     private RestClient client;
 
@@ -117,7 +137,7 @@ public class ElasticSearchClientServiceImpl extends AbstractControllerService im
 
     @Override
     protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
-        return properties;
+        return PROPERTIES;
     }
 
     @Override