MINA Component
The mina: component is a transport for working with Apache MINA
URI format
mina:tcp://hostname[:port] mina:udp://hostname[:port] mina:multicast://hostname[:port] mina:vm://hostname[:port}
From Camel 1.3 onwards you can specify a codec in the 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.
For UDP/Multicast if no codec is specified the default uses a basic ByteBuffer based codec.
Multicast also has a shorthand notation mcast.
The VM protocol is used as a direct forwarding mechanism in the same JVM. See the MINA VM-Pipe API documentation for details.
A MinaProducer has a default timeout value of 30 seconds, while it waits for a response from the remote server.
In normal usage Camel-mina only supports marshalling the body content - message headers and exchange properties will not be sent.
However the option transferExchange does allow to transfer the exchange itself over the wire. See options below.
Options
Name |
Default Value |
Description |
---|---|---|
codec |
null |
As of 1.3 or later you can refer to a named ProtocolCodecFactory instance in your Registry such as your Spring ApplicationContext which is then used for the marshalling |
textline |
null |
Only used for TCP. If no codec is specified then you can use this flag in 1.3 or later to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP. |
sync |
false |
As of 1.3 or later you can configure the exchange pattern to be either InOnly (default) or InOut. Setting sync=true means a synchronous exchange (InOut), where the client can read the response from MINA (The exchange out message). |
lazySessionCreation |
false |
As of 1.3 or later session can be lazy created to avoid exceptions if the remote server is not up and running when the Camel producer is started. |
timeout |
30000 |
As of 1.3 or later you can configure the timeout while waiting for a response from a remote server. The timeout unit is in millis, so 60000 is 60 seconds. The timeout is only used for MinaProducer. |
encoding |
JVM Default |
As of 1.3 or later you can configure the encoding (is a charset name) to use for the TCP textline codec and the UDP protocol. If not provided Camel will use the JVM default Charset. |
transferExchange |
false |
Only used for TCP. As of 1.3 or later you can transfer the exchange over the wire instead of just the body. The following fields is transfered: in body, out body, in headers, out headers, exchange properties, exchange exception. |
minaLogger |
false |
As of 1.3 or later you can enable Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output. |
Samples
In this sample we let Camel expose a service that listen for TCP connections on port 6200. We use the textline codec meaning that we use the \n
marker to indicate end-of-data. In out route we create the mina in the from to create the consumer that listen on port 6200:
As the sample is part of an unit test we test it by sending some data on port 6200 to it. Notice that we must append the \n
character at the end to indicate end-of-data. This sample is a bit a typically as its async and we do not return an response.
In the next sample we have a more common use-case where we expose a TCP service on port 6201 also using the textline codec. However this time we want to return a response so we add the sync=true option on the consumer.
Then we test it 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.