Page History

h2. MINA 2 Component
*Available as of Camel 2.10*

The *mina2:* component is a transport for working with [Apache MINA 2.x|http://mina.apache.org/]

{tip}
Favor using [Netty] as Netty is a much more active maintained and popular project than Apache Mina currently is
{tip}

Maven users will need to add the following dependency to their {{pom.xml}} for this component:
{code: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>
{code}

h3. URI format

{code}
mina2:tcp://hostname[:port][?options]
mina2:udp://hostname[:port][?options]
mina2:vm://hostname[:port][?options]
{code}
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. 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&mdash;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&...}}

h3. Options
{div:class=confluenceTableSmall}
|| Option || Default Value || Description ||
| {{codec}} | {{null}} | You can refer to a named {{ProtocolCodecFactory}} instance in your [Registry] such as your Spring {{ApplicationContext}}, which is then used for the marshalling. |
| {{disconnect}} | {{false}} | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. |
| {{textline}} | {{false}} | 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}} | {{DEFAULT}} | Only used for TCP and if *textline=true*. Sets the text line delimiter to use. Possible values are: {{DEFAULT}}, {{AUTO}}, {{WINDOWS}}, {{UNIX}} or {{MAC}}. If none provided, Camel will use {{DEFAULT}}. This delimiter is used to mark the end of text. |
| {{sync}} | {{true}} | Setting to set endpoint as one-way or request-response. |
| {{lazySessionCreation}} | {{true}} | Sessions can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started. |
| {{timeout}} | {{30000}} | 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. The timeout is only used for Mina producer. |
| {{encoding}} | _JVM Default_ | You can configure the encoding (a [charset name|http://java.sun.com/j2se/1.5.0/docs/api/java/nio/charset/Charset.html]) to use for the TCP textline codec and the UDP protocol. If not provided, Camel will use the [JVM default Charset|http://java.sun.com/j2se/1.5.0/docs/api/java/nio/charset/Charset.html#defaultCharset()]. |
| {{transferExchange}} | {{false}} | 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. |
| {{minaLogger}} | {{false}} | You can enable the Apache MINA logging filter. Apache MINA uses {{slf4j}} logging at {{INFO}} level to log all input and output. |
| {{filters}} | {{null}} | You can set a list of [Mina IoFilters|http://mina.apache.org/iofilter.html] to register. The {{filters}} can be specified as a comma-separate list of bean references (e.g. {{\#filterBean1,#filterBean2}}) where each bean must be of type {{org.apache.mina.common.IoFilter}}. |
| {{encoderMaxLineLength}} | {{\-1}} | Set the textline protocol encoder max line length. By default the default value of Mina itself is used which are {{Integer.MAX_VALUE}}. |
| {{decoderMaxLineLength}} | {{\-1}} | Set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024. |
| {{maximumPoolSize}} | 16 | The TCP producer is thread safe and supports concurrency much better. This option allows you to configure the number of threads in its thread pool for concurrent producers. *Note:* Camel has a pooled service which ensured it was already thread safe and supported concurrency already. |
| {{allowDefaultCodec}} | {{true}} | 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. |
| {{disconnectOnNoReply}} | {{true}} | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back. |
| {{noReplyLogLevel}} | {{WARN}} | If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back. Values are: {{FATAL, ERROR, INFO, DEBUG, OFF}}. |
| {{orderedThreadPoolExecutor}} | {{true}} | Whether to use ordered thread pool, to ensure events are processed orderly on the same channel. |
| {{sslContextParameters}} | {{null}} | SSL configuration using an {{org.apache.camel.util.jsse.SSLContextParameters}} instance. See [Using the JSSE Configuration Utility]. |
| {{autoStartTls}} | {{true}} | Whether to auto start SSL handshake. |
{div}

h3. 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 [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 [HL7] that has a custom codec.

h3. 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:

{code}
from("mina2:tcp://localhost:" + port1 + "?textline=true&sync=false").to("mock:result");
{code}

As the sample is part of a unit test, we test it by sending some data to it on port 6200.

{code}
MockEndpoint mock = getMockEndpoint("mock:result");
mock.expectedBodiesReceived("Hello World");
 
template.sendBody("mina2:tcp://localhost:" + port1 + "?textline=true&sync=false", "Hello World");
 
assertMockEndpointsSatisfied();
{code}

h3. 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.

{code}
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);
    }
});
{code}

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.

{code}
String response = (String)template.requestBody("mina2:tcp://localhost:" + port2 + "?textline=true&sync=true", "World");
assertEquals("Bye World", response);
{code}

h3. Sample with Spring DSL

Spring DSL can, of course, also be used for [Mina]. In the sample below we expose a TCP server on port 5555:

{code:xml}
   <route>
     <from uri="mina2:tcp://localhost:5555?textline=true"/>
     <to uri="bean:myTCPOrderHandler"/>
  </route>
{code}

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:
{code:java}
    public String handleOrder(String payload) {
        ...
        return "Order: OK"
   }
{code}


h3. 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:
{code: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);
            }
        });
{code}

h3. 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}}.

h3. 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}}.

{include:Endpoint See Also}
- [Mina]
- [Netty]