From 511360cf59884bd451385fe005fa96aa61d584b1 Mon Sep 17 00:00:00 2001 From: danbress Date: Thu, 19 Mar 2015 08:32:18 -0400 Subject: [PATCH 1/6] NIFI-441 - renaming index.html to additionalDetails.html and removing html that is generated by the framework --- .../additionalDetails.html | 28 ++++++ .../docs/__package__.MyProcessor/index.html | 96 ------------------- 2 files changed, 28 insertions(+), 96 deletions(-) create mode 100644 nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html delete mode 100644 nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/index.html diff --git a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html new file mode 100644 index 0000000000..235cffa586 --- /dev/null +++ b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html @@ -0,0 +1,28 @@ + + + + + + MyProcessor + + + + +

This is a place to provide additional text, images and references that best describe how your processor is used +

+ + + diff --git a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/index.html b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/index.html deleted file mode 100644 index 34e494fa5c..0000000000 --- a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/index.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - GetFile - - - - - -

Description:

- -

Replace with a description.

- -

- Uses Attributes: -

- - - - - - - - - - - - - -
Attribute NameDescription
- -

- Modifies Attributes: -

- - - - - - - - - - - - - -
Attribute NameDescription
- -

- Properties: -

- -

In the list below, the names of required properties appear - in bold. Any other properties (not in bold) are considered optional. - If a property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated.

- - -

- Relationships: -

- - - - From efeba19cb6c72585ecaacbbb6662a274fab8f477 Mon Sep 17 00:00:00 2001 From: danbress Date: Thu, 19 Mar 2015 08:32:42 -0400 Subject: [PATCH 2/6] NIFI-441 Defaulting nifi version to 0.1.0-incubating-SNAPSHOT --- .../src/main/resources/META-INF/maven/archetype-metadata.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml index 085bd99834..979916c356 100644 --- a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml +++ b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml @@ -17,7 +17,7 @@ - 0.0.1-incubating-SNAPSHOT + 0.1.0-incubating-SNAPSHOT ${groupId}.processors.${artifactBaseName} From f63e09b9b8480d3bbe78beee4b12cd5cb3ed8979 Mon Sep 17 00:00:00 2001 From: danbress Date: Thu, 19 Mar 2015 08:37:27 -0400 Subject: [PATCH 3/6] NIFI-441 - Adding SeeAlso, ReadsAttributes and WritesAttributes --- .../src/main/java/MyProcessor.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/java/MyProcessor.java b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/java/MyProcessor.java index 7d29b5e466..8d9d261526 100644 --- a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/java/MyProcessor.java +++ b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/java/MyProcessor.java @@ -22,7 +22,12 @@ import org.apache.nifi.flowfile.FlowFile; import org.apache.nifi.processor.*; import org.apache.nifi.annotation.lifecycle.OnScheduled; import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.ReadsAttribute; +import org.apache.nifi.annotation.documentation.ReadsAttributes; +import org.apache.nifi.annotation.documentation.SeeAlso; import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.documentation.WritesAttribute; +import org.apache.nifi.annotation.documentation.WritesAttributes; import org.apache.nifi.processor.exception.ProcessException; import org.apache.nifi.processor.util.StandardValidators; @@ -30,6 +35,9 @@ import java.util.*; @Tags({"example"}) @CapabilityDescription("Provide a description") +@SeeAlso({}) +@ReadsAttributes({@ReadsAttribute(attribute="", description="")}) +@WritesAttributes({@WritesAttribute(attribute="", description="")}) public class MyProcessor extends AbstractProcessor { public static final PropertyDescriptor MY_PROPERTY = new PropertyDescriptor From 0f6fb7ecac8fc11a11d947db4fbf310fa1784e34 Mon Sep 17 00:00:00 2001 From: danbress Date: Thu, 19 Mar 2015 08:37:44 -0400 Subject: [PATCH 4/6] NIFI-441 updating additionalDetails.html --- .../docs/__package__.MyProcessor/additionalDetails.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html index 235cffa586..533754371c 100644 --- a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html +++ b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html @@ -21,7 +21,7 @@ -

This is a place to provide additional text, images and references that best describe how your processor is used +

This is a place to provide additional text, images and references that best describe how to use your processor. If this level of detail is not necessary, you can remove this file.

From 3359891c660020cf583a92e738f9ba1b75f21aae Mon Sep 17 00:00:00 2001 From: danbress Date: Mon, 23 Mar 2015 08:34:41 -0400 Subject: [PATCH 5/6] NIFI-441 incorporating changes from moving annotations --- .../src/main/java/MyProcessor.java | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/java/MyProcessor.java b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/java/MyProcessor.java index 8d9d261526..7b70dcab7f 100644 --- a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/java/MyProcessor.java +++ b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/java/MyProcessor.java @@ -20,14 +20,14 @@ import org.apache.nifi.components.PropertyDescriptor; import org.apache.nifi.components.PropertyValue; import org.apache.nifi.flowfile.FlowFile; import org.apache.nifi.processor.*; +import org.apache.nifi.annotation.behavior.ReadsAttribute; +import org.apache.nifi.annotation.behavior.ReadsAttributes; +import org.apache.nifi.annotation.behavior.WritesAttribute; +import org.apache.nifi.annotation.behavior.WritesAttributes; import org.apache.nifi.annotation.lifecycle.OnScheduled; import org.apache.nifi.annotation.documentation.CapabilityDescription; -import org.apache.nifi.annotation.documentation.ReadsAttribute; -import org.apache.nifi.annotation.documentation.ReadsAttributes; import org.apache.nifi.annotation.documentation.SeeAlso; import org.apache.nifi.annotation.documentation.Tags; -import org.apache.nifi.annotation.documentation.WritesAttribute; -import org.apache.nifi.annotation.documentation.WritesAttributes; import org.apache.nifi.processor.exception.ProcessException; import org.apache.nifi.processor.util.StandardValidators; From e78aeddb6937d5ed54f73d1f6dcf11547181e374 Mon Sep 17 00:00:00 2001 From: danbress Date: Mon, 23 Mar 2015 09:59:50 -0400 Subject: [PATCH 6/6] NIFI-441 removing additionalDetails.html --- .../additionalDetails.html | 28 ------------------- 1 file changed, 28 deletions(-) delete mode 100644 nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html diff --git a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html b/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html deleted file mode 100644 index 533754371c..0000000000 --- a/nifi/nifi-maven-archetypes/nifi-processor-bundle-archetype/src/main/resources/archetype-resources/nifi-__artifactBaseName__-processors/src/main/resources/docs/__package__.MyProcessor/additionalDetails.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - MyProcessor - - - - -

This is a place to provide additional text, images and references that best describe how to use your processor. If this level of detail is not necessary, you can remove this file. -

- - -