You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by al...@apache.org on 2016/02/06 04:36:01 UTC
[05/50] nifi git commit: NIFI-259: Fixed checkstyle violations
NIFI-259: Fixed checkstyle violations
Project: http://git-wip-us.apache.org/repos/asf/nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/nifi/commit/0151b1ee
Tree: http://git-wip-us.apache.org/repos/asf/nifi/tree/0151b1ee
Diff: http://git-wip-us.apache.org/repos/asf/nifi/diff/0151b1ee
Branch: refs/heads/master
Commit: 0151b1eed1b232f886539c2ddd7b9305eeea65c7
Parents: d39067e
Author: Mark Payne <ma...@hotmail.com>
Authored: Wed Jan 13 13:57:47 2016 -0500
Committer: Mark Payne <ma...@hotmail.com>
Committed: Wed Jan 13 13:57:47 2016 -0500
----------------------------------------------------------------------
.../main/java/org/apache/nifi/annotation/behavior/Stateful.java | 4 ----
.../java/org/apache/nifi/components/state/StateManager.java | 4 ++--
.../main/java/org/apache/nifi/components/state/StateMap.java | 2 +-
.../src/main/java/org/apache/nifi/processor/ProcessSession.java | 1 -
nifi-docs/src/main/asciidoc/administration-guide.adoc | 5 +++++
.../java/org/apache/nifi/util/StandardProcessorTestRunner.java | 4 ++--
.../java/org/apache/nifi/controller/ConfiguredComponent.java | 2 +-
.../src/main/java/org/apache/nifi/logging/LogRepository.java | 2 +-
.../nifi/controller/scheduling/StandardProcessScheduler.java | 2 +-
.../org/apache/nifi/processors/hadoop/util/HDFSListing.java | 4 ++--
.../main/java/org/apache/nifi/processors/standard/TailFile.java | 2 +-
11 files changed, 16 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/nifi/blob/0151b1ee/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/Stateful.java
----------------------------------------------------------------------
diff --git a/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/Stateful.java b/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/Stateful.java
index 2303e64..f352596 100644
--- a/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/Stateful.java
+++ b/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/Stateful.java
@@ -44,15 +44,11 @@ import org.apache.nifi.components.state.StateManager;
public @interface Stateful {
/**
* Provides a description of what information is being stored in the {@link StateManager}
- *
- * @return a description of what information is being stored in the {@link StateManager}
*/
String description();
/**
* Indicates the Scope(s) associated with the State that is stored and retrieved.
- *
- * @return
*/
Scope[]scopes();
}
http://git-wip-us.apache.org/repos/asf/nifi/blob/0151b1ee/nifi-api/src/main/java/org/apache/nifi/components/state/StateManager.java
----------------------------------------------------------------------
diff --git a/nifi-api/src/main/java/org/apache/nifi/components/state/StateManager.java b/nifi-api/src/main/java/org/apache/nifi/components/state/StateManager.java
index 0c0e867..7ff8cec 100644
--- a/nifi-api/src/main/java/org/apache/nifi/components/state/StateManager.java
+++ b/nifi-api/src/main/java/org/apache/nifi/components/state/StateManager.java
@@ -69,8 +69,8 @@ public interface StateManager {
* If the state has not yet been set, the StateMap's version will be -1, and the map of values will be empty.
*
* @param scope the scope to use when fetching the state
- * @return
- * @throws IOException
+ * @return the current state for the component
+ * @throws IOException if unable to communicate with the underlying storage mechanism
*/
StateMap getState(Scope scope) throws IOException;
http://git-wip-us.apache.org/repos/asf/nifi/blob/0151b1ee/nifi-api/src/main/java/org/apache/nifi/components/state/StateMap.java
----------------------------------------------------------------------
diff --git a/nifi-api/src/main/java/org/apache/nifi/components/state/StateMap.java b/nifi-api/src/main/java/org/apache/nifi/components/state/StateMap.java
index 7984e42..4d67164 100644
--- a/nifi-api/src/main/java/org/apache/nifi/components/state/StateMap.java
+++ b/nifi-api/src/main/java/org/apache/nifi/components/state/StateMap.java
@@ -35,7 +35,7 @@ public interface StateMap {
/**
* Returns the value associated with the given key
- *
+ *
* @param key the key whose value should be retrieved
* @return the value associated with the given key, or <code>null</code> if no value is associated
* with this key.
http://git-wip-us.apache.org/repos/asf/nifi/blob/0151b1ee/nifi-api/src/main/java/org/apache/nifi/processor/ProcessSession.java
----------------------------------------------------------------------
diff --git a/nifi-api/src/main/java/org/apache/nifi/processor/ProcessSession.java b/nifi-api/src/main/java/org/apache/nifi/processor/ProcessSession.java
index 5d867b7..d0c5b46 100644
--- a/nifi-api/src/main/java/org/apache/nifi/processor/ProcessSession.java
+++ b/nifi-api/src/main/java/org/apache/nifi/processor/ProcessSession.java
@@ -25,7 +25,6 @@ import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
-import org.apache.nifi.components.state.StateManager;
import org.apache.nifi.controller.queue.QueueSize;
import org.apache.nifi.flowfile.FlowFile;
import org.apache.nifi.processor.exception.FlowFileAccessException;
http://git-wip-us.apache.org/repos/asf/nifi/blob/0151b1ee/nifi-docs/src/main/asciidoc/administration-guide.adoc
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/administration-guide.adoc b/nifi-docs/src/main/asciidoc/administration-guide.adoc
index 4f30686..23327e2 100644
--- a/nifi-docs/src/main/asciidoc/administration-guide.adoc
+++ b/nifi-docs/src/main/asciidoc/administration-guide.adoc
@@ -548,6 +548,11 @@ We can initialize our Kerberos ticket by running the following command:
[source]
kinit nifi
+Note, the above `kinit` command requires that Kerberos client libraries be installed. This is accomplished in Fedora-based Linux distributions via:
+
+[source]
+yum install krb5-workstation krb5-libs krb5-auth-dialog
+
Now, when we start NiFi, it will use Kerberos to authentication as the `nifi` user when communicating with ZooKeeper.
http://git-wip-us.apache.org/repos/asf/nifi/blob/0151b1ee/nifi-mock/src/main/java/org/apache/nifi/util/StandardProcessorTestRunner.java
----------------------------------------------------------------------
diff --git a/nifi-mock/src/main/java/org/apache/nifi/util/StandardProcessorTestRunner.java b/nifi-mock/src/main/java/org/apache/nifi/util/StandardProcessorTestRunner.java
index ddc1e71..29d31d6 100644
--- a/nifi-mock/src/main/java/org/apache/nifi/util/StandardProcessorTestRunner.java
+++ b/nifi-mock/src/main/java/org/apache/nifi/util/StandardProcessorTestRunner.java
@@ -798,8 +798,8 @@ public class StandardProcessorTestRunner implements TestRunner {
/**
* Returns the State Manager for the given Controller Service.
*
- * @param controllerService
- * @return
+ * @param controllerService the Controller Service whose State Manager should be returned
+ * @return the State Manager for the given Controller Service
*/
@Override
public MockStateManager getStateManager(final ControllerService controllerService) {
http://git-wip-us.apache.org/repos/asf/nifi/blob/0151b1ee/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ConfiguredComponent.java
----------------------------------------------------------------------
diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ConfiguredComponent.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ConfiguredComponent.java
index 7e49700..87acb85 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ConfiguredComponent.java
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ConfiguredComponent.java
@@ -36,7 +36,7 @@ public interface ConfiguredComponent {
/**
* Sets the property with the given name to the given value
- *
+ *
* @param name the name of the property to update
* @param value the value to update the property to
* @param triggerOnPropertyModified if <code>true</code>, will trigger the #onPropertyModified method of the component
http://git-wip-us.apache.org/repos/asf/nifi/blob/0151b1ee/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/logging/LogRepository.java
----------------------------------------------------------------------
diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/logging/LogRepository.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/logging/LogRepository.java
index 6e1311a..54bb672 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/logging/LogRepository.java
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/logging/LogRepository.java
@@ -67,7 +67,7 @@ public interface LogRepository {
/**
* Sets the current logger for the component
- *
+ *
* @param logger the logger to use
*/
void setLogger(ComponentLog logger);
http://git-wip-us.apache.org/repos/asf/nifi/blob/0151b1ee/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java
----------------------------------------------------------------------
diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java
index ee764e6..ef27fb5 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java
@@ -122,7 +122,7 @@ public final class StandardProcessScheduler implements ProcessScheduler {
/**
* Submits the given task to be executed exactly once in a background thread
- *
+ *
* @param task the task to perform
*/
public void submitFrameworkTask(final Runnable task) {
http://git-wip-us.apache.org/repos/asf/nifi/blob/0151b1ee/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/java/org/apache/nifi/processors/hadoop/util/HDFSListing.java
----------------------------------------------------------------------
diff --git a/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/java/org/apache/nifi/processors/hadoop/util/HDFSListing.java b/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/java/org/apache/nifi/processors/hadoop/util/HDFSListing.java
index 27040bf..6786945 100644
--- a/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/java/org/apache/nifi/processors/hadoop/util/HDFSListing.java
+++ b/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/java/org/apache/nifi/processors/hadoop/util/HDFSListing.java
@@ -89,9 +89,9 @@ public class HDFSListing {
}
/**
- * Converts this HDFSListing into a Map<String, String> so that it can be stored in a StateManager.
+ * Converts this HDFSListing into a Map<String, String> so that it can be stored in a StateManager.
*
- * @return a Map<String, String> that represents the same information as this HDFSListing
+ * @return a Map that represents the same information as this HDFSListing
*/
public Map<String, String> toMap() {
final Map<String, String> map = new HashMap<>(1 + matchingPaths.size());
http://git-wip-us.apache.org/repos/asf/nifi/blob/0151b1ee/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/TailFile.java
----------------------------------------------------------------------
diff --git a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/TailFile.java b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/TailFile.java
index 6f99b42..f992978 100644
--- a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/TailFile.java
+++ b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/TailFile.java
@@ -192,7 +192,7 @@ public class TailFile extends AbstractProcessor {
* Recovers values for the State that was stored in a local file.
*
* @param context the ProcessContext that indicates where the state is stored
- * @return a Map<String, String> that contains the keys defined in {@link TailFileState.StateKeys}
+ * @return a Map that contains the keys defined in {@link TailFileState.StateKeys}
* @throws IOException if the state file exists but was unable to be read
*/
private Map<String, String> recoverStateValuesFromFile(final ProcessContext context) throws IOException {