NIFI-12613 Renamed asDescribedValue() to asAllowableValue()

This closes #8260 Signed-off-by: David Handermann <exceptionfactory@apache.org>
apache · Jan 18, 2024 · 53bb995 · 53bb995
1 parent 2a3a7d9
commit 53bb995
Show file tree

Hide file tree

Showing 38 changed files with 88 additions and 70 deletions.
diff --git a/nifi-api/src/main/java/org/apache/nifi/components/PropertyValue.java b/nifi-api/src/main/java/org/apache/nifi/components/PropertyValue.java
@@ -135,16 +135,18 @@ public interface PropertyValue {
     ResourceReferences asResources();
 
     /**
-     * @param <E> the generic type of the enum used as allowable values
-     * @param enumType the class of the enum used as allowable values
-     * @return the DescribedValue enum entry whose value is the raw value of the
-     * <code>this</code>, or <code>null</code> if the value is not set.
-     * Throws an IllegalArgumentException if none of the enum entries correspond to the specified raw value.
+     * Returns the property value as one of the configured allowableValues, see {@link PropertyDescriptor.Builder#allowableValues(Class)}
+     * <p>
+     * The {@link Class#getEnumConstants()} of the provided enum are searched for an entry matching the value of <code>this</code>.
+     * In case an enum value is a {@link DescribedValue}, uses the defined {@link DescribedValue#getValue()} for comparison.
+     * Otherwise, the {@link Enum#name()} is used.
      *
-     * @throws IllegalArgumentException if the value of <code>this</code>
-     * does not point to any of the entries of the specified enum type.
+     * @param <E> the generic type of the enum used as allowableValues
+     * @param enumType the class of the enum used as allowableValues
+     * @return the matching enum entry, or <code>null</code> if the value is not set.
+     * @throws IllegalArgumentException if no enum entry matching the value of <code>this</code> is found.
      */
-    <E extends Enum<E> & DescribedValue> E asDescribedValue(Class<E> enumType) throws IllegalArgumentException;
+    <E extends Enum<E>> E asAllowableValue(Class<E> enumType) throws IllegalArgumentException;
 
     /**
      * @return <code>true</code> if the user has configured a value, or if the

diff --git a/...ge/src/main/java/org/apache/nifi/attribute/expression/language/StandardPropertyValue.java b/...ge/src/main/java/org/apache/nifi/attribute/expression/language/StandardPropertyValue.java
@@ -237,13 +237,17 @@ public ResourceReferences asResources() {
     }
 
     @Override
-    public <E extends Enum<E> & DescribedValue> E asDescribedValue(Class<E> enumType) throws IllegalArgumentException {
+    public <E extends Enum<E>> E asAllowableValue(Class<E> enumType) throws IllegalArgumentException {
         if (rawValue == null) {
             return null;
         }
 
         for (E enumConstant : enumType.getEnumConstants()) {
-            if (enumConstant.getValue().equals(rawValue)) {
+            if (enumConstant instanceof DescribedValue describedValue) {
+                if (describedValue.getValue().equals(rawValue)) {
+                    return enumConstant;
+                }
+            } else if (enumConstant.name().equals(rawValue)) {
                 return enumConstant;
             }
         }

diff --git a/nifi-mock/src/main/java/org/apache/nifi/util/MockPropertyValue.java b/nifi-mock/src/main/java/org/apache/nifi/util/MockPropertyValue.java
@@ -25,7 +25,6 @@
 import org.apache.nifi.attribute.expression.language.Query;
 import org.apache.nifi.attribute.expression.language.Query.Range;
 import org.apache.nifi.attribute.expression.language.StandardPropertyValue;
-import org.apache.nifi.components.DescribedValue;
 import org.apache.nifi.components.PropertyDescriptor;
 import org.apache.nifi.components.PropertyValue;
 import org.apache.nifi.components.resource.ResourceContext;
@@ -324,9 +323,9 @@ public ResourceReferences asResources() {
     }
 
     @Override
-    public <E extends Enum<E> & DescribedValue> E asDescribedValue(Class<E> enumType) throws IllegalArgumentException {
+    public <E extends Enum<E>> E asAllowableValue(Class<E> enumType) throws IllegalArgumentException {
         ensureExpressionsEvaluated();
-        return stdPropValue.asDescribedValue(enumType);
+        return stdPropValue.asAllowableValue(enumType);
     }
 
     @Override

diff --git a/.../nifi-asana-processors/src/main/java/org/apache/nifi/processors/asana/GetAsanaObject.java b/.../nifi-asana-processors/src/main/java/org/apache/nifi/processors/asana/GetAsanaObject.java
@@ -341,7 +341,7 @@ private static void transferFlowFileByAsanaObjectState(ProcessSession session, A
     }
 
     protected AsanaObjectFetcher createObjectFetcher(final ProcessContext context, AsanaClient client) {
-        final AsanaObjectType objectType = context.getProperty(PROP_ASANA_OBJECT_TYPE).asDescribedValue(AsanaObjectType.class);
+        final AsanaObjectType objectType = context.getProperty(PROP_ASANA_OBJECT_TYPE).asAllowableValue(AsanaObjectType.class);
         final String projectName = context.getProperty(PROP_ASANA_PROJECT).getValue();
         final String sectionName = context.getProperty(PROP_ASANA_SECTION).getValue();
         final String teamName = context.getProperty(PROP_ASANA_TEAM_NAME).getValue();

diff --git a/...rocessors/src/main/java/org/apache/nifi/processors/azure/ClientSideEncryptionSupport.java b/...rocessors/src/main/java/org/apache/nifi/processors/azure/ClientSideEncryptionSupport.java
@@ -76,7 +76,7 @@ public interface ClientSideEncryptionSupport {
 
     default Collection<ValidationResult> validateClientSideEncryptionProperties(ValidationContext validationContext) {
         final List<ValidationResult> validationResults = new ArrayList<>();
-        final ClientSideEncryptionMethod cseKeyType = validationContext.getProperty(CSE_KEY_TYPE).asDescribedValue(ClientSideEncryptionMethod.class);
+        final ClientSideEncryptionMethod cseKeyType = validationContext.getProperty(CSE_KEY_TYPE).asAllowableValue(ClientSideEncryptionMethod.class);
         final String cseKeyId = validationContext.getProperty(CSE_KEY_ID).getValue();
         final String cseLocalKey = validationContext.getProperty(CSE_LOCAL_KEY).getValue();
         if (cseKeyType != ClientSideEncryptionMethod.NONE && StringUtils.isBlank(cseKeyId)) {
@@ -114,7 +114,7 @@ default List<ValidationResult> validateLocalKey(String keyHex) {
     }
 
     default boolean isClientSideEncryptionEnabled(PropertyContext context) {
-        final ClientSideEncryptionMethod cseKeyType = context.getProperty(CSE_KEY_TYPE).asDescribedValue(ClientSideEncryptionMethod.class);
+        final ClientSideEncryptionMethod cseKeyType = context.getProperty(CSE_KEY_TYPE).asAllowableValue(ClientSideEncryptionMethod.class);
         return cseKeyType != ClientSideEncryptionMethod.NONE;
     }
 

diff --git a/...cessors/src/main/java/org/apache/nifi/processors/azure/eventhub/ConsumeAzureEventHub.java b/...cessors/src/main/java/org/apache/nifi/processors/azure/eventhub/ConsumeAzureEventHub.java
@@ -490,7 +490,7 @@ protected EventProcessorClient createClient(final ProcessContext context) {
         final Long receiveTimeout = context.getProperty(RECEIVE_TIMEOUT).evaluateAttributeExpressions().asTimePeriod(TimeUnit.MILLISECONDS);
         final Duration maxWaitTime = Duration.ofMillis(receiveTimeout);
         final Integer maxBatchSize = context.getProperty(BATCH_SIZE).evaluateAttributeExpressions().asInteger();
-        final AmqpTransportType transportType = context.getProperty(TRANSPORT_TYPE).asDescribedValue(AzureEventHubTransportType.class).asAmqpTransportType();
+        final AmqpTransportType transportType = context.getProperty(TRANSPORT_TYPE).asAllowableValue(AzureEventHubTransportType.class).asAmqpTransportType();
 
         final EventProcessorClientBuilder eventProcessorClientBuilder = new EventProcessorClientBuilder()
                 .transportType(transportType)

diff --git a/...-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/GetAzureEventHub.java b/...-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/GetAzureEventHub.java
@@ -360,7 +360,7 @@ private EventHubClientBuilder createEventHubClientBuilder(final ProcessContext c
         final String serviceBusEndpoint = context.getProperty(SERVICE_BUS_ENDPOINT).getValue();
         final boolean useManagedIdentity = context.getProperty(USE_MANAGED_IDENTITY).asBoolean();
         final String fullyQualifiedNamespace = String.format("%s%s", namespace, serviceBusEndpoint);
-        final AmqpTransportType transportType = context.getProperty(TRANSPORT_TYPE).asDescribedValue(AzureEventHubTransportType.class).asAmqpTransportType();
+        final AmqpTransportType transportType = context.getProperty(TRANSPORT_TYPE).asAllowableValue(AzureEventHubTransportType.class).asAmqpTransportType();
 
         final EventHubClientBuilder eventHubClientBuilder = new EventHubClientBuilder();
         eventHubClientBuilder.transportType(transportType);

diff --git a/...-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/PutAzureEventHub.java b/...-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/PutAzureEventHub.java
@@ -187,7 +187,7 @@ protected EventHubProducerClient createEventHubProducerClient(final ProcessConte
         final String namespace = context.getProperty(NAMESPACE).getValue();
         final String serviceBusEndpoint = context.getProperty(SERVICE_BUS_ENDPOINT).getValue();
         final String eventHubName = context.getProperty(EVENT_HUB_NAME).getValue();
-        final AmqpTransportType transportType = context.getProperty(TRANSPORT_TYPE).asDescribedValue(AzureEventHubTransportType.class).asAmqpTransportType();
+        final AmqpTransportType transportType = context.getProperty(TRANSPORT_TYPE).asAllowableValue(AzureEventHubTransportType.class).asAmqpTransportType();
 
         try {
             final EventHubClientBuilder eventHubClientBuilder = new EventHubClientBuilder();

diff --git a/...sors/src/main/java/org/apache/nifi/processors/azure/storage/CopyAzureBlobStorage_v12.java b/...sors/src/main/java/org/apache/nifi/processors/azure/storage/CopyAzureBlobStorage_v12.java
@@ -200,7 +200,7 @@ public void onTrigger(final ProcessContext context, final ProcessSession session
         ).orElse(sourceBlobName);
 
         final boolean createContainer = context.getProperty(AzureStorageUtils.CREATE_CONTAINER).asBoolean();
-        final AzureStorageConflictResolutionStrategy conflictResolution = context.getProperty(AzureStorageUtils.CONFLICT_RESOLUTION).asDescribedValue(AzureStorageConflictResolutionStrategy.class);
+        final AzureStorageConflictResolutionStrategy conflictResolution = context.getProperty(AzureStorageUtils.CONFLICT_RESOLUTION).asAllowableValue(AzureStorageConflictResolutionStrategy.class);
 
         final long startNanos = System.nanoTime();
         try {

diff --git a/...ssors/src/main/java/org/apache/nifi/processors/azure/storage/PutAzureBlobStorage_v12.java b/...ssors/src/main/java/org/apache/nifi/processors/azure/storage/PutAzureBlobStorage_v12.java
@@ -138,7 +138,7 @@ public void onTrigger(final ProcessContext context, final ProcessSession session
         final String containerName = context.getProperty(AzureStorageUtils.CONTAINER).evaluateAttributeExpressions(flowFile).getValue();
         final boolean createContainer = context.getProperty(AzureStorageUtils.CREATE_CONTAINER).asBoolean();
         final String blobName = context.getProperty(BLOB_NAME).evaluateAttributeExpressions(flowFile).getValue();
-        final AzureStorageConflictResolutionStrategy conflictResolution = context.getProperty(AzureStorageUtils.CONFLICT_RESOLUTION).asDescribedValue(AzureStorageConflictResolutionStrategy.class);
+        final AzureStorageConflictResolutionStrategy conflictResolution = context.getProperty(AzureStorageUtils.CONFLICT_RESOLUTION).asAllowableValue(AzureStorageConflictResolutionStrategy.class);
         final ResourceTransferSource resourceTransferSource = ResourceTransferSource.valueOf(context.getProperty(RESOURCE_TRANSFER_SOURCE).getValue());
 
         long startNanos = System.nanoTime();

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
@@ -148,7 +148,7 @@ protected StreamingClient createClient(final ConfigurationContext context) throw
     private ConnectionStringBuilder getConnectionStringBuilder(final ConfigurationContext context) {
         final String clusterUrl = context.getProperty(CLUSTER_URI).getValue();
         final String clientId = context.getProperty(APPLICATION_CLIENT_ID).getValue();
-        final KustoAuthenticationStrategy kustoAuthenticationStrategy = context.getProperty(AUTHENTICATION_STRATEGY).asDescribedValue(KustoAuthenticationStrategy.class);
+        final KustoAuthenticationStrategy kustoAuthenticationStrategy = context.getProperty(AUTHENTICATION_STRATEGY).asAllowableValue(KustoAuthenticationStrategy.class);
 
         final ConnectionStringBuilder builder = switch (kustoAuthenticationStrategy) {
             case APPLICATION_CREDENTIALS -> {

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
@@ -177,8 +177,8 @@ public void onEnabled(final ConfigurationContext context) {
         final String eventHubName = context.getProperty(EVENT_HUB_NAME).evaluateAttributeExpressions().getValue();
         final String policyName = context.getProperty(SHARED_ACCESS_POLICY).getValue();
         final String policyKey = context.getProperty(SHARED_ACCESS_POLICY_KEY).getValue();
-        final AzureAuthenticationStrategy azureAuthenticationStrategy = context.getProperty(AUTHENTICATION_STRATEGY).asDescribedValue(AzureAuthenticationStrategy.class);
-        final AmqpTransportType transportType = context.getProperty(TRANSPORT_TYPE).asDescribedValue(AzureEventHubTransportType.class).asAmqpTransportType();
+        final AzureAuthenticationStrategy azureAuthenticationStrategy = context.getProperty(AUTHENTICATION_STRATEGY).asAllowableValue(AzureAuthenticationStrategy.class);
+        final AmqpTransportType transportType = context.getProperty(TRANSPORT_TYPE).asAllowableValue(AzureEventHubTransportType.class).asAmqpTransportType();
         client = createEventHubClient(namespace, serviceBusEndpoint, eventHubName, policyName, policyKey, azureAuthenticationStrategy, transportType);
     }
 

diff --git a/...rc/main/java/org/apache/nifi/services/azure/storage/ADLSCredentialsControllerService.java b/...rc/main/java/org/apache/nifi/services/azure/storage/ADLSCredentialsControllerService.java
@@ -35,7 +35,6 @@
 
 import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.CREDENTIALS_TYPE;
 import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.MANAGED_IDENTITY_CLIENT_ID;
-import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.PROXY_CONFIGURATION_SERVICE;
 import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.SERVICE_PRINCIPAL_CLIENT_ID;
 import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.SERVICE_PRINCIPAL_CLIENT_SECRET;
 import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.SERVICE_PRINCIPAL_TENANT_ID;
@@ -134,7 +133,7 @@ public ADLSCredentialsDetails getCredentialsDetails(Map<String, String> attribut
         setValue(credentialsBuilder, ACCOUNT_KEY, PropertyValue::getValue, ADLSCredentialsDetails.Builder::setAccountKey, attributes);
         setValue(credentialsBuilder, SAS_TOKEN, PropertyValue::getValue, ADLSCredentialsDetails.Builder::setSasToken, attributes);
         setValue(credentialsBuilder, ENDPOINT_SUFFIX, PropertyValue::getValue, ADLSCredentialsDetails.Builder::setEndpointSuffix, attributes);
-        setValue(credentialsBuilder, CREDENTIALS_TYPE, property -> property.asDescribedValue(AzureStorageCredentialsType.class) == AzureStorageCredentialsType.MANAGED_IDENTITY,
+        setValue(credentialsBuilder, CREDENTIALS_TYPE, property -> property.asAllowableValue(AzureStorageCredentialsType.class) == AzureStorageCredentialsType.MANAGED_IDENTITY,
                 ADLSCredentialsDetails.Builder::setUseManagedIdentity, attributes);
         setValue(credentialsBuilder, MANAGED_IDENTITY_CLIENT_ID, PropertyValue::getValue, ADLSCredentialsDetails.Builder::setManagedIdentityClientId, attributes);
         setValue(credentialsBuilder, SERVICE_PRINCIPAL_TENANT_ID, PropertyValue::getValue, ADLSCredentialsDetails.Builder::setServicePrincipalTenantId, attributes);

diff --git a/.../org/apache/nifi/services/azure/storage/AzureStorageCredentialsControllerService_v12.java b/.../org/apache/nifi/services/azure/storage/AzureStorageCredentialsControllerService_v12.java
@@ -33,7 +33,6 @@
 import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.ACCOUNT_NAME;
 import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.CREDENTIALS_TYPE;
 import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.MANAGED_IDENTITY_CLIENT_ID;
-import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.PROXY_CONFIGURATION_SERVICE;
 import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.SAS_TOKEN;
 import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.SERVICE_PRINCIPAL_CLIENT_ID;
 import static org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils.SERVICE_PRINCIPAL_CLIENT_SECRET;
@@ -87,7 +86,7 @@ public void onEnabled(ConfigurationContext context) {
     public AzureStorageCredentialsDetails_v12 getCredentialsDetails(Map<String, String> attributes) {
         String accountName = context.getProperty(ACCOUNT_NAME).getValue();
         String endpointSuffix = context.getProperty(ENDPOINT_SUFFIX).getValue();
-        AzureStorageCredentialsType credentialsType = context.getProperty(CREDENTIALS_TYPE).asDescribedValue(AzureStorageCredentialsType.class);
+        AzureStorageCredentialsType credentialsType = context.getProperty(CREDENTIALS_TYPE).asAllowableValue(AzureStorageCredentialsType.class);
         ProxyOptions proxyOptions = AzureStorageUtils.getProxyOptions(context);
 
         switch (credentialsType) {

diff --git a/...sql-processors/src/main/java/org/apache/nifi/cdc/mysql/processors/CaptureChangeMySQL.java b/...sql-processors/src/main/java/org/apache/nifi/cdc/mysql/processors/CaptureChangeMySQL.java
@@ -580,7 +580,7 @@ public void setup(ProcessContext context) {
         binlogResourceInfo.setInTransaction("true".equals(stateMap.get("inTransaction")));
 
         // Build a event writer config object for the event writers to use
-        final FlowFileEventWriteStrategy flowFileEventWriteStrategy = context.getProperty(EVENTS_PER_FLOWFILE_STRATEGY).asDescribedValue(FlowFileEventWriteStrategy.class);
+        final FlowFileEventWriteStrategy flowFileEventWriteStrategy = context.getProperty(EVENTS_PER_FLOWFILE_STRATEGY).asAllowableValue(FlowFileEventWriteStrategy.class);
         eventWriterConfiguration = new EventWriterConfiguration(
                 flowFileEventWriteStrategy,
                 context.getProperty(NUMBER_OF_EVENTS_PER_FLOWFILE).evaluateAttributeExpressions().asInteger()

diff --git a/...ifi-cipher-processors/src/main/java/org/apache/nifi/processors/cipher/DecryptContent.java b/...ifi-cipher-processors/src/main/java/org/apache/nifi/processors/cipher/DecryptContent.java
@@ -161,11 +161,11 @@ public void onTrigger(final ProcessContext context, final ProcessSession session
             return;
         }
 
-        final KeySpecificationFormat keySpecificationFormat = context.getProperty(KEY_SPECIFICATION_FORMAT).asDescribedValue(KeySpecificationFormat.class);
+        final KeySpecificationFormat keySpecificationFormat = context.getProperty(KEY_SPECIFICATION_FORMAT).asAllowableValue(KeySpecificationFormat.class);
 
         final String cipherTransformation = getCipherTransformation(context);
         final Cipher cipher = getCipher(cipherTransformation);
-        final CipherAlgorithmMode cipherAlgorithmMode = context.getProperty(CIPHER_ALGORITHM_MODE).asDescribedValue(CipherAlgorithmMode.class);
+        final CipherAlgorithmMode cipherAlgorithmMode = context.getProperty(CIPHER_ALGORITHM_MODE).asAllowableValue(CipherAlgorithmMode.class);
 
         final KeySpec keySpec = getKeySpec(context, keySpecificationFormat);
         final StreamCallback callback = new DecryptCallback(cipher, cipherAlgorithmMode, keySpec);

diff --git a/...-cipher-processors/src/main/java/org/apache/nifi/processors/cipher/DecryptContentAge.java b/...-cipher-processors/src/main/java/org/apache/nifi/processors/cipher/DecryptContentAge.java
@@ -224,7 +224,7 @@ public void onTrigger(final ProcessContext context, final ProcessSession session
     }
 
     private List<RecipientStanzaReader> getRecipientStanzaReaders(final PropertyContext context) throws IOException {
-        final KeySource keySource = context.getProperty(PRIVATE_KEY_SOURCE).asDescribedValue(KeySource.class);
+        final KeySource keySource = context.getProperty(PRIVATE_KEY_SOURCE).asAllowableValue(KeySource.class);
         final List<ResourceReference> resources = switch (keySource) {
             case PROPERTIES -> List.of(context.getProperty(PRIVATE_KEY_IDENTITIES).asResource());
             case RESOURCES -> context.getProperty(PRIVATE_KEY_IDENTITY_RESOURCES).asResources().asList();

diff --git a/...ocessors/src/main/java/org/apache/nifi/processors/cipher/DecryptContentCompatibility.java b/...ocessors/src/main/java/org/apache/nifi/processors/cipher/DecryptContentCompatibility.java
@@ -143,15 +143,15 @@ public void onTrigger(final ProcessContext context, final ProcessSession session
         }
 
         final CompatibilityModeEncryptionScheme encryptionScheme =
-                context.getProperty(ENCRYPTION_SCHEME).asDescribedValue(CompatibilityModeEncryptionScheme.class);
+                context.getProperty(ENCRYPTION_SCHEME).asAllowableValue(CompatibilityModeEncryptionScheme.class);
         final String scheme = encryptionScheme.getValue();
         final Cipher cipher = getCipher(scheme);
 
         final char[] password = context.getProperty(PASSWORD).getValue().toCharArray();
         final PBEKeySpec keySpec = new PBEKeySpec(password);
 
         final CompatibilityModeKeyDerivationStrategy keyDerivationStrategy =
-                context.getProperty(KEY_DERIVATION_STRATEGY).asDescribedValue(CompatibilityModeKeyDerivationStrategy.class);
+                context.getProperty(KEY_DERIVATION_STRATEGY).asAllowableValue(CompatibilityModeKeyDerivationStrategy.class);
         final StreamCallback callback = new DecryptCallback(cipher, keySpec, keyDerivationStrategy);
 
         final Map<String, String> attributes = new LinkedHashMap<>();