--- apiVersion: v1 kind: List items: - apiVersion: v1 kind: ConfigMap metadata: labels: funktion.fabric8.io/kind: Connector provider: fabric8 project: connector-xquery version: 1.1.24 group: io.fabric8.funktion.connector name: xquery data: deployment.yml: | --- apiVersion: extensions/v1beta1 kind: Deployment metadata: labels: funktion.fabric8.io/kind: Subscription connector: xquery spec: replicas: 1 template: metadata: labels: funktion.fabric8.io/kind: Subscription connector: xquery spec: containers: - image: fabric8/connector-xquery:1.1.24 name: connector schema.yml: | --- component: kind: component scheme: xquery syntax: xquery:resourceUri title: XQuery description: Transforms the message using a XQuery template using Saxon. label: transformation deprecated: false async: false javaType: org.apache.camel.component.xquery.XQueryComponent groupId: org.apache.camel artifactId: camel-saxon version: 2.18.1 componentProperties: moduleURIResolver: kind: property type: object javaType: net.sf.saxon.lib.ModuleURIResolver deprecated: false secret: false description: To use the custom ModuleURIResolver properties: resourceUri: kind: path group: common required: true type: string javaType: java.lang.String deprecated: false secret: false description: The name of the template to load from classpath or file system allowStAX: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Whether to allow using StAX mode configuration: kind: parameter group: common type: object javaType: net.sf.saxon.Configuration deprecated: false secret: false description: To use a custom Saxon configuration headerName: kind: parameter group: common type: string javaType: java.lang.String deprecated: false secret: false description: To use a Camel Message header as the input source instead of Message body. moduleURIResolver: kind: parameter group: common type: object javaType: net.sf.saxon.lib.ModuleURIResolver deprecated: false secret: false description: To use the custom ModuleURIResolver namespacePrefixes: kind: parameter group: common type: object javaType: java.util.Map deprecated: false secret: false description: Allows to control which namespace prefixes to use for a set of namespace mappings parameters: kind: parameter group: common type: object javaType: java.util.Map deprecated: false secret: false description: Additional parameters properties: kind: parameter group: common type: object javaType: java.util.Properties deprecated: false secret: false description: Properties to configure the serialization parameters resultsFormat: kind: parameter group: common type: string javaType: org.apache.camel.component.xquery.ResultFormat enum: - Bytes - BytesSource - DOM - DOMSource - List - String - StringSource deprecated: false secret: false defaultValue: DOM description: What output result to use resultType: kind: parameter group: common type: string javaType: java.lang.Class deprecated: false secret: false description: What output result to use defined as a class staticQueryContext: kind: parameter group: common type: object javaType: net.sf.saxon.query.StaticQueryContext deprecated: false secret: false description: To use a custom Saxon StaticQueryContext stripsAllWhiteSpace: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: Whether to strip all whitespaces bridgeErrorHandler: kind: parameter group: consumer label: consumer type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: false description: Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. sendEmptyMessageWhenIdle: kind: parameter group: consumer label: consumer type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: false description: If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. exceptionHandler: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.spi.ExceptionHandler optionalPrefix: consumer. deprecated: false secret: false description: To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. exchangePattern: kind: parameter group: consumer (advanced) label: consumer,advanced type: string javaType: org.apache.camel.ExchangePattern enum: - InOnly - RobustInOnly - InOut - InOptionalOut - OutOnly - RobustOutOnly - OutIn - OutOptionalIn deprecated: false secret: false description: Sets the exchange pattern when the consumer creates an exchange. pollStrategy: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.spi.PollingConsumerPollStrategy optionalPrefix: consumer. deprecated: false secret: false description: A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. synchronous: kind: parameter group: advanced label: advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). backoffErrorThreshold: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: int optionalPrefix: consumer. deprecated: false secret: false description: The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. backoffIdleThreshold: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: int optionalPrefix: consumer. deprecated: false secret: false description: The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. backoffMultiplier: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: int optionalPrefix: consumer. deprecated: false secret: false description: To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. delay: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: long optionalPrefix: consumer. deprecated: false secret: false defaultValue: "500" description: Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). greedy: kind: parameter group: scheduler label: consumer,scheduler type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: false description: If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. initialDelay: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: long optionalPrefix: consumer. deprecated: false secret: false defaultValue: "1000" description: Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). runLoggingLevel: kind: parameter group: scheduler label: consumer,scheduler type: string javaType: org.apache.camel.LoggingLevel enum: - TRACE - DEBUG - INFO - WARN - ERROR - OFF optionalPrefix: consumer. deprecated: false secret: false defaultValue: TRACE description: The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. scheduledExecutorService: kind: parameter group: scheduler label: consumer,scheduler type: object javaType: java.util.concurrent.ScheduledExecutorService optionalPrefix: consumer. deprecated: false secret: false description: Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. scheduler: kind: parameter group: scheduler label: consumer,scheduler type: string javaType: org.apache.camel.spi.ScheduledPollConsumerScheduler enum: - none - spring - quartz2 optionalPrefix: consumer. deprecated: false secret: false defaultValue: none description: To use a cron scheduler from either camel-spring or camel-quartz2 component schedulerProperties: kind: parameter group: scheduler label: consumer,scheduler type: object javaType: java.util.Map prefix: scheduler. multiValue: true deprecated: false secret: false description: To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. startScheduler: kind: parameter group: scheduler label: consumer,scheduler type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: true description: Whether the scheduler should be auto started. timeUnit: kind: parameter group: scheduler label: consumer,scheduler type: string javaType: java.util.concurrent.TimeUnit enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS optionalPrefix: consumer. deprecated: false secret: false defaultValue: MILLISECONDS description: Time unit for initialDelay and delay options. useFixedDelay: kind: parameter group: scheduler label: consumer,scheduler type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: true description: Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. documentation.adoc: | [[XQuery-XQuery]] XQuery ~~~~~~ Camel supports http://www.w3.org/TR/xquery/[XQuery] to allow an link:expression.html[Expression] or link:predicate.html[Predicate] to be used in the link:dsl.html[DSL] or link:xml-configuration.html[Xml Configuration]. For example you could use XQuery to create an link:predicate.html[Predicate] in a link:message-filter.html[Message Filter] or as an link:expression.html[Expression] for a link:recipient-list.html[Recipient List]. [[XQuery-Options]] Options ^^^^^^^ // component options: START The XQuery component supports 1 options which are listed below. {% raw %} [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description | moduleURIResolver | ModuleURIResolver | To use the custom ModuleURIResolver |======================================================================= {% endraw %} // component options: END // endpoint options: START The XQuery component supports 31 endpoint options which are listed below: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description | resourceUri | common | | String | *Required* The name of the template to load from classpath or file system | allowStAX | common | false | boolean | Whether to allow using StAX mode | configuration | common | | Configuration | To use a custom Saxon configuration | headerName | common | | String | To use a Camel Message header as the input source instead of Message body. | moduleURIResolver | common | | ModuleURIResolver | To use the custom ModuleURIResolver | namespacePrefixes | common | | Map | Allows to control which namespace prefixes to use for a set of namespace mappings | parameters | common | | Map | Additional parameters | properties | common | | Properties | Properties to configure the serialization parameters | resultsFormat | common | DOM | ResultFormat | What output result to use | resultType | common | | Class | What output result to use defined as a class | staticQueryContext | common | | StaticQueryContext | To use a custom Saxon StaticQueryContext | stripsAllWhiteSpace | common | true | boolean | Whether to strip all whitespaces | bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. | pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component | schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. | timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. | useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= {% endraw %} // endpoint options: END [[XQuery-Examples]] Examples ^^^^^^^^ [source,java] --------------------------- from("queue:foo").filter(). xquery("//foo"). to("queue:bar") --------------------------- You can also use functions inside your query, in which case you need an explicit type conversion (or you will get a org.w3c.dom.DOMException: HIERARCHY_REQUEST_ERR) by passing the Class as a second argument to the *xquery()* method. [source,java] ----------------------------------------------------------------------------- from("direct:start"). recipientList().xquery("concat('mock:foo.', /person/@city)", String.class); ----------------------------------------------------------------------------- [[XQuery-Variables]] Variables ^^^^^^^^^ The IN message body will be set as the `contextItem`. Besides this these Variables is also added as parameters: [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= |Variable |Type |Description |exchange |Exchange |The current Exchange |in.body |Object |The In message's body |out.body |Object |The OUT message's body (if any) |in.headers.* |Object |You can access the value of exchange.in.headers with key *foo* by using the variable which name is in.headers.foo |out.headers.* |Object |You can access the value of exchange.out.headers with key *foo* by using the variable which name is out.headers.foo variable |*key name* |Object |Any exchange.properties and exchange.in.headers and any additional parameters set using `setParameters(Map)`. These parameters is added with they own key name, for instance if there is an IN header with the key name *foo* then its added as *foo*. |======================================================================= [[XQuery-UsingXMLconfiguration]] Using XML configuration ^^^^^^^^^^^^^^^^^^^^^^^ If you prefer to configure your routes in your link:spring.html[Spring] XML file then you can use XPath expressions as follows [source,xml] --------------------------------------------------------------------------------------------------------------- /foo:person[@name='James'] --------------------------------------------------------------------------------------------------------------- Notice how we can reuse the namespace prefixes, *foo* in this case, in the XPath expression for easier namespace based XQuery expressions! When you use functions in your XQuery expression you need an explicit type conversion which is done in the xml configuration via the *@type* attribute: [source,xml] ------------------------------------------------------------------------------- concat('mock:foo.', /person/@city) ------------------------------------------------------------------------------- [[XQuery-UsingXQueryastransformation]] Using XQuery as transformation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ We can do a message translation using transform or setBody in the route, as shown below: [source,java] ---------------------------------------- from("direct:start"). transform().xquery("/people/person"); ---------------------------------------- Notice that xquery will use DOMResult by default, so if we want to grab the value of the person node, using text() we need to tell xquery to use String as result type, as shown: [source,java] ------------------------------------------------------------- from("direct:start"). transform().xquery("/people/person/text()", String.class); ------------------------------------------------------------- ?? [[XQuery-UsingXQueryasanendpoint]] Using XQuery as an endpoint ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Sometimes an XQuery expression can be quite large; it can essentally be used for link:templating.html[Templating]. So you may want to use an link:xquery-endpoint.html[XQuery Endpoint] so you can route using XQuery templates. The following example shows how to take a message of an ActiveMQ queue (MyQueue) and transform it using XQuery and send it to MQSeries. [source,java] ------------------------------------------------------------------------- ------------------------------------------------------------------------- [[XQuery-Examples.1]] Examples ^^^^^^^^ Here is a simple http://svn.apache.org/repos/asf/camel/trunk/components/camel-saxon/src/test/java/org/apache/camel/builder/saxon/XQueryFilterTest.java[example] using an XQuery expression as a predicate in a link:message-filter.html[Message Filter] This http://svn.apache.org/repos/asf/camel/trunk/components/camel-saxon/src/test/java/org/apache/camel/builder/saxon/XQueryWithNamespacesFilterTest.java[example] uses XQuery with namespaces as a predicate in a link:message-filter.html[Message Filter] [[XQuery-LearningXQuery]] Learning XQuery ^^^^^^^^^^^^^^^ XQuery is a very powerful language for querying, searching, sorting and returning XML. For help learning XQuery try these tutorials * Mike Kay's http://www.stylusstudio.com/xquery_primer.html[XQuery Primer] * the W3Schools http://www.w3schools.com/xquery/default.asp[XQuery Tutorial] You might also find the http://www.w3.org/TR/xpath-functions/[XQuery function reference] useful [[XQuery-Loadingscriptfromexternalresource]] Loading script from external resource ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ *Available as of Camel 2.11* You can externalize the script and have Camel load it from a resource such as `"classpath:"`, `"file:"`, or `"http:"`. + This is done using the following syntax: `"resource:scheme:location"`, eg to refer to a file on the classpath you can do: [source,java] ------------------------------------------------------------------------------ .setHeader("myHeader").xquery("resource:classpath:myxquery.txt", String.class) ------------------------------------------------------------------------------ [[XQuery-Dependencies]] Dependencies ^^^^^^^^^^^^ To use XQuery in your camel routes you need to add the a dependency on *camel-saxon* which implements the XQuery language. If you use maven you could just add the following to your pom.xml, substituting the version number for the latest & greatest release (see link:download.html[the download page for the latest versions]). [source,java] -------------------------------------- org.apache.camel camel-saxon x.x.x --------------------------------------