Repository: camel Updated Branches: refs/heads/master 285550797 -> c4a880268
Added camel-jing docs to Gitbook Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/c3d42cdf Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/c3d42cdf Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/c3d42cdf Branch: refs/heads/master Commit: c3d42cdf70ecf8cd9e5fe7568149a3e37e889755 Parents: 2855507 Author: Andrea Cosentino <anco...@gmail.com> Authored: Thu Apr 28 12:02:34 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Thu Apr 28 12:02:53 2016 +0200 ---------------------------------------------------------------------- components/camel-jing/src/main/docs/jing.adoc | 86 ++++++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 87 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/c3d42cdf/components/camel-jing/src/main/docs/jing.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jing/src/main/docs/jing.adoc b/components/camel-jing/src/main/docs/jing.adoc new file mode 100644 index 0000000..5e96985 --- /dev/null +++ b/components/camel-jing/src/main/docs/jing.adoc @@ -0,0 +1,86 @@ +[[Jing-JingComponent]] +Jing Component +~~~~~~~~~~~~~~ + +The Jing component uses the +http://www.thaiopensource.com/relaxng/jing.html[Jing Library] to perform +XML validation of the message body using either + +* http://relaxng.org/[RelaxNG XML Syntax] +* http://relaxng.org/compact-tutorial-20030326.html[RelaxNG Compact +Syntax] + +Maven users will need to add the following dependency to their `pom.xml` +for this component: + +[source,java] +------------------------------------------------------------ +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-jing</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +------------------------------------------------------------ + +Note that the link:msv.html[MSV] component can also support RelaxNG XML +syntax. + +[[Jing-URIformatCamel2.16]] +URI format Camel 2.16 +^^^^^^^^^^^^^^^^^^^^^ + +[source,java] +------------------------------ +jing:someLocalOrRemoteResource +------------------------------ + +From Camel 2.16 the component use jing as name, and you can use the +option compactSyntax to turn on either RNG or RNC mode. + +[[Jing-Options]] +Options +^^^^^^^ + + +// component options: START +The Jing component has no options. +// component options: END + + + +// endpoint options: START +The Jing component supports 4 endpoint options which are listed below: + +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| resourceUri | producer | | String | *Required* URL to a local resource on the classpath or a full URL to a remote resource or resource on the file system which contains the schema to validate against. +| compactSyntax | producer | false | boolean | Whether to validate using RelaxNG compact syntax or not. By default this is false for using RelaxNG XML Syntax (rng) And true is for using RelaxNG Compact Syntax (rnc) +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +// endpoint options: END + + +[[Jing-Example]] +Example +^^^^^^^ + +The following +http://svn.apache.org/repos/asf/camel/trunk/components/camel-jing/src/test/resources/org/apache/camel/component/validator/jing/rnc-context.xml[example] +shows how to configure a route from the endpoint *direct:start* which +then goes to one of two endpoints, either *mock:valid* or *mock:invalid* +based on whether or not the XML matches the given +http://relaxng.org/compact-tutorial-20030326.html[RelaxNG Compact +Syntax] schema (which is supplied on the classpath). + +[[Jing-SeeAlso]] +See Also +^^^^^^^^ + +* link:configuring-camel.html[Configuring Camel] +* link:component.html[Component] +* link:endpoint.html[Endpoint] +* link:getting-started.html[Getting Started] + http://git-wip-us.apache.org/repos/asf/camel/blob/c3d42cdf/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 252fcb4..421fec2 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -172,6 +172,7 @@ * [JDBC](jdbc.adoc) * [Jetty](jetty.adoc) * [Jgroups](jgroups.adoc) + * [Jing](jing.adoc) * [Kafka](kafka.adoc) * [Metrics](metrics.adoc) * [Mock](mock.adoc)
