NIFI-250: - Updating 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/d4321f50 Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/d4321f50 Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/d4321f50
Branch: refs/heads/NIFI-250 Commit: d4321f50d6adc1534d318405fb23838032c054d7 Parents: 5394a82 Author: Matt Gilman <[email protected]> Authored: Tue Mar 31 07:39:47 2015 -0400 Committer: Matt Gilman <[email protected]> Committed: Tue Mar 31 07:39:47 2015 -0400 ---------------------------------------------------------------------- .../main/java/org/apache/nifi/web/ClusterRequestException.java | 1 + .../java/org/apache/nifi/web/NiFiWebConfigurationContext.java | 6 ++++++ .../apache/nifi/web/NiFiWebConfigurationRequestContext.java | 2 ++ .../src/main/java/org/apache/nifi/web/UiExtensionType.java | 6 +++++- 4 files changed, 14 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/d4321f50/nifi/nifi-api/src/main/java/org/apache/nifi/web/ClusterRequestException.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/web/ClusterRequestException.java b/nifi/nifi-api/src/main/java/org/apache/nifi/web/ClusterRequestException.java index 0ecea3b..ee5f417 100644 --- a/nifi/nifi-api/src/main/java/org/apache/nifi/web/ClusterRequestException.java +++ b/nifi/nifi-api/src/main/java/org/apache/nifi/web/ClusterRequestException.java @@ -17,6 +17,7 @@ package org.apache.nifi.web; /** + * An general error occurred when attempting to communicate with the cluster. */ public class ClusterRequestException extends RuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/d4321f50/nifi/nifi-api/src/main/java/org/apache/nifi/web/NiFiWebConfigurationContext.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/web/NiFiWebConfigurationContext.java b/nifi/nifi-api/src/main/java/org/apache/nifi/web/NiFiWebConfigurationContext.java index 53c715f..50f0ca3 100644 --- a/nifi/nifi-api/src/main/java/org/apache/nifi/web/NiFiWebConfigurationContext.java +++ b/nifi/nifi-api/src/main/java/org/apache/nifi/web/NiFiWebConfigurationContext.java @@ -50,6 +50,8 @@ public interface NiFiWebConfigurationContext { * * @param requestContext * @param actions + * @throws IllegalArgumentException When the requestContext isn't fully populated or + * isn't appropriate for the given request */ void saveActions(NiFiWebRequestContext requestContext, Collection<ConfigurationAction> actions); @@ -79,6 +81,8 @@ public interface NiFiWebConfigurationContext { * @throws ClusterRequestException if the annotation data was unable to be * set for the underlying component. This exception will only be thrown when operating * in a cluster. + * @throws IllegalArgumentException When the requestContext isn't fully populated or + * isn't appropriate for the given request */ ComponentDetails setAnnotationData(NiFiWebConfigurationRequestContext configurationContext, String annotationData) throws ResourceNotFoundException, InvalidRevisionException, ClusterRequestException; @@ -91,6 +95,8 @@ public interface NiFiWebConfigurationContext { * @throws ClusterRequestException if the underlying component was unable to be * retrieved from the cluster. This exception will only be thrown when * operating in a cluster. + * @throws IllegalArgumentException When the requestContext isn't fully populated or + * isn't appropriate for the given request */ ComponentDetails getComponentDetails(NiFiWebRequestContext requestContext) throws ResourceNotFoundException, ClusterRequestException; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/d4321f50/nifi/nifi-api/src/main/java/org/apache/nifi/web/NiFiWebConfigurationRequestContext.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/web/NiFiWebConfigurationRequestContext.java b/nifi/nifi-api/src/main/java/org/apache/nifi/web/NiFiWebConfigurationRequestContext.java index 1e1697b..7912241 100644 --- a/nifi/nifi-api/src/main/java/org/apache/nifi/web/NiFiWebConfigurationRequestContext.java +++ b/nifi/nifi-api/src/main/java/org/apache/nifi/web/NiFiWebConfigurationRequestContext.java @@ -22,6 +22,8 @@ package org.apache.nifi.web; public interface NiFiWebConfigurationRequestContext extends NiFiWebRequestContext { /** + * The revision to include in the request. + * * @return the revision */ Revision getRevision(); http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/d4321f50/nifi/nifi-api/src/main/java/org/apache/nifi/web/UiExtensionType.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/web/UiExtensionType.java b/nifi/nifi-api/src/main/java/org/apache/nifi/web/UiExtensionType.java index 8a70b69..0bbda16 100644 --- a/nifi/nifi-api/src/main/java/org/apache/nifi/web/UiExtensionType.java +++ b/nifi/nifi-api/src/main/java/org/apache/nifi/web/UiExtensionType.java @@ -17,7 +17,11 @@ package org.apache.nifi.web; /** - * Types of UI extensions. + * Types of UI extensions. Since a UI extension could support multiple + * types of custom UIs it will need to include the type so the framework + * can appropriate understand and process the request (recording actions + * in the audit database, replicating a request throughout the cluster to + * the appropriate endpoints, etc). */ public enum UiExtensionType { ContentViewer,
