README changes.

Properties cleanup.
2020-06-04 15:55:14 -04:00
parent e1ba63cf21
commit f6a057d8b2
7 changed files with 124 additions and 18 deletions
--- a/README.adoc
+++ b/README.adoc
@@ -23,10 +23,10 @@ The following are the four major components of this repository.

 |link:functions/supplier/file-supplier/README.adoc[File]
 |link:functions/consumer/cassandra-consumer/README.adoc[Cassandra]
-|Filter
+|link:functions/function/filter-function/README.adoc[Filter]
 |link:functions/supplier/http-supplier/README.adoc[HTTP]
 |link:functions/consumer/counter-consumer/README.adoc[Counter]
-|Header-Enricher
+|link:functions/function/header-enricher-function/README.adoc[Header-Enricher]
 |link:functions/supplier/jdbc-supplier/README.adoc[JDBC]
 |link:functions/consumer/file-consumer/README.adoc[File]
 |link:functions/function/http-request-function/README.adoc[HTTP Request]
@@ -35,10 +35,10 @@ The following are the four major components of this repository.
 |
 |link:functions/supplier/mongodb-supplier/README.adoc[MongoDB]
 |link:functions/consumer/ftp-consumer/README.adoc[FTP]
-|SpEL
+|link:functions/function/spel-function/README.adoc[SpEL]
 |link:functions/supplier/mqtt-supplier/README.adoc[MQTT]
 |link:functions/consumer/jdbc-consumer/README.adoc[JDBC]
-|Splitter
+|link:functions/function/splitter-function/README.adoc[Splitter]
 |link:functions/supplier/tcp-supplier/README.adoc[TCP]
 |link:functions/consumer/log-consumer/README.adoc[Log]
 |
@@ -70,32 +70,31 @@ The following are the four major components of this repository.
 |link:applications/source/file-source/README.adoc[File]
 |link:applications/sink/cassandra-sink/README.adoc[Cassandra]
 |link:applications/processor/bridge-processor/README.adoc[Bridge]
-|link:applications/source/http-source/README.adoc[HTTP]
+|link:applications/source/geode-source/README.adoc[Geode]
 |link:applications/sink/counter-sink/README.adoc[Counter]
 |link:applications/processor/filter-processor/README.adoc[Filter]
-|link:applications/source/jdbc-source/README.adoc[JDBC]
+|link:applications/source/http-source/README.adoc[HTTP]
 |link:applications/sink/file-sink/README.adoc[Fiile]
-|
-|link:applications/source/geode-source/README.adoc[Geode]
-|link:applications/sink/geode-sink/README.adoc[Geode]
-|
 |link:applications/processor/groovy-processor/README.adoc[Groovy]
-|link:applications/source/load-generator-source/README.adoc[Load-Generator]
+|link:applications/source/jdbc-source/README.adoc[JDBC]
 |link:applications/sink/ftp-sink/README.adoc[FTP]
 |link:applications/processor/header-enricher-processor/README.adoc[Header-Enricher]
+|link:applications/source/load-generator-source/README.adoc[Load-Generator]
+|link:applications/sink/geode-sink/README.adoc[Geode]
+|link:applications/processor/http-request-processor/README.adoc[HTTP Request]
 |link:applications/source/mongodb-source/README.adoc[MongoDB]
 |link:applications/sink/jdbc-sink/README.adoc[JDBC]
-|link:applications/processor/http-request-processor/README.adoc[HTTP Request]
+|link:applications/processor/script-processor/README.adoc[Script]
 |link:applications/source/mqtt-source/README.adoc[MQTT]
 |link:applications/sink/log-sink/README.adoc[Log]
-|link:applications/processor/script-processor/README.adoc[Script]
-|link:applications/source/tcp-source/README.adoc[TCP]
-|link:applications/sink/mongodb-sink/README.adoc[MongoDB]
 |link:applications/processor/splitter-processor/README.adoc[Splitter]
-|link:applications/source/time-source/README.adoc[Time]
-|link:applications/sink/mqtt-sink/README.adoc[MQTT]
+|link:applications/source/rabbit-source/README.adoc[Rabbit]
+|link:applications/sink/mongodb-sink/README.adoc[MongoDB]
 |link:applications/processor/transform-processor/README.adoc[Transform]
+|link:applications/source/tcp-source/README.adoc[TCP]
+|link:applications/sink/mqtt-sink/README.adoc[MQTT]
 |
+|link:applications/source/time-source/README.adoc[Time]
 |link:applications/sink/rabbit-sink/README.adoc[Rabbit]
 |
 |
@@ -113,6 +112,7 @@ The following are the four major components of this repository.
 |
 |link:applications/sink/throughput-sink/README.adoc[Throughput]
 |
+|
 |===


--- a/applications/stream-applications-build/pom.xml
+++ b/applications/stream-applications-build/pom.xml
@@ -42,6 +42,7 @@
        <redis-sink.version>3.0.0-SNAPSHOT</redis-sink.version>
        <router-sink.version>3.0.0-SNAPSHOT</router-sink.version>
        <sftp-sink.version>3.0.0-SNAPSHOT</sftp-sink.version>
+        <tcp-sink.version>3.0.0-SNAPSHOT</tcp-sink.version>
        <throughput-sink.version>3.0.0-SNAPSHOT</throughput-sink.version>
        <bridge-processor.version>3.0.0-SNAPSHOT</bridge-processor.version>
        <filter-processor.version>3.0.0-SNAPSHOT</filter-processor.version>
--- a/applications/stream-applications-build/stream-applications-descriptor/pom.xml
+++ b/applications/stream-applications-build/stream-applications-descriptor/pom.xml
@@ -106,7 +106,7 @@
        pom.properties['http-request-processor-docker.tag']=
                "${http-request-processor.version}".contains('SNAPSHOT') ? 'latest' : "${http-request-processor.version}"
        pom.properties['script-processor-docker.tag']=
-                "${scrirpt-processor.version}".contains('SNAPSHOT') ? 'latest' : "${script-processor.version}"
+                "${script-processor.version}".contains('SNAPSHOT') ? 'latest' : "${script-processor.version}"
        pom.properties['splitter-processor-docker.tag']=
                "${splitter-processor.version}".contains('SNAPSHOT') ? 'latest' : "${splitter-processor.version}"
        pom.properties['transform-processor-docker.tag']=
--- a/functions/function/filter-function/README.adoc
+++ b/functions/function/filter-function/README.adoc
@@ -0,0 +1,27 @@
+# Filter Function
+
+This module provides a filter function that can be reused and composed in other applications.
+
+## Beans for injection
+
+You can import the `FilterFunctionConfiguration` in a Spring Boot application and then inject the following bean.
+
+`filterFunction`
+
+You can use `filterFunction` as a qualifier when injecting.
+
+Once injected, you can use the `apply` method of the `Function` to invoke it and get the result.
+
+## Configuration Options
+
+The filter function makes uses of link:../spel-function/README.adoc[SpEL function].
+
+For more information on the various options available, please see link:../spel-function/src/main/java/org/springframework/cloud/fn/spel/SpelFunctionProperties.java[SpelFunctionProperties.java]
+
+## Tests
+
+See this link:src/test/java/org/springframework/cloud/fn/filter/FilterFunctionApplicationTests.java[test suite] for examples of how this function is used.
+
+## Other usage
+
+See this link:../../../applications/processor/filter-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
--- a/functions/function/header-enricher-function/README.adoc
+++ b/functions/function/header-enricher-function/README.adoc
@@ -0,0 +1,25 @@
+# Header Enricher Function
+
+This module provides a header enricher function that can be reused and composed in other applications.
+
+## Beans for injection
+
+You can import the `HeaderEnricherFunctionConfiguration` in a Spring Boot application and then inject the following bean.
+
+`headerEnricherFunction`
+
+You can use `headerEnricherFunction` as a qualifier when injecting.
+
+Once injected, you can use the `apply` method of the `Function` to invoke it and get the result.
+
+## Configuration Options
+
+For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/header/enricher/HeaderEnricherFunctionProperties.java[HeaderEnricherFunctionProperties.java]
+
+## Tests
+
+See this link:src/test/java/org/springframework/cloud/fn/header/enricher/HeaderEnricherFunctionApplicationTests.java[test suite] for examples of how this function is used.
+
+## Other usage
+
+See this link:../../../applications/processor/header-enricher-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
--- a/functions/function/spel-function/README.adoc
+++ b/functions/function/spel-function/README.adoc
@@ -0,0 +1,28 @@
+# SpEL Function
+
+This module provides a SpEL function that can be reused and composed in other applications.
+The function can be used to apply SpEL transformations on data based on a SpEL expression.
+
+## Beans for injection
+
+You can import the `SpelFunctionConfiguration` in a Spring Boot application and then inject the following bean.
+
+`spelFunction`
+
+You can use `spelFunction` as a qualifier when injecting.
+
+Once injected, you can use the `apply` method of the `Function` to invoke it and get the result.
+
+## Configuration Options
+
+All configuration properties are prefixed with `spel`.
+
+For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/spel/SpelFunctionProperties.java[SpelFunctionProperties.java]
+
+## Tests
+
+See this link:src/test/java/org/springframework/cloud/fn/spel/SpelFunctionApplicationTests.java[test suite] for examples of how this function is used.
+
+## Other usage
+
+See this link:../../../applications/processor/transform-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream transformer application.
--- a/functions/function/splitter-function/README.adoc
+++ b/functions/function/splitter-function/README.adoc
@@ -0,0 +1,25 @@
+# Splitter Function
+
+This module provides a header enricher function that can be reused and composed in other applications.
+
+## Beans for injection
+
+You can import the `SpliiterFunctionConfiguration` in a Spring Boot application and then inject the following bean.
+
+`splitterFunction`
+
+You can use `splitterFunction` as a qualifier when injecting.
+
+Once injected, you can use the `apply` method of the `Function` to invoke it and get the result.
+
+## Configuration Options
+
+For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/splitter/SplitterFunctionProperties.java[SplitterFunctionProperties.java]
+
+## Tests
+
+See this link:src/test/java/org/springframework/cloud/fn/splitter/SplitterFunctionApplicationTests.java[test suite] for examples of how this function is used.
+
+## Other usage
+
+See this link:../../../applications/processor/splitter-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.