Added camel-javaspace 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/5e167449 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/5e167449 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/5e167449 Branch: refs/heads/master Commit: 5e1674495d00ff11a8093d8df7f27fa5642f4791 Parents: 5a5fa39 Author: Andrea Cosentino <anco...@gmail.com> Authored: Thu Apr 21 18:42:47 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Thu Apr 21 18:42:47 2016 +0200 ---------------------------------------------------------------------- .../src/main/docs/javaspace.adoc | 147 +++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 148 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/5e167449/components/camel-javaspace/src/main/docs/javaspace.adoc ---------------------------------------------------------------------- diff --git a/components/camel-javaspace/src/main/docs/javaspace.adoc b/components/camel-javaspace/src/main/docs/javaspace.adoc new file mode 100644 index 0000000..d064246 --- /dev/null +++ b/components/camel-javaspace/src/main/docs/javaspace.adoc @@ -0,0 +1,147 @@ +[[JavaSpace-JavaSpaceComponent]] +JavaSpace Component +~~~~~~~~~~~~~~~~~~~ + +*Available as of Camel 2.1* + +The *javaspace* component is a transport for working with any JavaSpace +compliant implementation and this component has been tested with both +the http://www.dancres.org/blitz/[Blitz implementation] and the +http://www.gigaspaces.com/[GigaSpace implementation]. + + This component can be used for sending and receiving any object +inheriting from the Jini `net.jini.core.entry.Entry` class. It is also +possible to pass the bean ID of a template that can be used for +reading/taking the entries from the space. + + This component can be used for sending/receiving any serializable +object acting as a sort of generic transport. The JavaSpace component +contains a special optimization for dealing with the `BeanExchange`. It +can be used to invoke a POJO remotely, using a JavaSpace as a +transport. + + This latter feature can provide a simple implementation of the +master/worker pattern, where a POJO provides the business logic for the +worker. + + Look at the test cases for examples of various use cases for this +component. + +Maven users will need to add the following dependency to their `pom.xml` +for this component: + +[source,xml] +------------------------------------------------------------ +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-javaspace</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +------------------------------------------------------------ + +[[JavaSpace-URIformat]] +URI format +^^^^^^^^^^ + +[source,java] +------------------------------- +javaspace:jini://host[?options] +------------------------------- + +You can append query options to the URI in the following format, +`?option=value&option=value&...` + +[[JavaSpace-Options]] +Options +^^^^^^^ + + +// component options: START +The JavaSpace component has no options. +// component options: END + + + +// endpoint options: START +The JavaSpace component supports 11 endpoint options which are listed below: + +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| url | common | | String | *Required* The URL to the JavaSpace server +| spaceName | common | | String | *Required* Specifies the JavaSpace name. +| transactional | common | false | boolean | If true sending and receiving entries is performed within a transaction. +| transactionTimeout | common | | long | Specifies the transaction timeout in millis. By default there is no timeout. +| 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. +| concurrentConsumers | consumer | 1 | int | Specifies the number of concurrent consumers getting entries from the JavaSpace. +| templateId | consumer | | String | If present this option specifies the Spring bean ID of the template to use for reading/taking entries. +| verb | consumer | take | String | Specifies the verb for getting JavaSpace entries. +| 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 | 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 + + +[[JavaSpace-Examples]] +Examples +^^^^^^^^ + +[[JavaSpace-SendingandReceivingEntries]] +Sending and Receiving Entries ++++++++++++++++++++++++++++++ + +[source,java] +-------------------------------------------------------------------------------------------------------- +// sending route +from("direct:input") + .to("javaspace:jini://localhost?spaceName=mySpace"); + +// receiving Route +from("javaspace:jini://localhost?spaceName=mySpace&templateId=template&verb=take&concurrentConsumers=1") + .to("mock:foo"); +-------------------------------------------------------------------------------------------------------- + +In this case the payload can be any object that inherits from the Jini +`Entry` type. + +[[JavaSpace-Sendingandreceivingserializableobjects]] +Sending and receiving serializable objects +++++++++++++++++++++++++++++++++++++++++++ + +Using the preceding routes, it is also possible to send and receive any +serializable object. The JavaSpace component detects that the payload is +not a Jini `Entry` and then it automatically wraps the payload with a +Camel Jini `Entry`. In this way, a JavaSpace can be used as a generic +transport mechanism. + +[[JavaSpace-UsingJavaSpaceasaremoteinvocationtransport]] +Using JavaSpace as a remote invocation transport +++++++++++++++++++++++++++++++++++++++++++++++++ + +The JavaSpace component has been tailored to work in combination with +the Camel bean component. It is therefore possible to call a remote POJO +using JavaSpace as the transport: + +[source,java] +--------------------------------------------------------------------------- +// client side +from("direct:input") + .to("javaspace:jini://localhost?spaceName=mySpace"); + +// server side +from("javaspace:jini://localhost?concurrentConsumers=10&spaceName=mySpace") + .to("mock:foo"); +--------------------------------------------------------------------------- + +In the code there are two test cases showing how to use a POJO to +realize the master/worker pattern. The idea is to use the POJO to +provide the business logic and rely on Camel for sending/receiving +requests/replies with the proper correlation. + +[[JavaSpace-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/5e167449/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 367d157..d1869c6 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -161,6 +161,7 @@ * [IRC](irc.adoc) * [Ironmq](ironmq.adoc) * [Jasypt](jasypt.adoc) + * [Javaspace](javaspace.adoc) * [JMS](jms.adoc) * [JMX](jmx.adoc) * [JSON](json.adoc)
