camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject [2/3] camel git commit: Added camel-mina2 docs to Gitbook
Date Mon, 09 May 2016 08:20:42 GMT
Added camel-mina2 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/c0d59a8b
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/c0d59a8b
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/c0d59a8b

Branch: refs/heads/master
Commit: c0d59a8b8ff97c7c34cadaa488900bb309000793
Parents: 91e97b7
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Mon May 9 10:08:17 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Mon May 9 10:08:17 2016 +0200

----------------------------------------------------------------------
 components/camel-mina/src/main/docs/mina.adoc   |   4 +-
 components/camel-mina2/src/main/docs/mina2.adoc | 268 +++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |   1 +
 3 files changed, 271 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/c0d59a8b/components/camel-mina/src/main/docs/mina.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mina/src/main/docs/mina.adoc b/components/camel-mina/src/main/docs/mina.adoc
index 220b91f..c2d2b33 100644
--- a/components/camel-mina/src/main/docs/mina.adoc
+++ b/components/camel-mina/src/main/docs/mina.adoc
@@ -221,8 +221,8 @@ written the `bye` message back to the client:
 Get the IoSession for message
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-*Available since Camel 2.1* +
- You can get the IoSession from the message header with this key
+*Available since Camel 2.1* 
+You can get the IoSession from the message header with this key
 MinaEndpoint.HEADER_MINA_IOSESSION, and also get the local host address
 with the key MinaEndpoint.HEADER_LOCAL_ADDRESS and remote host address
 with the key MinaEndpoint.HEADER_REMOTE_ADDRESS.

http://git-wip-us.apache.org/repos/asf/camel/blob/c0d59a8b/components/camel-mina2/src/main/docs/mina2.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mina2/src/main/docs/mina2.adoc b/components/camel-mina2/src/main/docs/mina2.adoc
new file mode 100644
index 0000000..d6c2485
--- /dev/null
+++ b/components/camel-mina2/src/main/docs/mina2.adoc
@@ -0,0 +1,268 @@
+[[MINA2-MINA2Component]]
+MINA 2 Component
+~~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.10*
+
+The *mina2:* component is a transport for working with
+http://mina.apache.org/[Apache MINA 2.x]
+
+TIP: Favor using link:netty.html[Netty] as Netty is a much more active
+maintained and popular project than Apache Mina currently is
+
+INFO: Be careful with sync=false on consumer endpoints. Since camel-mina2 all
+consumer exchanges are InOut. This is different to camel-mina.
+
+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-mina2</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[MINA2-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+-------------------------------------
+mina2:tcp://hostname[:port][?options]
+mina2:udp://hostname[:port][?options]
+mina2:vm://hostname[:port][?options]
+-------------------------------------
+
+You can specify a codec in the link:registry.html[Registry] using the
+*codec* option. If you are using TCP and no codec is specified then the
+`textline` flag is used to determine if text line based codec or object
+serialization should be used instead. By default the object
+serialization is used.
+
+For UDP if no codec is specified the default uses a basic `ByteBuffer`
+based codec.
+
+The VM protocol is used as a direct forwarding mechanism in the same
+JVM.
+
+A Mina producer has a default timeout value of 30 seconds, while it
+waits for a response from the remote server.
+
+In normal use, `camel-mina` only supports marshalling the body
+content—message headers and exchange properties are not sent. +
+ However, the option, *transferExchange*, does allow you to transfer the
+exchange itself over the wire. See options below.
+
+You can append query options to the URI in the following format,
+`?option=value&option=value&...`
+
+[[MINA2-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The Mina2 component supports 1 options which are listed below.
+
+
+
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| configuration | Mina2Configuration | To use the shared mina configuration.
+|=======================================================================
+// component options: END
+
+
+
+// endpoint options: START
+The Mina2 component supports 29 endpoint options which are listed below:
+
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| protocol | common |  | String | *Required* Protocol to use
+| host | common |  | String | *Required* Hostname to use. Use localhost or 0.0.0.0 for local
server as consumer. For producer use the hostname or ip address of the remote server.
+| port | common |  | int | *Required* Port number
+| allowDefaultCodec | common | true | boolean | The mina component installs a default codec
if both codec is null and textline is false. Setting allowDefaultCodec to false prevents the
mina component from installing a default codec as the first element in the filter chain. This
is useful in scenarios where another filter must be the first in the filter chain like the
SSL filter.
+| autoStartTls | common | true | boolean | Whether to auto start SSL handshake.
+| codec | common |  | ProtocolCodecFactory | To use a custom minda codec implementation.
+| decoderMaxLineLength | common | 1024 | int | To set the textline protocol decoder max line
length. By default the default value of Mina itself is used which are 1024.
+| disconnect | common | false | boolean | Whether or not to disconnect(close) from Mina session
right after use. Can be used for both consumer and producer.
+| disconnectOnNoReply | common | true | boolean | If sync is enabled then this option dictates
MinaConsumer if it should disconnect where there is no reply to send back.
+| encoderMaxLineLength | common | -1 | int | To set the textline protocol encoder max line
length. By default the default value of Mina itself is used which are Integer.MAX_VALUE.
+| encoding | common |  | String | You can configure the encoding (a charset name) to use
for the TCP textline codec and the UDP protocol. If not provided Camel will use the JVM default
Charset
+| filters | common |  | List | You can set a list of Mina IoFilters to use.
+| lazySessionCreation | common | true | boolean | Sessions can be lazily created to avoid
exceptions if the remote server is not up and running when the Camel producer is started.
+| maximumPoolSize | common | 16 | int | Number of worker threads in the worker pool for TCP
and UDP
+| minaLogger | common | false | boolean | You can enable the Apache MINA logging filter.
Apache MINA uses slf4j logging at INFO level to log all input and output.
+| noReplyLogLevel | common | WARN | LoggingLevel | If sync is enabled this option dictates
MinaConsumer which logging level to use when logging a there is no reply to send back.
+| orderedThreadPoolExecutor | common | true | boolean | Whether to use ordered thread pool
to ensure events are processed orderly on the same channel.
+| sslContextParameters | common |  | SSLContextParameters | To configure SSL security.
+| sync | common | true | boolean | Setting to set endpoint as one-way or request-response.
+| textline | common | false | boolean | Only used for TCP. If no codec is specified you can
use this flag to indicate a text line based codec; if not specified or the value is false
then Object Serialization is assumed over TCP.
+| textlineDelimiter | common |  | Mina2TextLineDelimiter | Only used for TCP and if textline=true.
Sets the text line delimiter to use. If none provided Camel will use DEFAULT. This delimiter
is used to mark the end of text.
+| timeout | common | 30000 | long | You can configure the timeout that specifies how long
to wait for a response from a remote server. The timeout unit is in milliseconds so 60000
is 60 seconds.
+| transferExchange | common | false | boolean | Only used for TCP. You can transfer the exchange
over the wire instead of just the body. The following fields are transferred: In body Out
body fault body In headers Out headers fault headers exchange properties exchange exception.
This requires that the objects are serializable. Camel will exclude any non-serializable objects
and log it at WARN level.
+| 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.
+| clientMode | consumer | false | boolean | If the clientMode is true mina consumer will
connect the address as a TCP client.
+| 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.
+| cachedAddress | producer | true | boolean | Whether to create the InetAddress once and
reuse. Setting this to false allows to pickup DNS changes in the network.
+| 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
+
+
+[[MINA2-Usingacustomcodec]]
+Using a custom codec
+^^^^^^^^^^^^^^^^^^^^
+
+See the Mina how to write your own codec. To use your custom codec with
+`camel-mina`, you should register your codec in the
+link:registry.html[Registry]; for example, by creating a bean in the
+Spring XML file. Then use the `codec` option to specify the bean ID of
+your codec. See link:hl7.html[HL7] that has a custom codec.
+
+[[MINA2-Samplewithsyncfalse]]
+Sample with sync=false
+^^^^^^^^^^^^^^^^^^^^^^
+
+In this sample, Camel exposes a service that listens for TCP connections
+on port 6200. We use the *textline* codec. In our route, we create a
+Mina consumer endpoint that listens on port 6200:
+
+[source,java]
+---------------------------------------------------------------------------------------
+from("mina2:tcp://localhost:" + port1 + "?textline=true&sync=false").to("mock:result");
+---------------------------------------------------------------------------------------
+
+As the sample is part of a unit test, we test it by sending some data to
+it on port 6200.
+
+[source,java]
+-------------------------------------------------------------------------------------------------
+MockEndpoint mock = getMockEndpoint("mock:result");
+mock.expectedBodiesReceived("Hello World");
+ 
+template.sendBody("mina2:tcp://localhost:" + port1 + "?textline=true&sync=false", "Hello
World");
+ 
+assertMockEndpointsSatisfied();
+-------------------------------------------------------------------------------------------------
+
+[[MINA2-Samplewithsynctrue]]
+Sample with sync=true
+^^^^^^^^^^^^^^^^^^^^^
+
+In the next sample, we have a more common use case where we expose a TCP
+service on port 6201 also use the textline codec. However, this time we
+want to return a response, so we set the `sync` option to `true` on the
+consumer.
+
+[source,java]
+---------------------------------------------------------------------------------------------
+from("mina2:tcp://localhost:" + port2 + "?textline=true&sync=true").process(new Processor()
{
+    public void process(Exchange exchange) throws Exception {
+        String body = exchange.getIn().getBody(String.class);
+        exchange.getOut().setBody("Bye " + body);
+    }
+});
+---------------------------------------------------------------------------------------------
+
+Then we test the sample by sending some data and retrieving the response
+using the `template.requestBody()` method. As we know the response is a
+`String`, we cast it to `String` and can assert that the response is, in
+fact, something we have dynamically set in our processor code logic.
+
+[source,java]
+-----------------------------------------------------------------------------------------------------------------------
+String response = (String)template.requestBody("mina2:tcp://localhost:" + port2 + "?textline=true&sync=true",
"World");
+assertEquals("Bye World", response);
+-----------------------------------------------------------------------------------------------------------------------
+
+[[MINA2-SamplewithSpringDSL]]
+Sample with Spring DSL
+^^^^^^^^^^^^^^^^^^^^^^
+
+Spring DSL can, of course, also be used for link:mina.html[MINA]. In the
+sample below we expose a TCP server on port 5555:
+
+[source,xml]
+-----------------------------------------------------------
+   <route>
+     <from uri="mina2:tcp://localhost:5555?textline=true"/>
+     <to uri="bean:myTCPOrderHandler"/>
+  </route>
+-----------------------------------------------------------
+
+In the route above, we expose a TCP server on port 5555 using the
+textline codec. We let the Spring bean with ID, `myTCPOrderHandler`,
+handle the request and return a reply. For instance, the handler bean
+could be implemented as follows:
+
+[source,java]
+-----------------------------------------------
+    public String handleOrder(String payload) {
+        ...
+        return "Order: OK"
+   }
+-----------------------------------------------
+
+[[MINA2-ClosingSessionWhenComplete]]
+Closing Session When Complete
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When acting as a server you sometimes want to close the session when,
+for example, a client conversion is finished. To instruct Camel to close
+the session, you should add a header with the key
+`CamelMinaCloseSessionWhenComplete` set to a boolean `true` value.
+
+For instance, the example below will close the session after it has
+written the `bye` message back to the client:
+
+[source,java]
+---------------------------------------------------------------------------------------------------
+        from("mina2:tcp://localhost:8080?sync=true&textline=true").process(new Processor()
{
+            public void process(Exchange exchange) throws Exception {
+                String body = exchange.getIn().getBody(String.class);
+                exchange.getOut().setBody("Bye " + body);
+                exchange.getOut().setHeader(Mina2Constants.MINA_CLOSE_SESSION_WHEN_COMPLETE,
true);
+            }
+        });
+---------------------------------------------------------------------------------------------------
+
+[[MINA2-GettheIoSessionformessage]]
+Get the IoSession for message
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can get the IoSession from the message header with this key
+`Mina2Constants.MINA_IOSESSION`, and also get the local host address
+with the key `Mina2Constants.MINA_LOCAL_ADDRESS` and remote host address
+with the key `Mina2Constants.MINA_REMOTE_ADDRESS`.
+
+[[MINA2-ConfiguringMinafilters]]
+Configuring Mina filters
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Filters permit you to use some Mina Filters, such as `SslFilter`. You
+can also implement some customized filters. Please note that `codec` and
+`logger` are also implemented as Mina filters of type, `IoFilter`. Any
+filters you may define are appended to the end of the filter chain; that
+is, after `codec` and `logger`.
+
+[[MINA2-SeeAlso]]
+See Also
+^^^^^^^^
+
+* link:configuring-camel.html[Configuring Camel]
+* link:component.html[Component]
+* link:endpoint.html[Endpoint]
+* link:getting-started.html[Getting Started]
+
+* link:mina.html[MINA]
+* link:netty.html[Netty]
+

http://git-wip-us.apache.org/repos/asf/camel/blob/c0d59a8b/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 0e2ed92..fa424e3 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -193,6 +193,7 @@
         * [SMTPs](smtps.adoc)
     * [Metrics](metrics.adoc)
     * [Mina](mina.adoc)
+    * [Mina2](mina2.adoc)
     * [Mock](mock.adoc)
     * [NATS](nats.adoc)
     * [Properties](properties.adoc)


Mime
View raw message