From da04bb3050a33d72a3cc6a2c1d89dc704f13854f Mon Sep 17 00:00:00 2001 From: Soby Chacko Date: Thu, 4 Jun 2020 15:55:14 -0400 Subject: [PATCH] README changes. Properties cleanup. --- function/filter-function/README.adoc | 27 ++++++++++++++++++ function/header-enricher-function/README.adoc | 25 +++++++++++++++++ function/spel-function/README.adoc | 28 +++++++++++++++++++ function/splitter-function/README.adoc | 25 +++++++++++++++++ 4 files changed, 105 insertions(+) create mode 100644 function/filter-function/README.adoc create mode 100644 function/header-enricher-function/README.adoc create mode 100644 function/spel-function/README.adoc create mode 100644 function/splitter-function/README.adoc diff --git a/function/filter-function/README.adoc b/function/filter-function/README.adoc new file mode 100644 index 00000000..dc4e88f2 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/function/header-enricher-function/README.adoc b/function/header-enricher-function/README.adoc new file mode 100644 index 00000000..29f4ff6d --- /dev/null +++ b/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. \ No newline at end of file diff --git a/function/spel-function/README.adoc b/function/spel-function/README.adoc new file mode 100644 index 00000000..0545d1d5 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/function/splitter-function/README.adoc b/function/splitter-function/README.adoc new file mode 100644 index 00000000..7c28989d --- /dev/null +++ b/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. \ No newline at end of file