You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2016/05/19 08:46:45 UTC
[3/4] camel git commit: Added camel-rmi docs to Gitbook
Added camel-rmi 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/c29aafb2
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/c29aafb2
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/c29aafb2
Branch: refs/heads/master
Commit: c29aafb25b28f658c77b77c7f219ddc642408b0d
Parents: 036ee6b
Author: Andrea Cosentino <an...@gmail.com>
Authored: Thu May 19 10:39:18 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Thu May 19 10:39:18 2016 +0200
----------------------------------------------------------------------
components/camel-rmi/src/main/docs/rmi.adoc | 123 +++++++++++++++++++++++
docs/user-manual/en/SUMMARY.md | 1 +
2 files changed, 124 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/c29aafb2/components/camel-rmi/src/main/docs/rmi.adoc
----------------------------------------------------------------------
diff --git a/components/camel-rmi/src/main/docs/rmi.adoc b/components/camel-rmi/src/main/docs/rmi.adoc
new file mode 100644
index 0000000..3e67331
--- /dev/null
+++ b/components/camel-rmi/src/main/docs/rmi.adoc
@@ -0,0 +1,123 @@
+[[RMI-RMIComponent]]
+RMI Component
+~~~~~~~~~~~~~
+
+The *rmi:* component binds link:exchange.html[Exchange]s to the RMI
+protocol (JRMP).
+
+Since this binding is just using RMI, normal RMI rules still apply
+regarding what methods can be invoked. This component supports only
+Exchanges that carry a method invocation from an interface that extends
+the http://java.sun.com/j2se/1.3/docs/api/java/rmi/Remote.html[Remote]
+interface. All parameters in the method should be either
+http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html[Serializable]
+or `Remote` objects.
+
+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-rmi</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[RMI-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+------------------------------------------------------------------
+rmi://rmi-regisitry-host:rmi-registry-port/registry-path[?options]
+------------------------------------------------------------------
+
+For example:
+
+[source,java]
+------------------------------------
+rmi://localhost:1099/path/to/service
+------------------------------------
+
+You can append query options to the URI in the following format,
+`?option=value&option=value&...`
+
+[[RMI-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The RMI component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The RMI component supports 9 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| hostname | common | localhost | String | Hostname of RMI server
+| name | common | | String | *Required* Name to use when binding to RMI server
+| port | common | 1099 | int | Port number of RMI server
+| method | common | | String | You can set the name of the method to invoke.
+| remoteInterfaces | common | | List | To specific the remote interfaces.
+| 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.
+| 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).
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+[[RMI-Using]]
+Using
+^^^^^
+
+To call out to an existing RMI service registered in an RMI registry,
+create a route similar to the following:
+
+[source,java]
+------------------------------------------------
+from("pojo:foo").to("rmi://localhost:1099/foo");
+------------------------------------------------
+
+To bind an existing camel processor or service in an RMI registry,
+define an RMI endpoint as follows:
+
+[source,java]
+-------------------------------------------------------------------------
+RmiEndpoint endpoint= (RmiEndpoint) endpoint("rmi://localhost:1099/bar");
+endpoint.setRemoteInterfaces(ISay.class);
+from(endpoint).to("pojo:bar");
+-------------------------------------------------------------------------
+
+Note that when binding an RMI consumer endpoint, you must specify the
+`Remote` interfaces exposed.
+
+In XML DSL you can do as follows from *Camel 2.7* onwards:
+
+[source,xml]
+------------------------------------------------------------------------------------------------------------------------
+ <camel:route>
+ <from uri="rmi://localhost:37541/helloServiceBean?remoteInterfaces=org.apache.camel.example.osgi.HelloService"/>
+ <to uri="bean:helloServiceBean"/>
+ </camel:route>
+------------------------------------------------------------------------------------------------------------------------
+
+[[RMI-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/c29aafb2/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index cadf448..56c4b6b 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -223,6 +223,7 @@
* [Quickfix](quickfix.adoc)
* [RabbitMQ](rabbitmq.adoc)
* [Restlet](restlet.adoc)
+ * [RMI](rmi.adoc)
* [Scp](scp.adoc)
* [SJMS](sjms.adoc)
* [SJMS Batch](sjms-batch.adoc)