NIFI-15258 Added API for Connectors (#70)

NIFI-15259: Adding web context interface for custom Connector UIs.
NIFI-15322: Require all property descriptors within a PropertyGroup / ConfigurationStep are unique (#27)
NIFI-15326: Adding support for connector configuration step documentation. (#28)
NIFI-15312: Moved SecretsProvider / SecretsManager to framework instead of api; added description to Secret and updated ParameterProvider to allow more specific fetching of parameters; cleaned up Connector validation logic (#29)
NIFI-15343: Adding providerId to Secret. (#30)
NIFI-15258: Enable Custom UI to retrieve connector with flow contexts (#33)
NIFI-15352: Added getFullyQualifiedName to secret, to encapsulate the combination of group and name (#35)
NIFI-15352: Added getFullyQualifiedName to SecretReference
NIFI-15315 Add support for assets in Connectors (#31)
NIFI-15361: Removing documentation from ConfigurationStep. (#38)
NIFI-15369: Allow ConfigurationStep to depend on another (ConfigurationStep,Property) tuple (#39)
NIFI-15356: Introducing the ConnectorWebMethod. (#37)
NIFI-15353: Adding documentation writers for connectors. (#40)
NIFI-15428: If non-existent property value is set, connector should be invalid. (#43)
NIFI-15427: Added drainFlowFiles(FlowContext) method to Connector (#42)
NIFI-15440: Implementation of ConnectorActions (#47)
NIFI-15446: Updated JavaDocs to clarify how invocations of Connector Methods work (#45)
NIFI-15461: Fixed bug that caused system tests to fail (#48)
NIFI-15451: Provide ability for Connectors to lookup Bundles available for a given component type (#46)
NIFI-15485: Include provider name when providing fqn for secrets (#52)
NIFI-15467: Allow Connectors to specify bundle compatability when upd… (#54)
NIFI-15536: Change Connector API to use DescribedValue vs AllowableValue (#60)
NIFI-15514: Ensure that when AbstractConnector is started, it includes all components, not just processors and controller services; code cleanup (#57)
NIFI-15538: When starting/stopping components allow specifying whether or not the action should be recursive; code cleanup and simplification to use a Virtual Thread to execute code sequentially instead of chaining CompletableFutures. (#61)
NIFI-15480: Added DropFlowFileSummary, ability to drop FlowFiles from a ConnectionFacade / ProcessGroupFacade (#62)
NIFI-15557: Allow Connectors to enable a Controller Service using overridden property values (#63)
NIFI-15565: Code cleanup (#64)
NIFI-15621: Allow Configuration to Validate with ValidationContext (#69)

Co-authored-by: Mark Payne <markap14@hotmail.com>
Co-authored-by: Matt Gilman <matt.c.gilman@gmail.com>
Co-authored-by: Bryan Bende <bbende@apache.org>
Co-authored-by: Bob Paulin <bob@bobpaulin.com>
Signed-off-by: David Handermann <exceptionfactory@apache.org>

Author: 4 people

src/main/java/org/apache/nifi/action/Component.java

@@ -38,5 +38,7 @@ public enum Component {
     AccessPolicy,
     User,
     UserGroup,
-    Label
+    Label,
+    Connector;
+
 }

src/main/java/org/apache/nifi/annotation/lifecycle/OnAdded.java

@@ -29,9 +29,10 @@
  * {@link org.apache.nifi.controller.ControllerService ControllerService},
  * {@link org.apache.nifi.registry.flow.FlowRegistryClient FlowRegistryClient},
  * {@link org.apache.nifi.parameter.ParameterProvider ParameterProvider},
- * {@link org.apache.nifi.flowanalysis.FlowAnalysisRule FlowAnalysisRule}, or
- * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} implementation
- * can use to indicate a method should be called whenever the component is added
+ * {@link org.apache.nifi.flowanalysis.FlowAnalysisRule FlowAnalysisRule},
+ * {@link org.apache.nifi.reporting.ReportingTask ReportingTask}, or
+ * {@link org.apache.nifi.components.connector.Connector Connector}
+ * implementation can use to indicate a method should be called whenever the component is added
  * to the flow. This method will be called once for the entire life of a
  * component instance.
  * </p>

src/main/java/org/apache/nifi/asset/Asset.java

@@ -37,9 +37,18 @@ public interface Asset {
      * Returns the identifier of the parameter context the Asset belongs to
      *
      * @return Parameter Context Identifier
+     * @deprecated Use {@link #getOwnerIdentifier()} instead
      */
+    @Deprecated
     String getParameterContextIdentifier();
 
+    /**
+     * Returns the identifier of the resource the Asset belongs to
+     *
+     * @return Owner Identifier
+     */
+    String getOwnerIdentifier();
+
     /**
      * Returns the name of the Asset
      *

src/main/java/org/apache/nifi/components/ConfigVerificationResult.java

@@ -20,11 +20,13 @@
 public class ConfigVerificationResult {
     private final Outcome outcome;
     private final String verificationStepName;
+    private final String subject;
     private final String explanation;
 
     private ConfigVerificationResult(final Builder builder) {
         outcome = builder.outcome;
         verificationStepName = builder.verificationStepName;
+        subject = builder.subject;
         explanation = builder.explanation;
     }
 
@@ -36,6 +38,10 @@ public String getVerificationStepName() {
         return verificationStepName;
     }
 
+    public String getSubject() {
+        return subject;
+    }
+
     public String getExplanation() {
         return explanation;
     }
@@ -44,13 +50,15 @@ public String getExplanation() {
     public String toString() {
         return "ConfigVerificationResult[" +
             "outcome=" + outcome +
+            ", subject=" + (subject == null ? "null" : "'" + subject + "'") +
             ", verificationStepName='" + verificationStepName + "'" +
             ", explanation='" + explanation + "']";
     }
 
     public static class Builder {
         private Outcome outcome = Outcome.SKIPPED;
         private String verificationStepName = "Unknown Step Name";
+        private String subject;
         private String explanation;
 
         public Builder outcome(final Outcome outcome) {
@@ -63,6 +71,11 @@ public Builder verificationStepName(final String verificationStepName) {
             return this;
         }
 
+        public Builder subject(final String subject) {
+            this.subject = subject;
+            return this;
+        }
+
         public Builder explanation(final String explanation) {
             this.explanation = explanation;
             return this;

src/main/java/org/apache/nifi/components/DescribedValue.java

@@ -35,4 +35,21 @@ public interface DescribedValue {
      * @return the property description as a string
      */
     String getDescription();
+
+    DescribedValue NULL = new DescribedValue() {
+        @Override
+        public String getValue() {
+            return null;
+        }
+
+        @Override
+        public String getDisplayName() {
+            return "NULL";
+        }
+
+        @Override
+        public String getDescription() {
+            return "A null value";
+        }
+    };
 }

src/main/java/org/apache/nifi/components/ValidationContext.java

@@ -200,4 +200,13 @@ private boolean isDependencySatisfied(final PropertyDescriptor propertyDescripto
     default boolean isValidateConnections() {
         return true;
     }
+
+    /**
+     * Evaluates parameter references in the given value, substituting them with their resolved values
+     * using the parameter lookup associated with this ValidationContext.
+     *
+     * @param value the value potentially containing parameter references
+     * @return the value with parameter references substituted, or the original value if no parameters are available
+     */
+    String evaluateParameters(String value);
 }