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-api.git
The following commit(s) were added to refs/heads/main by this push:
new 743cb71 NIFI-16165 Added Node Connection State method to
NodeTypeProvider (#104)
743cb71 is described below
commit 743cb716657e138f9fd74d3a94dc7094a1e343b1
Author: Pierre Villard <[email protected]>
AuthorDate: Mon Aug 17 20:00:45 2026 +0200
NIFI-16165 Added Node Connection State method to NodeTypeProvider (#104)
Signed-off-by: David Handermann <[email protected]>
---
.../nifi/controller/NodeConnectionState.java | 68 ++++++++++++++++++++++
.../apache/nifi/controller/NodeTypeProvider.java | 11 ++++
.../nifi/controller/NodeTypeProviderTest.java | 40 +++++++++++++
3 files changed, 119 insertions(+)
diff --git a/src/main/java/org/apache/nifi/controller/NodeConnectionState.java
b/src/main/java/org/apache/nifi/controller/NodeConnectionState.java
new file mode 100644
index 0000000..5789772
--- /dev/null
+++ b/src/main/java/org/apache/nifi/controller/NodeConnectionState.java
@@ -0,0 +1,68 @@
+/*
+ * 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.controller;
+
+public enum NodeConnectionState {
+ /**
+ * A node has issued a connection request to the cluster, but has not yet
+ * sent a heartbeat. A connecting node can transition to DISCONNECTED or
CONNECTED. The cluster
+ * will not accept any external requests to change the flow while any node
is in
+ * this state.
+ */
+ CONNECTING,
+
+ /**
+ * A node that is connected to the cluster. A connecting node transitions
+ * to connected after the cluster receives the node's first heartbeat. A
+ * connected node can transition to disconnecting.
+ */
+ CONNECTED,
+
+ /**
+ * A node that is in the process of offloading its FlowFiles from the node.
+ */
+ OFFLOADING,
+
+ /**
+ * A node that is in the process of disconnecting from the cluster.
+ * A DISCONNECTING node will always transition to DISCONNECTED.
+ */
+ DISCONNECTING,
+
+ /**
+ * A node that has offloaded its FlowFiles from the node.
+ */
+ OFFLOADED,
+
+ /**
+ * A node that is not connected to the cluster.
+ * A DISCONNECTED node can transition to CONNECTING.
+ */
+ DISCONNECTED,
+
+ /**
+ * A NodeConnectionState of REMOVED indicates that the node was removed
from the cluster
+ * and is used in order to notify other nodes in the cluster.
+ */
+ REMOVED,
+
+ /**
+ * A NiFi instance that is not configured to participate in a cluster.
+ */
+ STANDALONE
+}
diff --git a/src/main/java/org/apache/nifi/controller/NodeTypeProvider.java
b/src/main/java/org/apache/nifi/controller/NodeTypeProvider.java
index 1552282..641bca0 100644
--- a/src/main/java/org/apache/nifi/controller/NodeTypeProvider.java
+++ b/src/main/java/org/apache/nifi/controller/NodeTypeProvider.java
@@ -47,6 +47,17 @@ public interface NodeTypeProvider {
return false;
}
+ /**
+ * Returns the current node connection state and never null. The
compatibility default is
+ * {@link NodeConnectionState#STANDALONE}. Providers for clustered NiFi
should override this
+ * method with the current node lifecycle state.
+ *
+ * @return current node connection state
+ */
+ default NodeConnectionState getNodeConnectionState() {
+ return NodeConnectionState.STANDALONE;
+ }
+
/**
* @return true if this instance is the primary node in the cluster; false
otherwise
*/
diff --git a/src/test/java/org/apache/nifi/controller/NodeTypeProviderTest.java
b/src/test/java/org/apache/nifi/controller/NodeTypeProviderTest.java
new file mode 100644
index 0000000..05bdb4f
--- /dev/null
+++ b/src/test/java/org/apache/nifi/controller/NodeTypeProviderTest.java
@@ -0,0 +1,40 @@
+/*
+ * 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.controller;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class NodeTypeProviderTest {
+
+ @Test
+ void getNodeConnectionStateReturnsStandaloneForLegacyImplementations() {
+ final NodeTypeProvider nodeTypeProvider = new NodeTypeProvider() {
+ @Override
+ public boolean isClustered() {
+ return false;
+ }
+
+ @Override
+ public boolean isPrimary() {
+ return false;
+ }
+ };
+
+ assertEquals(NodeConnectionState.STANDALONE,
nodeTypeProvider.getNodeConnectionState());
+ }
+}
