You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by dj...@apache.org on 2020/03/13 01:14:21 UTC
[camel] 13/18: move languages and properties-component to
components: fix xrefs: user-manual
This is an automated email from the ASF dual-hosted git repository.
djencks pushed a commit to branch issue-14698-rearrange-adocs
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 31dc7ba214a19c49ee2f2fc8104d77f159527798
Author: David Jencks <dj...@apache.org>
AuthorDate: Thu Mar 12 18:08:08 2020 -0700
move languages and properties-component to components: fix xrefs: user-manual
---
docs/user-manual/modules/ROOT/nav.adoc | 9 +-
.../modules/ROOT/pages/backlog-tracer.adoc | 4 +-
.../modules/ROOT/pages/bam-example.adoc | 2 +-
.../modules/ROOT/pages/bean-binding.adoc | 10 +-
.../modules/ROOT/pages/bean-integration.adoc | 2 +-
.../modules/ROOT/pages/content-enricher.adoc | 16 +-
.../modules/ROOT/pages/dynamic-router.adoc | 199 -----
.../modules/ROOT/pages/exception-clause.adoc | 2 +-
.../user-manual/modules/ROOT/pages/expression.adoc | 26 +-
...how-does-camel-look-up-beans-and-endpoints.adoc | 4 +-
docs/user-manual/modules/ROOT/pages/index.adoc | 30 +-
docs/user-manual/modules/ROOT/pages/intercept.adoc | 2 +-
docs/user-manual/modules/ROOT/pages/languages.adoc | 30 +-
.../ROOT/pages/parameter-binding-annotations.adoc | 22 +-
docs/user-manual/modules/ROOT/pages/predicate.adoc | 36 +-
.../modules/ROOT/pages/properties-component.adoc | 842 ---------------------
docs/user-manual/modules/ROOT/pages/rest-dsl.adoc | 2 +-
.../modules/ROOT/pages/spring-remoting.adoc | 10 +-
.../ROOT/pages/using-propertyplaceholder.adoc | 12 +-
19 files changed, 106 insertions(+), 1154 deletions(-)
diff --git a/docs/user-manual/modules/ROOT/nav.adoc b/docs/user-manual/modules/ROOT/nav.adoc
index 799b06c..328b6b8 100644
--- a/docs/user-manual/modules/ROOT/nav.adoc
+++ b/docs/user-manual/modules/ROOT/nav.adoc
@@ -51,14 +51,7 @@
** xref:java-dsl.adoc[Java DSL]
** xref:spring.adoc[Spring support]
* xref:using-osgi-blueprint-with-camel.adoc[Using OSGi blueprint with Camel]
-* Supported expression languages
- ** xref:languages:constant-language.adoc[Constant Language]
- ** xref:languages:exchangeProperty-language.adoc[ExchangeProperty Language]
- ** xref:languages:file-language.adoc[File Language]
- ** xref:languages:header-language.adoc[Header Language]
- ** xref:languages:ref-language.adoc[Ref Language]
- ** xref:languages:simple-language.adoc[Simple Language]
- ** xref:languages:tokenize-language.adoc[Tokenize Language]
+* Supported expression languages -- see Components documentation
* xref:enterprise-integration-patterns.adoc[Enterprise Integration Patterns]
** xref:eips:aggregate-eip.adoc[Aggregate EIP]
** xref:eips:batch-config-eip.adoc[Batch-config EIP]
diff --git a/docs/user-manual/modules/ROOT/pages/backlog-tracer.adoc b/docs/user-manual/modules/ROOT/pages/backlog-tracer.adoc
index 5ce541e..feab678 100644
--- a/docs/user-manual/modules/ROOT/pages/backlog-tracer.adoc
+++ b/docs/user-manual/modules/ROOT/pages/backlog-tracer.adoc
@@ -56,9 +56,9 @@ do "to*" to match any to. Or use "route-foo*" to match any foo routes.
|traceFilter |`null` |Allow to configure a filter as a xref:predicate.adoc[Predicate] using
any of the Camel xref:languages.adoc[languages]. But default the
-xref:languages:simple-language.adoc[Simple] language is used. For example to filter on
+xref:components:languages:simple-language.adoc[Simple] language is used. For example to filter on
messages with a given header, use `${header.foo} != null`. To use
-xref:components::groovy-language.adoc[Groovy] then prefix the value with "groovy:". And
+xref:components:languages:groovy-language.adoc[Groovy] then prefix the value with "groovy:". And
similar for the other languages.
|removeOnDump |`true` |Whether to remove the traced messages that was returned when invoking
diff --git a/docs/user-manual/modules/ROOT/pages/bam-example.adoc b/docs/user-manual/modules/ROOT/pages/bam-example.adoc
index cbfee93..3389beb 100644
--- a/docs/user-manual/modules/ROOT/pages/bam-example.adoc
+++ b/docs/user-manual/modules/ROOT/pages/bam-example.adoc
@@ -76,7 +76,7 @@ the Camel Components
correlate together the purchase order and invoice messages which can be
any Expression via any of the
Languages Supported. In this case we are
-using xref:components::xpath-language.adoc[XPath].
+using xref:components:languages:xpath-language.adoc[XPath].
Then the final line of code defines the temporal rules to use; namely
that it is considered to be an error if an invoice is not received
diff --git a/docs/user-manual/modules/ROOT/pages/bean-binding.adoc b/docs/user-manual/modules/ROOT/pages/bean-binding.adoc
index 0932932..3db103f 100644
--- a/docs/user-manual/modules/ROOT/pages/bean-binding.adoc
+++ b/docs/user-manual/modules/ROOT/pages/bean-binding.adoc
@@ -231,9 +231,9 @@ the method option
* The value is a numeric value such as `123` or `7`
* The value is a String enclosed with either single or double quotes
* The value is null which denotes a `null` value
-* It can be evaluated using the xref:languages:simple-language.adoc[Simple] language, which
+* It can be evaluated using the xref:components:languages:simple-language.adoc[Simple] language, which
means you can use, e.g., body, header.foo and other
-xref:languages:simple-language.adoc[Simple] tokens. Notice the tokens must be enclosed with
+xref:components:languages:simple-language.adoc[Simple] tokens. Notice the tokens must be enclosed with
$\{ }.
Any other value is consider to be a type declaration instead - see the
@@ -276,7 +276,7 @@ body as shown:
.bean(OrderService.class, "doSomething(${body}, true)")
----
-The syntax of the parameters is using the xref:languages:simple-language.adoc[Simple]
+The syntax of the parameters is using the xref:components:languages:simple-language.adoc[Simple]
expression language so we have to use $\{ } placeholders in the body to
refer to the message body.
@@ -312,7 +312,7 @@ first has the content 'World' (without quotes), and the 2nd has the
value of 5.
Camel will automatically convert these values to the parameters' types.
-Having the power of the xref:languages:simple-language.adoc[Simple] language allows us to
+Having the power of the xref:components:languages:simple-language.adoc[Simple] language allows us to
bind to message headers and other values such as:
[source,syntaxhighlighter-pre]
@@ -320,7 +320,7 @@ bind to message headers and other values such as:
.bean(OrderService.class, "doSomething(${body}, ${header.high})")
----
-You can also use the OGNL support of the xref:languages:simple-language.adoc[Simple]
+You can also use the OGNL support of the xref:components:languages:simple-language.adoc[Simple]
expression language. Now suppose the message body is an object which has
a method named `asXml`. To invoke the `asXml` method we can do as
follows:
diff --git a/docs/user-manual/modules/ROOT/pages/bean-integration.adoc b/docs/user-manual/modules/ROOT/pages/bean-integration.adoc
index f85fd17..5762c07 100644
--- a/docs/user-manual/modules/ROOT/pages/bean-integration.adoc
+++ b/docs/user-manual/modules/ROOT/pages/bean-integration.adoc
@@ -32,7 +32,7 @@ See more details at:
* xref:pojo-consuming.adoc[POJO Consuming] to consume and possibly route messages from Camel
* xref:pojo-producing.adoc[POJO Producing] to make it easy to produce camel messages from your POJOs
-* `@DynamicRouter` Annotation for creating a xref:dynamic-router.adoc[Dynamic Router] from a POJO method
+* `@DynamicRouter` Annotation for creating a xref:eips:dynamic-router.adoc[Dynamic Router] from a POJO method
* `@RecipientList` Annotation for creating a xref:eips:recipientList-eip.adoc[Recipient List] from a POJO method
* `@RoutingSlip` Annotation for creating a xref:eips:routingSlip-eip.adoc[Routing Slip] for a POJO method
* xref:bean-injection.adoc[Bean Injection] to inject Camel related resources into your POJOs
diff --git a/docs/user-manual/modules/ROOT/pages/content-enricher.adoc b/docs/user-manual/modules/ROOT/pages/content-enricher.adoc
index 77fd4d8..05a936c 100644
--- a/docs/user-manual/modules/ROOT/pages/content-enricher.adoc
+++ b/docs/user-manual/modules/ROOT/pages/content-enricher.adoc
@@ -135,8 +135,8 @@ confluenceTableSmall
|`uri` | |The endpoint uri for the external service to enrich from. You
must use either `uri` or `ref`. *Important:* From Camel 2.16 onwards,
this option is removed, and you use an xref:expression.adoc[Expression]
-to configure the uri, such as xref:languages:simple-language.adoc[Simple] or
-xref:languages:constant-language.adoc[Constant] or any other dynamic language that can
+to configure the uri, such as xref:components:languages:simple-language.adoc[Simple] or
+xref:components:languages:constant-language.adoc[Constant] or any other dynamic language that can
compute the uri dynamically using values from the current
xref:exchange.adoc[Exchange].
@@ -144,13 +144,13 @@ xref:exchange.adoc[Exchange].
from. You must use either `uri` or `ref`. **Important:** From Camel
2.16 onwards, this option is removed, and you use an
xref:expression.adoc[Expression] to configure the uri, such as
-xref:languages:simple-language.adoc[Simple] or xref:languages:constant-language.adoc[Constant] or any other
+xref:components:languages:simple-language.adoc[Simple] or xref:components:languages:constant-language.adoc[Constant] or any other
dynamic language that can compute the uri dynamically using values from
the current xref:exchange.adoc[Exchange].
|expression | |*Camel 2.16:* Mandatory.
The xref:expression.adoc[Expression] to configure the uri, such as
-xref:languages:simple-language.adoc[Simple] or xref:languages:constant-language.adoc[Constant] or any other
+xref:components:languages:simple-language.adoc[Simple] or xref:components:languages:constant-language.adoc[Constant] or any other
dynamic language that can compute the uri dynamically using values from
the current xref:exchange.adoc[Exchange].
@@ -348,8 +348,8 @@ polling
|`uri` | |The endpoint uri for the external service to enrich from. You
must use either `uri` or `ref`. **Important:** From Camel 2.16 onwards,
this option is removed, and you use an xref:expression.adoc[Expression]
-to configure the uri, such as xref:languages:simple-language.adoc[Simple] or
-xref:languages:constant-language.adoc[Constant] or any other dynamic language that can
+to configure the uri, such as xref:components:languages:simple-language.adoc[Simple] or
+xref:components:languages:constant-language.adoc[Constant] or any other dynamic language that can
compute the uri dynamically using values from the current
xref:exchange.adoc[Exchange].
@@ -357,13 +357,13 @@ compute the uri dynamically using values from the current
from. You must use either `uri` or `ref`. **Important:** From Camel 2.16
onwards, this option is removed, and you use an
xref:expression.adoc[Expression] to configure the uri, such as
-xref:languages:simple-language.adoc[Simple] or xref:languages:constant-language.adoc[Constant] or any other
+xref:components:languages:simple-language.adoc[Simple] or xref:components:languages:constant-language.adoc[Constant] or any other
dynamic language that can compute the uri dynamically using values from
the current xref:exchange.adoc[Exchange].
|`expression` | |**Camel 2.16:** Mandatory.
The xref:expression.adoc[Expression] to configure the uri, such as
-xref:languages:simple-language.adoc[Simple] or xref:languages:constant-language.adoc[Constant] or any other
+xref:components:languages:simple-language.adoc[Simple] or xref:components:languages:constant-language.adoc[Constant] or any other
dynamic language that can compute the uri dynamically using values from
the current xref:exchange.adoc[Exchange].
diff --git a/docs/user-manual/modules/ROOT/pages/dynamic-router.adoc b/docs/user-manual/modules/ROOT/pages/dynamic-router.adoc
deleted file mode 100644
index 12aa022..0000000
--- a/docs/user-manual/modules/ROOT/pages/dynamic-router.adoc
+++ /dev/null
@@ -1,199 +0,0 @@
-[[DynamicRouter-DynamicRouter]]
-= Dynamic Router
-:page-source: core/camel-core-engine/src/main/docs/eips/dynamic-router.adoc
-
-The
-http://www.enterpriseintegrationpatterns.com/DynamicRouter.html[Dynamic
-Router] from the EIP patterns
-allows you to route messages while avoiding the dependency of the router
-on all possible destinations while maintaining its efficiency.
-
-image::eip/DynamicRouter.gif[image]
-
-The `dynamicRouter` in the DSL is similar to
-a dynamic Routing Slip which evaluates the slip
-_on-the-fly_.
-
-WARNING: *Beware*
-You must ensure the expression used for the `dynamicRouter` such as a
-bean, will return `null` to indicate the end. Otherwise the
-`dynamicRouter` will keep repeating endlessly.
-
-[[DynamicRouter-DynamicRouterinCamel2.5onwards]]
-== Dynamic Router in Camel 2.5 onwards
-
-The Dynamic Router will set a
-property (Exchange.SLIP_ENDPOINT) on the Exchange
-which contains the current endpoint as it advanced though the slip. This
-allows you to know how far we have processed in the slip. (It's a slip
-because the Dynamic Router implementation is
-based on top of Routing Slip).
-
-TIP: See the `cacheSize` option for more details on _how much cache_ to use depending on how many or few unique endpoints are used.
-
-== Options
-
-// eip options: START
-The Dynamic Router EIP supports 3 options which are listed below:
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *uriDelimiter* | Sets the uri delimiter to use | , | String
-| *ignoreInvalidEndpoints* | Ignore the invalidate endpoint exception when try to create a producer with that endpoint | false | Boolean
-| *cacheSize* | Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producers when using this routing slip, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn of caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and [...]
-|===
-// eip options: END
-
-[[DynamicRouter-JavaDSL]]
-== Java DSL
-
-In Java DSL you can use the `dynamicRouter` as shown below:
-
-[source,java]
-----
-from("direct:start")
- // use a bean as the dynamic router
- .dynamicRouter(method(DynamicRouterTest.class, "slip"));
-----
-
-Which will leverage a xref:components::bean-component.adoc[Bean] to compute the slip
-_on-the-fly_, which could be implemented as follows:
-
-[source,java]
-----
-/**
- * Use this method to compute dynamic where we should route next.
- *
- * @param body the message body
- * @return endpoints to go, or <tt>null</tt> to indicate the end
- */
-public String slip(String body) {
- bodies.add(body);
- invoked++;
-
- if (invoked == 1) {
- return "mock:a";
- } else if (invoked == 2) {
- return "mock:b,mock:c";
- } else if (invoked == 3) {
- return "direct:foo";
- } else if (invoked == 4) {
- return "mock:result";
- }
-
- // no more so return null
- return null;
-}
-----
-
-Mind that this example is only for show and tell. The current
-implementation is not thread safe. You would have to store the state on
-the Exchange, to ensure thread safety, as shown
-below:
-
-[source,java]
-----
-/**
- * Use this method to compute dynamic where we should route next.
- *
- * @param body the message body
- * @param properties the exchange properties where we can store state between invocations
- * @return endpoints to go, or <tt>null</tt> to indicate the end
- */
-public String slip(String body, @Properties Map<String, Object> properties) {
- bodies.add(body);
-
- // get the state from the exchange properties and keep track how many times
- // we have been invoked
- int invoked = 0;
- Object current = properties.get("invoked");
- if (current != null) {
- invoked = Integer.valueOf(current.toString());
- }
- invoked++;
- // and store the state back on the properties
- properties.put("invoked", invoked);
-
- if (invoked == 1) {
- return "mock:a";
- } else if (invoked == 2) {
- return "mock:b,mock:c";
- } else if (invoked == 3) {
- return "direct:foo";
- } else if (invoked == 4) {
- return "mock:result";
- }
-
- // no more so return null
- return null;
-}
-----
-
-You could also store state as message headers, but they are not
-guaranteed to be preserved during routing, where as properties on the
-Exchange are. Although there was a bug in the method
-call expression, see the warning below.
-
-[[DynamicRouter-SpringXML]]
-== Spring XML
-
-The same example in Spring XML would be:
-
-[source,xml]
-----
-<bean id="mySlip" class="org.apache.camel.processor.DynamicRouterTest"/>
-
-<camelContext xmlns="http://camel.apache.org/schema/spring">
- <route>
- <from uri="direct:start"/>
- <dynamicRouter>
- <!-- use a method call on a bean as dynamic router -->
- <method ref="mySlip" method="slip"/>
- </dynamicRouter>
- </route>
-
- <route>
- <from uri="direct:foo"/>
- <transform><constant>Bye World</constant></transform>
- </route>
-
-</camelContext>
-----
-
-[[DynamicRouter-DynamicRouterannotation]]
-== @DynamicRouter annotation
-
-You can also use the `@DynamicRouter` annotation. The `route` method would
-then be invoked repeatedly as the message is processed dynamically. The
-idea is to return the next endpoint uri where to go. Return `null` to
-indicate the end. You can return multiple endpoints if you like, just as
-the Routing Slip, where each endpoint is
-separated by a delimiter.
-
-[source,java]
-----
-public class MyDynamicRouter {
-
- @Consume(uri = "activemq:foo")
- @DynamicRouter
- public String route(@XPath("/customer/id") String customerId, @Header("Location") String location, Document body) {
- // query a database to find the best match of the endpoint based on the input parameteres
- // return the next endpoint uri, where to go. Return null to indicate the end.
- }
-}
-----
-
-In the above we can use the
-Parameter Binding Annotations
-to bind different parts of the Message to method
-parameters or use an Expression such as using
-xref:components::xpath-language.adoc[XPath] or xref:components::xpath-language.adoc[XQuery].
-
-The method can be invoked in a number of ways as described in the
-Bean Integration such as
-
-* POJO Producing
-* Spring Remoting
-* xref:components::bean-component.adoc[Bean] component
-
diff --git a/docs/user-manual/modules/ROOT/pages/exception-clause.adoc b/docs/user-manual/modules/ROOT/pages/exception-clause.adoc
index 3526fed..c580245 100644
--- a/docs/user-manual/modules/ROOT/pages/exception-clause.adoc
+++ b/docs/user-manual/modules/ROOT/pages/exception-clause.adoc
@@ -417,7 +417,7 @@ message instead of the fixed text `Sorry`:
/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionHandleAndTransformTest.java
-And we can use the xref:languages:simple-language.adoc[Simple] language to set a readable error
+And we can use the xref:components:languages:simple-language.adoc[Simple] language to set a readable error
message with the caused exception message:
/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionHandleAndTransformTest.java
diff --git a/docs/user-manual/modules/ROOT/pages/expression.adoc b/docs/user-manual/modules/ROOT/pages/expression.adoc
index b0bfc3f..e0b5bc3 100644
--- a/docs/user-manual/modules/ROOT/pages/expression.adoc
+++ b/docs/user-manual/modules/ROOT/pages/expression.adoc
@@ -68,24 +68,24 @@ public interface Predicate {
The following languages are supported out of the box
-* xref:components::bean-language.adoc[Bean Language] for using Java for expressions
-* xref:languages:constant-language.adoc[Constant]
-* xref:languages:header-language.adoc[Header]
-* xref:components::jsonpath-language.adoc[JSonPath]
+* xref:components:languages:bean-language.adoc[Bean Language] for using Java for expressions
+* xref:components:languages:constant-language.adoc[Constant]
+* xref:components:languages:header-language.adoc[Header]
+* xref:components:languages:jsonpath-language.adoc[JSonPath]
* xref:components::mvel-component.adoc[Mvel]
-* xref:components::ognl-language.adoc[OGNL]
-* xref:languages:ref-language.adoc[Ref Language]
+* xref:components:languages:ognl-language.adoc[OGNL]
+* xref:components:languages:ref-language.adoc[Ref Language]
* ExchangeProperty / Property
* Scripting Languages such as
** BeanShell
** JavaScript
-** xref:components::groovy-language.adoc[Groovy]
-* xref:languages:simple-language.adoc[Simple]
-** xref:languages:file-language.adoc[File Language]
-* xref:components::spel-language.adoc[Spring Expression Language]
+** xref:components:languages:groovy-language.adoc[Groovy]
+* xref:components:languages:simple-language.adoc[Simple]
+** xref:components:languages:file-language.adoc[File Language]
+* xref:components:languages:spel-language.adoc[Spring Expression Language]
* xref:components::sql-component.adoc[SQL]
* Tokenizer
-* xref:components::xpath-language.adoc[XPath]
+* xref:components:languages:xpath-language.adoc[XPath]
* xref:components::xquery-component.adoc[XQuery]
* https://github.com/camel-extra/camel-extra/blob/master/components/camel-vtdxml/src/main/docs/vtdxml-component.adoc[VTD-XML]
@@ -106,11 +106,11 @@ wish to use.
|Scripting Languages such as
BeanShell, JavaScript,
-xref:components::groovy-language.adoc[Groovy] |
+xref:components:languages:groovy-language.adoc[Groovy] |
|xref:components::sql-component.adoc[SQL] |
-|xref:components::xpath-language.adoc[XPath] |https://github.com/apache/camel/blob/master/components/camel-xpath/src/main/java/org/apache/camel/language/xpath/XPathBuilder.java[org.apache.camel.builder.xml.XPathBuilder]
+|xref:components:languages:xpath-language.adoc[XPath] |https://github.com/apache/camel/blob/master/components/camel-xpath/src/main/java/org/apache/camel/language/xpath/XPathBuilder.java[org.apache.camel.builder.xml.XPathBuilder]
|xref:components::xquery-component.adoc[XQuery] |https://github.com/apache/camel/blob/master/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryBuilder.java[org.apache.camel.builder.saxon.XQueryBuilder]
|=======================================================================
diff --git a/docs/user-manual/modules/ROOT/pages/faq/how-does-camel-look-up-beans-and-endpoints.adoc b/docs/user-manual/modules/ROOT/pages/faq/how-does-camel-look-up-beans-and-endpoints.adoc
index 6f40469..aaceedb 100644
--- a/docs/user-manual/modules/ROOT/pages/faq/how-does-camel-look-up-beans-and-endpoints.adoc
+++ b/docs/user-manual/modules/ROOT/pages/faq/how-does-camel-look-up-beans-and-endpoints.adoc
@@ -3,7 +3,7 @@
There are many times using Camel that a name is used for a bean such as
using the xref:components::bean-component.adoc[Bean] endpoint or using the
-xref:components::bean-language.adoc[Bean Language] to create a
+xref:components:languages:bean-language.adoc[Bean Language] to create a
xref:expression.adoc[Expression] or xref:predicate.adoc[Predicate] or
referring to any xref:component.adoc[Component] or
xref:endpoint.adoc[Endpoint].
@@ -20,4 +20,4 @@ camel-spring do.
So you can just define beans, components or endpoints in your
xref:registry.adoc[Registry] implementation then you can refer to them
by name in the xref:endpoint.adoc[Endpoint] URIs or xref:components::bean-component.adoc[Bean]
-endpoints or xref:components::bean-language.adoc[Bean Language] expressions.
+endpoints or xref:components:languages:bean-language.adoc[Bean Language] expressions.
diff --git a/docs/user-manual/modules/ROOT/pages/index.adoc b/docs/user-manual/modules/ROOT/pages/index.adoc
index 0859151..3eefe8b 100644
--- a/docs/user-manual/modules/ROOT/pages/index.adoc
+++ b/docs/user-manual/modules/ROOT/pages/index.adoc
@@ -505,21 +505,21 @@ camel routes without them knowing
// <!-- languages: START -->
* Expression Languages
-** xref:components::bean-language.adoc[Bean method]
-** xref:languages:constant-language.adoc[Constant]
-** xref:languages:exchangeProperty-language.adoc[ExchangeProperty]
-** xref:languages:file-language.adoc[File]
-** xref:components::groovy-language.adoc[Groovy]
-** xref:languages:header-language.adoc[Header]
-** xref:components::hl7terser-language.adoc[HL7 Terser]
-** xref:components::mvel-language.adoc[MVEL]
-** xref:components::ognl-language.adoc[OGNL]
-** xref:languages:ref-language.adoc[Ref]
-** xref:languages:simple-language.adoc[Simple]
-** xref:components::spel-language.adoc[SpEL]
-** xref:languages:tokenize-language.adoc[Tokenize]
-** xref:components::xpath-language.adoc[XPath]
-** xref:components::xquery-language.adoc[XQuery]
+** xref:components:languages:bean-language.adoc[Bean method]
+** xref:components:languages:constant-language.adoc[Constant]
+** xref:components:languages:exchangeProperty-language.adoc[ExchangeProperty]
+** xref:components:languages:file-language.adoc[File]
+** xref:components:languages:groovy-language.adoc[Groovy]
+** xref:components:languages:header-language.adoc[Header]
+** xref:components:languages:hl7terser-language.adoc[HL7 Terser]
+** xref:components:languages:mvel-language.adoc[MVEL]
+** xref:components:languages:ognl-language.adoc[OGNL]
+** xref:components:languages:ref-language.adoc[Ref]
+** xref:components:languages:simple-language.adoc[Simple]
+** xref:components:languages:spel-language.adoc[SpEL]
+** xref:components:languages:tokenize-language.adoc[Tokenize]
+** xref:components:languages:xpath-language.adoc[XPath]
+** xref:components:languages:xquery-language.adoc[XQuery]
// <!-- languages: END -->
diff --git a/docs/user-manual/modules/ROOT/pages/intercept.adoc b/docs/user-manual/modules/ROOT/pages/intercept.adoc
index af1926e..aa805f4 100644
--- a/docs/user-manual/modules/ROOT/pages/intercept.adoc
+++ b/docs/user-manual/modules/ROOT/pages/intercept.adoc
@@ -184,7 +184,7 @@ Intercept endpoint is of course also available using Spring DSL.
We start with the first example from above in Spring DSL:
-And the 2nd. Notice how we can leverage the xref:languages:simple-language.adoc[Simple]
+And the 2nd. Notice how we can leverage the xref:components:languages:simple-language.adoc[Simple]
language for the Predicate:
And the 3rd with the `skip`, notice skip is set with the
diff --git a/docs/user-manual/modules/ROOT/pages/languages.adoc b/docs/user-manual/modules/ROOT/pages/languages.adoc
index fe0466a..e1cfcfe 100644
--- a/docs/user-manual/modules/ROOT/pages/languages.adoc
+++ b/docs/user-manual/modules/ROOT/pages/languages.adoc
@@ -19,22 +19,22 @@ For more information, see xref:predicate.adoc[Compound Predicates].
== The following is the list of currently supported languages:
-* xref:components::bean-language.adoc[Bean Language] for using Java for expressions
-* xref:languages:constant-language.adoc[Constant]
-* xref:languages:header-language.adoc[Header]
-* xref:components::jsonpath-language.adoc[JSonPath]
-* xref:components::mvel-language.adoc[Mvel]
-* xref:components::ognl-language.adoc[OGNL]
-* xref:languages:ref-language.adoc[Ref Language]
-* xref:languages:exchangeProperty-language.adoc[ExchangeProperty]
+* xref:components:languages:bean-language.adoc[Bean Language] for using Java for expressions
+* xref:components:languages:constant-language.adoc[Constant]
+* xref:components:languages:header-language.adoc[Header]
+* xref:components:languages:jsonpath-language.adoc[JSonPath]
+* xref:components:languages:mvel-language.adoc[Mvel]
+* xref:components:languages:ognl-language.adoc[OGNL]
+* xref:components:languages:ref-language.adoc[Ref Language]
+* xref:components:languages:exchangeProperty-language.adoc[ExchangeProperty]
* xref:scripting-languages.adoc[Scripting Languages] such as:
-** xref:components::groovy-language.adoc[Groovy]
-* xref:languages:simple-language.adoc[Simple]
-** xref:languages:file-language.adoc[File Language]
-* xref:components::spel-language.adoc[Spring Expression Language]
-* xref:languages:tokenize-language.adoc[Tokenizer]
-* xref:components::xpath-language.adoc[XPath]
-* xref:components::xquery-language.adoc[XQuery]
+** xref:components:languages:groovy-language.adoc[Groovy]
+* xref:components:languages:simple-language.adoc[Simple]
+** xref:components:languages:file-language.adoc[File Language]
+* xref:components:languages:spel-language.adoc[Spring Expression Language]
+* xref:components:languages:tokenize-language.adoc[Tokenizer]
+* xref:components:languages:xpath-language.adoc[XPath]
+* xref:components:languages:xquery-language.adoc[XQuery]
* https://github.com/camel-extra/camel-extra/blob/master/components/camel-vtdxml/src/main/docs/vtdxml-component.adoc[VTD-XML]
Most of these languages are also supported used as
diff --git a/docs/user-manual/modules/ROOT/pages/parameter-binding-annotations.adoc b/docs/user-manual/modules/ROOT/pages/parameter-binding-annotations.adoc
index c1f9fd0..793412d 100644
--- a/docs/user-manual/modules/ROOT/pages/parameter-binding-annotations.adoc
+++ b/docs/user-manual/modules/ROOT/pages/parameter-binding-annotations.adoc
@@ -151,31 +151,31 @@ any of these annotations:
|=======================================================================
|Annotation |Description
|`org.apache.camel.language.Bean`
-|Inject a xref:components::bean-language.adoc[Bean] expression
+|Inject a xref:components:languages:bean-language.adoc[Bean] expression
|`org.apache.camel.language.Constant`
-|Inject a xref:languages:constant-language.adoc[Constant] expression
+|Inject a xref:components:languages:constant-language.adoc[Constant] expression
|`org.apache.camel.builder.script.Groovy`
-|Inject a xref:components::groovy-language.adoc[Groovy] expression
+|Inject a xref:components:languages:groovy-language.adoc[Groovy] expression
|`org.apache.camel.Header`
-|Inject a xref:languages:header-language.adoc[Header] expression
+|Inject a xref:components:languages:header-language.adoc[Header] expression
|`org.apache.camel.language.mvel.MVEL`
-|Inject a xref:components::mvel-language.adoc[MVEL] expression
+|Inject a xref:components:languages:mvel-language.adoc[MVEL] expression
|`org.apache.camel.language.ognl.OGNL`
-|Inject an xref:components::ognl-language.adoc[OGNL] expression
+|Inject an xref:components:languages:ognl-language.adoc[OGNL] expression
|`org.apache.camel.language.Simple`
-|Inject an xref:languages:simple-language.adoc[Simple] expression
+|Inject an xref:components:languages:simple-language.adoc[Simple] expression
|`org.apache.camel.language.XPath`
-|Inject an xref:components::xpath-language.adoc[XPath] expression
+|Inject an xref:components:languages:xpath-language.adoc[XPath] expression
|`org.apache.camel.component.xquery.XQuery`
-|Inject an xref:components::xquery-language.adoc[XQuery] expression
+|Inject an xref:components:languages:xquery-language.adoc[XQuery] expression
|=======================================================================
[[ParameterBindingAnnotations-Example:]]
@@ -258,11 +258,11 @@ Spring xref:registry.adoc[Registry]:
----
[[ParameterBindingAnnotations-Exampleusing]]
-==== Example using xref:components::groovy-language.adoc[Groovy]
+==== Example using xref:components:languages:groovy-language.adoc[Groovy]
In this example we have an Exchange that has a User object stored in the
in header. This User object has methods to get some user information. We
-want to use xref:components::groovy-language.adoc[Groovy] to inject an expression that
+want to use xref:components:languages:groovy-language.adoc[Groovy] to inject an expression that
extracts and concats the fullname of the user into the fullName
parameter.
diff --git a/docs/user-manual/modules/ROOT/pages/predicate.adoc b/docs/user-manual/modules/ROOT/pages/predicate.adoc
index 50dc481..d70cbf1 100644
--- a/docs/user-manual/modules/ROOT/pages/predicate.adoc
+++ b/docs/user-manual/modules/ROOT/pages/predicate.adoc
@@ -152,22 +152,22 @@ Camel supports extensible Predicates using multiple
xref:languages.adoc[Languages]; the following languages are supported
out of the box
-* xref:components::bean-language.adoc[Bean Language] for using Java for expressions
-* xref:languages:constant-language.adoc[Constant]
-* xref:languages:header-language.adoc[Header]
-* xref:components::jsonpath-language.adoc[JSonPath]
-* xref:components::mvel-language.adoc[Mvel]
-* xref:components::ognl-language.adoc[OGNL]
-* xref:languages:ref-language.adoc[Ref Language]
-* xref:languages:exchangeProperty-language.adoc[ExchangeProperty]
+* xref:components:languages:bean-language.adoc[Bean Language] for using Java for expressions
+* xref:components:languages:constant-language.adoc[Constant]
+* xref:components:languages:header-language.adoc[Header]
+* xref:components:languages:jsonpath-language.adoc[JSonPath]
+* xref:components:languages:mvel-language.adoc[Mvel]
+* xref:components:languages:ognl-language.adoc[OGNL]
+* xref:components:languages:ref-language.adoc[Ref Language]
+* xref:components:languages:exchangeProperty-language.adoc[ExchangeProperty]
* xref:scripting-languages.adoc[Scripting Languages] such as
-** xref:components::groovy-language.adoc[Groovy]
-* xref:languages:simple-language.adoc[Simple]
-** xref:languages:file-language.adoc[File Language]
-* xref:components::spel-language.adoc[Spring Expression Language]
-* xref:languages:tokenize-language.adoc[Tokenizer]
-* xref:components::xpath-language.adoc[XPath]
-* xref:components::xquery-language.adoc[XQuery]
+** xref:components:languages:groovy-language.adoc[Groovy]
+* xref:components:languages:simple-language.adoc[Simple]
+** xref:components:languages:file-language.adoc[File Language]
+* xref:components:languages:spel-language.adoc[Spring Expression Language]
+* xref:components:languages:tokenize-language.adoc[Tokenizer]
+* xref:components:languages:xpath-language.adoc[XPath]
+* xref:components:languages:xquery-language.adoc[XQuery]
* https://github.com/camel-extra/camel-extra/blob/master/components/camel-vtdxml/src/main/docs/vtdxml-component.adoc[VTD-XML]
Most of these languages is also supported used as
@@ -192,12 +192,12 @@ wish to use.
[width="100%",cols="50%,50%",options="header",]
|=======================================================================
|Language(s) |Builder class to import
-|xref:scripting-languages.adoc[Scripting Languages] such as xref:components::groovy-language.adoc[Groovy]
+|xref:scripting-languages.adoc[Scripting Languages] such as xref:components:languages:groovy-language.adoc[Groovy]
-|xref:components::xpath-language.adoc[XPath]
+|xref:components:languages:xpath-language.adoc[XPath]
|https://github.com/apache/camel/blob/master/components/camel-xpath/src/main/java/org/apache/camel/language/xpath/XPathBuilder.java[org.apache.camel.builder.xml.XPathBuilder]
-|xref:components::xquery-language.adoc[XQuery]
+|xref:components:languages:xquery-language.adoc[XQuery]
|https://github.com/apache/camel/blob/master/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryBuilder.java[org.apache.camel.builder.saxon.XQueryBuilder]
|=======================================================================
diff --git a/docs/user-manual/modules/ROOT/pages/properties-component.adoc b/docs/user-manual/modules/ROOT/pages/properties-component.adoc
deleted file mode 100644
index 9e1a50f..0000000
--- a/docs/user-manual/modules/ROOT/pages/properties-component.adoc
+++ /dev/null
@@ -1,842 +0,0 @@
-[[properties-component]]
-= Properties Component
-:page-source: core/camel-base/src/main/docs/properties-component.adoc
-
-*Since Camel 2.3*
-
-The properties component is used for property placeholders in your Camel application, such as endpoint URIs.
-It is *not* a regular Camel component with producer and consumer for routing messages. However for historical
-reasons it was named `PropertiesComponent` and this name is commonly known and therfore we keep using it.
-
-== Spring Boot Auto-Configuration
-
-The component supports 10 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *camel.component.properties.auto-discover-properties-sources* | Whether to automatically discovery instances of PropertiesSource from registry and service factory. | true | Boolean
-| *camel.component.properties.default-fallback-enabled* | If false, the component does not attempt to find a default for the key by looking after the colon separator. | true | Boolean
-| *camel.component.properties.encoding* | Encoding to use when loading properties file from the file system or classpath. If no encoding has been set, then the properties files is loaded using ISO-8859-1 encoding (latin-1) as documented by java.util.Properties#load(java.io.InputStream) | | String
-| *camel.component.properties.environment-variable-mode* | Sets the OS environment variables mode (0 = never, 1 = fallback, 2 = override). The default mode (override) is to use OS environment variables if present, and override any existing properties. OS environment variable mode is checked before JVM system property mode | 2 | Integer
-| *camel.component.properties.ignore-missing-location* | Whether to silently ignore if a location cannot be located, such as a properties file not found. | false | Boolean
-| *camel.component.properties.initial-properties* | Sets initial properties which will be used before any locations are resolved. The option is a java.util.Properties type. | | String
-| *camel.component.properties.location* | A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option. | | String
-| *camel.component.properties.override-properties* | Sets a special list of override properties that take precedence and will use first, if a property exist. The option is a java.util.Properties type. | | String
-| *camel.component.properties.properties-parser* | To use a custom PropertiesParser. The option is a org.apache.camel.component.properties.PropertiesParser type. | | String
-| *camel.component.properties.system-properties-mode* | Sets the JVM system property mode (0 = never, 1 = fallback, 2 = override). The default mode (override) is to use system properties if present, and override any existing properties. OS environment variable mode is checked before JVM system property mode | 2 | Integer
-|===
-
-[TIP]
-**Resolving property from Java code** +
-You can use the method `resolvePropertyPlaceholders` on the
-`CamelContext` to resolve a property from any Java code.
-
-== Using PropertyPlaceholder
-
-Camel now provides a new `PropertiesComponent` in *camel-core* which
-allows you to use property placeholders when defining Camel
-Endpoint URIs.
-
-This works much like you would do if using Spring's
-`<property-placeholder>` tag. However Spring have a limitation which
-prevents 3rd party frameworks to leverage Spring property placeholders
-to the fullest. See more at
-xref:manual::faq/how-do-i-use-spring-property-placeholder-with-camel-xml.adoc[How do
-I use Spring Property Placeholder with Camel XML].
-
-[TIP]
-**Bridging Spring and Camel property placeholders** +
-You can bridge the Spring property placeholder
-with Camel, see further below for more details.
-
-The property placeholder is generally in use when doing:
-
-* lookup or creating endpoints
-* lookup of beans in the Registry
-* additional supported in Spring XML (see below in examples)
-* using Blueprint PropertyPlaceholder with Camel
-xref:properties-component.adoc[Properties] component
-* using `@PropertyInject` to inject a property in a POJO
-* Using default value if a property does not exists
-* Include out of the box functions, to lookup property
-values from OS environment variables, JVM system properties, or the
-service idiom.
-* Using custom functions, which can be plugged into the
-property component.
-
-== Syntax
-
-The syntax to use Camel's property placeholder is to use `{\{key\}}` for
-example `{{file.uri}}` where `file.uri` is the property key.
-
-You can use property placeholders in parts of the endpoint URI's which
-for example you can use placeholders for parameters in the URIs.
-
-You can specify a default value to use if
-a property with the key does not exists, eg `file.url:/some/path` where
-the default value is the text after the colon (eg /some/path).
-
-[NOTE]
-====
-Do not use colon in the property key. The colon is used as a separator
-token when you are providing a default value.
-====
-
-== Defining location
-
-The properties component need to know a location(s) where to resolve the
-properties. You can define 1 to many locations. If you define the
-location in a single String property you can separate multiple locations
-with comma such as:
-
-[source,java]
-----
-pc.setLocation("com/mycompany/myprop.properties,com/mycompany/other.properties");
-----
-
-You can set which location can be discarded if missing by by setting the ``optional`` attribute, which is false by default, i.e:
-
-[source,java]
-----
-pc.setLocations(
- "com/mycompany/override.properties;optional=true"
- "com/mycompany/defaults.properties");
-----
-
-== Using system and environment variables in locations
-
-The location now supports using placeholders for JVM system properties
-and OS environments variables.
-
-For example:
-
-[source]
-----
-location=file:${karaf.home}/etc/foo.properties
-----
-
-In the location above we defined a location using the file scheme using
-the JVM system property with key `karaf.home`.
-
-To use an OS environment variable instead you would have to prefix with
-env:
-
-[source]
-----
-location=file:${env:APP_HOME}/etc/foo.properties
-----
-
-Where `APP_HOME` is an OS environment.
-
-[NOTE]
-====
-Some OS'es (such as Linux) do not support dashes in environment variable names,
-so here we are using `APP_HOME`. But if you specify `APP-HOME` then Camel 3 will automatic lookup
-the value as `APP_HOME` (with underscore) as fallback.
-====
-
-You can have multiple placeholders in the same location, such as:
-
-[source]
-----
-location=file:${env:APP_HOME}/etc/${prop.name}.properties
-----
-
-== Configuring in Java DSL
-
-You have to create and register the `PropertiesComponent` under the name
-`properties` such as:
-
-[source,java]
-----
-PropertiesComponent pc = camelContext.getPropertiesComponent();
-pc.setLocation("classpath:com/mycompany/myprop.properties");
-----
-
-== Configuring in Spring XML
-
-Spring XML offers two variations to configure. You can define a spring
-bean as a `PropertiesComponent` which resembles the way done in Java
-DSL. Or you can use the `<propertyPlaceholder>` tag.
-
-[source,xml]
-----
-<bean id="properties" class="org.apache.camel.component.properties.PropertiesComponent">
- <property name="location" value="classpath:com/mycompany/myprop.properties"/>
-</bean>
-----
-
-Using the `<propertyPlaceholder>` tag makes the configuration a bit more
-fresh such as:
-
-[source,xml]
-----
-<camelContext ...>
- <propertyPlaceholder id="properties" location="com/mycompany/myprop.properties"/>
-</camelContext>
-----
-
-Setting the properties location through the location tag works just fine but sometime you have a number of resources to take into account and starting from *Camel 2.19.0* you can set the properties location with a dedicated propertiesLocation:
-
-[source,xml]
-----
-<camelContext ...>
- <propertyPlaceholder id="myPropertyPlaceholder">
- <propertiesLocation
- resolver = "classpath"
- path = "com/my/company/something/my-properties-1.properties"
- optional = "false"/>
- <propertiesLocation
- resolver = "classpath"
- path = "com/my/company/something/my-properties-2.properties"
- optional = "false"/>
- <propertiesLocation
- resolver = "file"
- path = "${karaf.home}/etc/my-override.properties"
- optional = "true"/>
- </propertyPlaceholder>
-</camelContext>
-----
-
-[TIP]
-**Specifying the cache option inside XML** +
-Camel supports specifying a value for the cache option both
-inside the Spring as well as the Blueprint XML.
-
-== Using a Properties from the Registry
-
-For example in OSGi you may want to expose a service which returns the
-properties as a `java.util.Properties` object.
-
-Then you could setup the xref:properties-component.adoc[Properties] component as
-follows:
-
-[source,xml]
-----
- <propertyPlaceholder id="properties" location="ref:myProperties"/>
-----
-
-Where `myProperties` is the id to use for lookup in the OSGi registry.
-Notice we use the `ref:` prefix to tell Camel that it should lookup the
-properties for the Registry.
-
-== Examples using properties component
-
-When using property placeholders in the endpoint URIs you can either use
-the `properties:` component or define the placeholders directly in the
-URI. We will show example of both cases, starting with the former.
-
-[source,java]
-----
-// properties
-cool.end=mock:result
-
-// route
-from("direct:start").to("{{cool.end}}");
-----
-
-You can also use placeholders as a part of the endpoint uri:
-
-[source,java]
-----
-// properties
-cool.foo=result
-
-// route
-from("direct:start").to("mock:{{cool.foo}}");
-----
-
-In the example above the to endpoint will be resolved to `mock:result`.
-
-You can also have properties with refer to each other such as:
-
-[source,java]
-----
-// properties
-cool.foo=result
-cool.concat=mock:{{cool.foo}}
-
-// route
-from("direct:start").to("mock:{{cool.concat}}");
-----
-
-Notice how `cool.concat` refer to another property.
-
-And you can use placeholders several times:
-
-[source,java]
-----
-// properties
-cool.start=direct:start
-cool.showid=true
-cool.result=result
-
-// route
-from("{{cool.start}}")
- .to("log:{{cool.start}}?showBodyType=false&showExchangeId={{cool.showid}}")
- .to("mock:{{cool.result}}");
-----
-
-You can also your property placeholders when using
-ProducerTemplate for example:
-
-[source,java]
-----
-template.sendBody("{{cool.start}}", "Hello World");
-----
-
-== Example with xref:manual:languages:simple-language.adoc[Simple] language
-
-The xref:manual:languages:simple-language.adoc[Simple] language now also support using property
-placeholders, for example in the route below:
-
-[source,java]
-----
-// properties
-cheese.quote=Camel rocks
-
-// route
-from("direct:start")
- .transform().simple("Hi ${body} do you think ${properties:cheese.quote}?");
-----
-
-== Additional property placeholder supported in Spring XML
-
-The property placeholders is also supported in many of the Camel Spring
-XML tags such as
-`<package>, <packageScan>, <contextScan>, <jmxAgent>, <endpoint>, <routeBuilder>, <proxy>`
-and the others.
-
-The example below has property placeholder in the `<jmxAgent>` tag:
-
-You can also define property placeholders in the various attributes on
-the `<camelContext>` tag such as `trace` as shown here:
-
-== Using JVM system properties or Environment variables as override or fallback values
-
-The properties components supports using JVM system properties and also OS environment variables
-as values which can either be used as override or fallback values.
-
-The default mode is that both of them are in override mode, and they are check in the following order:
-
-1. OS environment variable (override mode)
-2. JVM system property (override mode)
-3. Property files and other locations
-4. OS environment variable (fallback mode)
-5. JVM system property (fallback mode)
-
-The check stops at first found property value for the key.
-
-You can control these modes using the `systemPropertiesMode` and `environmentVariableMode`
-options on the properties component.
-
-== Using property placeholders for any kind of attribute in the XML DSL
-
-In the example below we use the `prop` prefix for the namespace
-camel.apache.org/schema/placeholder by which we can use the
-`prop` prefix in the attributes in the XML DSLs. Notice how we use that
-in the Multicast to indicate that the option
-`stopOnException` should be the value of the placeholder with the key
-"stop".
-
-In our properties file we have the value defined as
-
-[source]
-----
-stop=true
-----
-
-== Using Blueprint property placeholder with Camel routes
-
-Camel supports Blueprint
-which also offers a property placeholder service. Camel supports
-convention over configuration, so all you have to do is to define the
-OSGi Blueprint property placeholder in the XML file as shown below:
-
-[source,xml]
-----
-<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.0.0"
- xsi:schemaLocation="
- http://www.osgi.org/xmlns/blueprint/v1.0.0 https://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
-
- <!-- OSGI blueprint property placeholder -->
- <cm:property-placeholder id="myblueprint.placeholder" persistent-id="camel.blueprint">
- <!-- list some properties as needed -->
- <cm:default-properties>
- <cm:property name="result" value="mock:result"/>
- </cm:default-properties>
- </cm:property-placeholder>
-
- <camelContext xmlns="http://camel.apache.org/schema/blueprint">
- <!-- in the route we can use {{ }} placeholders which will lookup in blueprint
- as Camel will auto detect the OSGi blueprint property placeholder and use it -->
- <route>
- <from uri="direct:start"/>
- <to uri="mock:foo"/>
- <to uri="{{result}}"/>
- </route>
- </camelContext>
-</blueprint>
-----
-
-=== Using OSGi blueprint property placeholders in Camel routes
-
-By default Camel detects and uses OSGi blueprint property placeholder
-service. You can disable this by setting the attribute
-`useBlueprintPropertyResolver` to false on the `<camelContext>`
-definition.
-
-=== About placeholder syntax
-
-Notice how we can use the Camel syntax for placeholders `{{` and `}}` in the
-Camel route, which will lookup the value from OSGi blueprint.
-
-The blueprint syntax for placeholders is `${ }`. So outside the
-`<camelContext>` you must use the `${ }` syntax. Where as inside
-`<camelContext>` you must use `{{` and `}}` syntax.
-
-OSGi blueprint allows you to configure the syntax, so you can actually
-align those if you want.
-
-You can also explicit refer to a specific OSGi blueprint property
-placeholder by its id. For that you need to use the Camel's
-`<propertyPlaceholder>` as shown in the example below:
-
-[source,xml]
-----
-<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.0.0"
- xsi:schemaLocation="
- http://www.osgi.org/xmlns/blueprint/v1.0.0 https://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
-
- <!-- OSGI blueprint property placeholder -->
- <cm:property-placeholder id="myblueprint.placeholder" persistent-id="camel.blueprint">
- <!-- list some properties as needed -->
- <cm:default-properties>
- <cm:property name="prefix.result" value="mock:result"/>
- </cm:default-properties>
- </cm:property-placeholder>
-
- <camelContext xmlns="http://camel.apache.org/schema/blueprint">
- <!-- using Camel properties component and refer to the blueprint property placeholder by its id -->
- <propertyPlaceholder id="properties" location="blueprint:myblueprint.placeholder"/>
-
- <!-- in the route we can use {{ }} placeholders which will lookup in blueprint -->
- <route>
- <from uri="direct:start"/>
- <to uri="mock:foo"/>
- <to uri="{{prefix.result}}"/>
- </route>
- </camelContext>
-</blueprint>
-----
-
-
-== Explicit referring to a OSGi blueprint placeholder in Camel
-
-Notice how we use the `blueprint` scheme to refer to the OSGi blueprint
-placeholder by its id. This allows you to mix and match, for example you
-can also have additional schemes in the location. For example to load a
-file from the classpath you can do:
-
-[source]
-----
-location="blueprint:myblueprint.placeholder,classpath:myproperties.properties"
-----
-
-Each location is separated by comma.
-
-== Overriding Blueprint property placeholders outside CamelContext
-
-When using Blueprint property placeholder in the Blueprint XML file, you
-can declare the properties directly in the XML file as shown below:
-
-Notice that we have a `<bean>` which refers to one of the properties. And
-in the Camel route we refer to the other using the `{{` and `}}` notation.
-
-Now if you want to override these Blueprint properties from an unit
-test, you can do this as shown below:
-
-To do this we override and implement the
-`useOverridePropertiesWithConfigAdmin` method. We can then put the
-properties we want to override on the given props parameter. And the
-return value *must* be the `persistence-id` of the
-`<cm:property-placeholder>` tag, which you define in the blueprint XML
-file.
-
-== Using .cfg or .properties file for Blueprint property placeholders
-
-When using Blueprint property placeholder in the Blueprint XML file, you
-can declare the properties in a `.properties` or `.cfg` file. If you use
-Apache ServieMix / Karaf then this container has a convention that it
-loads the properties from a file in the etc directory with the naming
-`etc/pid.cfg`, where `pid` is the `persistence-id`.
-
-For example in the blueprint XML file we have the
-`persistence-id="stuff"`, which mean it will load the configuration file
-as `etc/stuff.cfg`.
-
-Now if you want to unit test this blueprint XML file, then you can
-override the `loadConfigAdminConfigurationFile` and tell Camel which
-file to load as shown below:
-
-Notice that this method requires to return a `String[]` with 2 values. The
-1st value is the path for the configuration file to load.
-The 2nd value is the `persistence-id` of the `<cm:property-placeholder>`
-tag.
-
-The `stuff.cfg` file is just a plain properties file with the property
-placeholders such as:
-
-[source]
-----
-== this is a comment
-greeting=Bye
-----
-
-== Using .cfg file and overriding properties for Blueprint property placeholders
-
-You can do both as well. Here is a complete example. First we have the
-Blueprint XML file:
-
-And in the unit test class we do as follows:
-
-And the `etc/stuff.cfg` configuration file contains
-
-[source]
-----
-greeting=Bye
-echo=Yay
-destination=mock:result
-----
-
-== Bridging Spring and Camel property placeholders
-
-The Spring Framework does not allow 3rd party frameworks such as Apache
-Camel to seamless hook into the Spring property placeholder mechanism.
-However you can easily bridge Spring and Camel by declaring a Spring
-bean with the type
-`org.apache.camel.spring.spi.BridgePropertyPlaceholderConfigurer`, which
-is a Spring
-`org.springframework.beans.factory.config.PropertyPlaceholderConfigurer`
-type.
-
-To bridge Spring and Camel you must define a single bean as shown below:
-
-*Bridging Spring and Camel property placeholders*
-
-You *must not* use the spring <context:property-placeholder> namespace
-at the same time; this is not possible.
-
-After declaring this bean, you can define property placeholders using
-both the Spring style, and the Camel style within the <camelContext> tag
-as shown below:
-
-*Using bridge property placeholders*
-
-Notice how the hello bean is using pure Spring property placeholders
-using the `${ }` notation. And in the Camel routes we use the Camel
-placeholder notation with `{{` and `}}`.
-
-== Clashing Spring property placeholders with Camels Simple language
-
-Take notice when using Spring bridging placeholder then the spring `${ }`
-syntax clashes with the xref:manual:languages:simple-language.adoc[Simple] in Camel, and therefore
-take care. For example:
-
-[source,xml]
-----
-<setHeader name="Exchange.FILE_NAME">
- <simple>{{file.rootdir}}/${in.header.CamelFileName}</simple>
-</setHeader>
-----
-
-clashes with Spring property placeholders, and you should use `$simple{ }`
-to indicate using the xref:manual:languages:simple-language.adoc[Simple] language in Camel.
-
-[source,xml]
-----
-<setHeader name="Exchange.FILE_NAME">
- <simple>{{file.rootdir}}/$simple{in.header.CamelFileName}</simple>
-</setHeader>
-----
-
-An alternative is to configure the `PropertyPlaceholderConfigurer` with
-`ignoreUnresolvablePlaceholders` option to `true`.
-
-== Overriding properties from Camel test kit
-
-When Testing with Camel and using the
-xref:properties-component.adoc[Properties] component, you may want to be able to
-provide the properties to be used from directly within the unit test
-source code. +
-Camel test kits, eg `CamelTestSupport` class offers the following methods
-
-* `useOverridePropertiesWithPropertiesComponent`
-* `ignoreMissingLocationWithPropertiesComponent`
-
-So for example in your unit test classes, you can override the
-`useOverridePropertiesWithPropertiesComponent` method and return a
-`java.util.Properties` that contains the properties which should be
-preferred to be used.
-
-=== Providing properties from within unit test source
-
-This can be done from any of the Camel Test kits, such as camel-test,
-camel-test-spring, and camel-test-blueprint.
-
-The `ignoreMissingLocationWithPropertiesComponent` can be used to
-instruct Camel to ignore any locations which was not discoverable, for
-example if you run the unit test, in an environment that does not have
-access to the location of the properties.
-
-== Using @PropertyInject
-
-Camel allows to inject property placeholders in POJOs using the
-`@PropertyInject` annotation which can be set on fields and setter
-methods.
-
-For example you can use that with `RouteBuilder` classes, such as shown
-below:
-
-[source,java]
-----
-public class MyRouteBuilder extends RouteBuilder {
-
- @PropertyInject("hello")
- private String greeting;
-
- @Override
- public void configure() throws Exception {
- from("direct:start")
- .transform().constant(greeting)
- .to("{{result}}");
- }
-
-}
-----
-
-Notice we have annotated the greeting field with `@PropertyInject` and
-define it to use the key `"hello"`. Camel will then lookup the property
-with this key and inject its value, converted to a String type.
-
-You can also use multiple placeholders and text in the key, for example
-we can do:
-
-[source,java]
-----
-@PropertyInject("Hello {{name}} how are you?")
-private String greeting;
-----
-
-This will lookup the placeholder with they key `"name"`.
-
-You can also add a default value if the key does not exists, such as:
-
-[source,java]
-----
-@PropertyInject(value = "myTimeout", defaultValue = "5000")
-private int timeout;
-----
-
-== Using out of the box functions
-
-The xref:properties-component.adoc[Properties] component includes the following
-functions out of the box
-
-* `env` - A function to lookup the property from OS environment variables
-* `sys` - A function to lookup the property from Java JVM system
-properties
-* `service` - A function to lookup the property from OS environment
-variables using the service naming idiom
-* `service.name` - A function to lookup the
-property from OS environment variables using the service naming idiom
-returning the hostname part only
-* `service.port` - A function to lookup the
-property from OS environment variables using the service naming idiom
-returning the port part only
-
-As you can see these functions is intended to make it easy to lookup
-values from the environment. As they are provided out of the box, they
-can easily be used as shown below:
-
-[source,xml]
-----
- <camelContext xmlns="http://camel.apache.org/schema/blueprint">
-
- <route>
- <from uri="direct:start"/>
- <to uri="{`{env:SOMENAME}`}"/>
- <to uri="{`{sys:MyJvmPropertyName}`}"/>
- </route>
- </camelContext>
-----
-
-You can use default values as well, so if the property does not exists,
-you can define a default value as shown below, where the default value
-is a `log:foo` and `log:bar` value.
-
-[source,xml]
-----
- <camelContext xmlns="http://camel.apache.org/schema/blueprint">
-
- <route>
- <from uri="direct:start"/>
- <to uri="{`{env:SOMENAME:log:foo}`}"/>
- <to uri="{`{sys:MyJvmPropertyName:log:bar}`}"/>
- </route>
- </camelContext>
-----
-
-
-
-The service function is for looking up a service which is defined using
-OS environment variables using the service naming idiom, to refer to a
-service location using `hostname : port`
-
-* __NAME__**_SERVICE_HOST**
-* __NAME__**_SERVICE_PORT**
-
-in other words the service uses `_SERVICE_HOST` and `_SERVICE_PORT` as
-prefix. So if the service is named FOO, then the OS environment
-variables should be set as
-
-[source]
-----
-export $FOO_SERVICE_HOST=myserver
-export $FOO_SERVICE_PORT=8888
-----
-
-For example if the FOO service a remote HTTP service, then we can refer
-to the service in the Camel endpoint uri, and use
-the HTTP component to make the HTTP call:
-
-[source,xml]
-----
-<camelContext xmlns="http://camel.apache.org/schema/blueprint">
- <route>
- <from uri="direct:start"/>
- <to uri="http://{`{service:FOO}`}/myapp"/>
- </route>
-</camelContext>
-----
-
-And we can use default values if the service has not been defined, for
-example to call a service on localhost, maybe for unit testing etc
-
-[source,xml]
-----
-<camelContext xmlns="http://camel.apache.org/schema/blueprint">
- <route>
- <from uri="direct:start"/>
- <to uri="http://{`{service:FOO:localhost:8080}`}/myapp"/>
- </route>
-</camelContext>
-----
-
-== Using custom functions (advanced)
-
-The xref:properties-component.adoc[Properties] component allow to plugin 3rd party
-functions which can be used during parsing of the property placeholders.
-These functions are then able to do custom logic to resolve the
-placeholders, such as looking up in databases, do custom computations,
-or whatnot. The name of the function becomes the prefix used in the
-placeholder. This is best illustrated in the example code below
-
-[source,xml]
-----
-<bean id="beerFunction" class="MyBeerFunction"/>
-
-<camelContext xmlns="http://camel.apache.org/schema/blueprint">
- <propertyPlaceholder id="properties">
- <propertiesFunction ref="beerFunction"/>
- </propertyPlaceholder>
-
- <route>
- <from uri="direct:start"/>
- <to uri="{`{beer:FOO}`}"/>
- <to uri="{`{beer:BAR}`}"/>
- </route>
-</camelContext>
-----
-
-[NOTE]
-====
-The location attribute (on propertyPlaceholder tag) is not mandatory
-====
-
-Here we have a Camel XML route where we have defined the
-`<propertyPlaceholder>` to use a custom function, which we refer to be the
-bean id - eg the `beerFunction`. As the beer function uses `"beer"` as its
-name, then the placeholder syntax can trigger the beer function by
-starting with `beer:value`.
-
-The implementation of the function is only two methods as shown below:
-
-[source,java]
-----
-public static final class MyBeerFunction implements PropertiesFunction {
-
- @Override
- public String getName() {
- return "beer";
- }
-
- @Override
- public String apply(String remainder) {
- return "mock:" + remainder.toLowerCase();
- }
-}
-----
-
-The function must implement
-the `org.apache.camel.component.properties.PropertiesFunction`
-interface. The method `getName` is the name of the function, eg beer.
-And the `apply` method is where we implement the custom logic to do. As
-the sample code is from an unit test, it just returns a value to refer
-to a mock endpoint.
-
-To register a custom function from Java code is as shown below:
-
-[source,java]
-----
-PropertiesComponent pc = (org.apache.camel.componennt.properties.PropertiesComponent) context.getPropertiesComponent();
-pc.addFunction(new MyBeerFunction());
-----
-
-
-== Using 3rd-party properties sources
-
-The properties component allows to plugin 3rd party sources to load and lookup properties via the `PropertySource`
-API from camel-api. For example the `camel-microprofile-config` component is implemented using this.
-The 3rd-party `PropertySource` can automatic be discoverd from classpath when Camel is starting up.
-This is done by include the file `META-INF/services/org/apache/camel/property-source-factory` file
-which refers to the fully qualified class name of the `PropertySource` implementation.
-See the `camel-microprofile-config` for an example.
-
-You can also register 3rd-part property sources via Java API
-
-[source,java]
-----
-PropertiesComponent pc = ...
-pc.addPropertySource(myPropertySource);
-----
-
-=== LoadablePropertySource
-
-A `PropertySource` can define that it supports loading all its properties from the source at once,
-for example from file system. This allows Camel properties component to load these properties at once
-during startup.
-
-=== PropertySource
-
-The regular `PropertySource` will lookup the property on-demand, for example to lookup
-values from a backend source such as a database or HashiCorp Vault etc.
-
-
diff --git a/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc b/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc
index 74d5c9f..f783f33 100644
--- a/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc
+++ b/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc
@@ -209,7 +209,7 @@ over xref:components::jms-component.adoc[JMS] where the queue name is dynamic de
See more details at Message Endpoint about
the dynamic to, and what syntax it supports. By default it uses
-the xref:languages:simple-language.adoc[Simple] language, but it has more power than so.
+the xref:components:languages:simple-language.adoc[Simple] language, but it has more power than so.
== Embedding Camel routes
diff --git a/docs/user-manual/modules/ROOT/pages/spring-remoting.adoc b/docs/user-manual/modules/ROOT/pages/spring-remoting.adoc
index 36fe857..9694b70 100644
--- a/docs/user-manual/modules/ROOT/pages/spring-remoting.adoc
+++ b/docs/user-manual/modules/ROOT/pages/spring-remoting.adoc
@@ -351,9 +351,9 @@ the method option
* The value is a numeric value such as `123` or `7`
* The value is a String enclosed with either single or double quotes
* The value is null which denotes a `null` value
-* It can be evaluated using the xref:languages:simple-language.adoc[Simple] language, which
+* It can be evaluated using the xref:components:languages:simple-language.adoc[Simple] language, which
means you can use, e.g., body, header.foo and other
-xref:languages:simple-language.adoc[Simple] tokens. Notice the tokens must be enclosed with
+xref:components:languages:simple-language.adoc[Simple] tokens. Notice the tokens must be enclosed with
$\{ }.
Any other value is consider to be a type declaration instead - see the
@@ -398,7 +398,7 @@ body as shown:
.bean(OrderService.class, "doSomething(${body}, true)")
----
-The syntax of the parameters is using the xref:languages:simple-language.adoc[Simple]
+The syntax of the parameters is using the xref:components:languages:simple-language.adoc[Simple]
expression language so we have to use $\{ } placeholders in the body to
refer to the message body.
@@ -434,7 +434,7 @@ first has the content 'World' (without quotes), and the 2nd has the
value of 5. +
Camel will automatically convert these values to the parameters' types.
-Having the power of the xref:languages:simple-language.adoc[Simple] language allows us to
+Having the power of the xref:components:languages:simple-language.adoc[Simple] language allows us to
bind to message headers and other values such as:
[source,syntaxhighlighter-pre]
@@ -442,7 +442,7 @@ bind to message headers and other values such as:
.bean(OrderService.class, "doSomething(${body}, ${header.high})")
----
-You can also use the OGNL support of the xref:languages:simple-language.adoc[Simple]
+You can also use the OGNL support of the xref:components:languages:simple-language.adoc[Simple]
expression language. Now suppose the message body is an object which has
a method named `asXml`. To invoke the `asXml` method we can do as
follows:
diff --git a/docs/user-manual/modules/ROOT/pages/using-propertyplaceholder.adoc b/docs/user-manual/modules/ROOT/pages/using-propertyplaceholder.adoc
index 98823a8..2097961 100644
--- a/docs/user-manual/modules/ROOT/pages/using-propertyplaceholder.adoc
+++ b/docs/user-manual/modules/ROOT/pages/using-propertyplaceholder.adoc
@@ -293,9 +293,9 @@ template.sendBody("{{cool.start}}", "Hello World");
[[UsingPropertyPlaceholder-Examplewithlanguage]]
-== Example with xref:languages:simple-language.adoc[Simple] language
+== Example with xref:components:languages:simple-language.adoc[Simple] language
-The xref:languages:simple-language.adoc[Simple] language now also support using property
+The xref:components:languages:simple-language.adoc[Simple] language now also support using property
placeholders, for example in the route below:
@@ -308,7 +308,7 @@ cheese.quote=Camel rocks
.transform().simple("Hi ${body} do you think ${properties:cheese.quote}?");
----
-You can also specify the location in the xref:languages:simple-language.adoc[Simple]
+You can also specify the location in the xref:components:languages:simple-language.adoc[Simple]
language for example:
@@ -822,10 +822,10 @@ the `${}` notation. And in the Camel routes we use the Camel
placeholder notation with `{{ }}`.
[[UsingPropertyPlaceholder-ClashingSpringPropertyPlaceholderswithCamelsLanguage]]
-== Clashing Spring Property Placeholders with Camels xref:languages:simple-language.adoc[Simple] Language
+== Clashing Spring Property Placeholders with Camels xref:components:languages:simple-language.adoc[Simple] Language
Take notice when using Spring bridging placeholder then the
-spring `${}` syntax clashes with the xref:languages:simple-language.adoc[Simple] in
+spring `${}` syntax clashes with the xref:components:languages:simple-language.adoc[Simple] in
Camel, and therefore take care.
Example:
@@ -838,7 +838,7 @@ Example:
----
clashes with Spring property placeholders, and you should
-use `$simple{}` to indicate using the xref:languages:simple-language.adoc[Simple]
+use `$simple{}` to indicate using the xref:components:languages:simple-language.adoc[Simple]
language in Camel.