You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by mc...@apache.org on 2015/02/06 14:55:18 UTC
incubator-nifi git commit: NIFI-250: - Javadocs.
Repository: incubator-nifi
Updated Branches:
refs/heads/NIFI-250 6892f19d6 -> d95ca18a0
NIFI-250:
- Javadocs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/d95ca18a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/d95ca18a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/d95ca18a
Branch: refs/heads/NIFI-250
Commit: d95ca18a0cc6834defbf184e2cae5ee93228e832
Parents: 6892f19
Author: Matt Gilman <ma...@gmail.com>
Authored: Fri Feb 6 08:55:07 2015 -0500
Committer: Matt Gilman <ma...@gmail.com>
Committed: Fri Feb 6 08:55:07 2015 -0500
----------------------------------------------------------------------
.../apache/nifi/web/ConfigurationRequest.java | 8 ++++++++
.../org/apache/nifi/web/FlowModification.java | 19 ++++++++++++++++++-
.../nifi/web/OptimisticLockingManager.java | 4 +++-
.../web/StandardOptimisticLockingManager.java | 2 +-
.../java/org/apache/nifi/web/UpdateRevision.java | 9 +++++++--
5 files changed, 37 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/d95ca18a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/ConfigurationRequest.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/ConfigurationRequest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/ConfigurationRequest.java
index 3d7db9c..939c3f0 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/ConfigurationRequest.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/ConfigurationRequest.java
@@ -17,10 +17,18 @@
package org.apache.nifi.web;
/**
+ * Represents a request to configure. The implementations execute method will
+ * perform the configuration action. It will return type T which will be
+ * encapsulated in a ConfigurationSnapshot.
*
* @param <T>
*/
public interface ConfigurationRequest<T> {
+ /**
+ * Executes a configuration action and returns the updated resulting configuration.
+ *
+ * @return The resulting configuration
+ */
T execute();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/d95ca18a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/FlowModification.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/FlowModification.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/FlowModification.java
index 4bde6fe..f6bccb1 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/FlowModification.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/FlowModification.java
@@ -17,22 +17,39 @@
package org.apache.nifi.web;
/**
- *
+ * Records a flow modification. This includes the resulting revision and the
+ * user that performed the modification.
*/
public class FlowModification {
private final Revision revision;
private final String lastModifier;
+ /**
+ * Creates a new FlowModification.
+ *
+ * @param revision
+ * @param lastModifier
+ */
public FlowModification(Revision revision, String lastModifier) {
this.revision = revision;
this.lastModifier = lastModifier;
}
+ /**
+ * Get the revision.
+ *
+ * @return
+ */
public Revision getRevision() {
return revision;
}
+ /**
+ * Get the last modifier.
+ *
+ * @return
+ */
public String getLastModifier() {
return lastModifier;
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/d95ca18a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/OptimisticLockingManager.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/OptimisticLockingManager.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/OptimisticLockingManager.java
index 455a5d6..4c54b7c 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/OptimisticLockingManager.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/OptimisticLockingManager.java
@@ -25,7 +25,6 @@ package org.apache.nifi.web;
*/
public interface OptimisticLockingManager {
-
/**
* Attempts to execute the specified configuration request using the specified revision within a lock.
*
@@ -44,6 +43,9 @@ public interface OptimisticLockingManager {
void setRevision(UpdateRevision updateRevision);
/**
+ * Returns the last flow modification. This is a combination of the revision and the user
+ * who performed the modification.
+ *
* @return the last modification
*/
FlowModification getLastModification();
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/d95ca18a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/StandardOptimisticLockingManager.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/StandardOptimisticLockingManager.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/StandardOptimisticLockingManager.java
index e8a98dd..23ef8eb 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/StandardOptimisticLockingManager.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/StandardOptimisticLockingManager.java
@@ -132,7 +132,7 @@ public class StandardOptimisticLockingManager implements OptimisticLockingManage
// record the last modifier
lastModifier = lastModification.getLastModifier();
- // record the updated revision
+ // record the updated revision in the cluster context if possible
final ClusterContext ctx = ClusterContextThreadLocal.getContext();
if (ctx != null) {
ctx.setRevision(lastModification.getRevision());
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/d95ca18a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/UpdateRevision.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/UpdateRevision.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/UpdateRevision.java
index 700614f..e691bbe 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/UpdateRevision.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-optimistic-locking/src/main/java/org/apache/nifi/web/UpdateRevision.java
@@ -17,10 +17,15 @@
package org.apache.nifi.web;
/**
- *
+ * Represents an action that will result in an updated revision.
*/
public interface UpdateRevision {
+ /**
+ * Executes the action that will result in an updated revision
+ *
+ * @param currentRevision The current revision
+ * @return The updated revision
+ */
Revision execute(Revision currentRevision);
-
}