Page History

...

mina:tcp://hostname[:port][?options]
mina:udp://hostname[:port][?options]
mina:multicast://hostname[:port][?options]
mina:vm://hostname[:port}][?options]

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. By default the object serialization is used.

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 Mina producer has a default timeout value of 30 seconds, while it waits for a response from the remote server.

In normal usage use, camel-mina only supports marshalling the body content - message content—message headers and exchange properties will are not be sent.
However, the option, transferExchange, does allow you to transfer the exchange itself over the wire. See options belowoptions below.

You can append query options to the URI in the following format, ?option=value&option=value&...

Options

...

In Camel 2.0 the codec option must use # notation for lookup of the codec bean in the Registry.
In Camel 2.0 the lazySessionCreation option is now default defaults to true.

In Camel 1.5 the sync option has changed its default value from false to true, as we felt it was confusing for end-users when they used Mina to call remote servers and Camel wouldn't wait for the response.

In Camel 1.4 or later codec=textline is no longer supported. Use the textline=true option instead.

Using a custom codec

See the Mina documentation how to write your own codec. To use your custom codec with camel-mina, you should register your codec in the Registry such as ; for example, by creating a bean in the Spring XML file. Then use the codec option to set specify the bean ID of your codec with its bean id. See HL7 that has a custom codec.

Sample with sync=false

In this sample we let , Camel expose exposes a service that listen listens for TCP connections on port 6200. We use the textline codec. In out our route, we create the mina in the from to create the consumer that listen a Mina consumer endpoint that listens on port 6200:

{snippet:id=e1|lang=java|url=camel/trunk/components/camel-mina/src/test/java/org/apache/camel/component/mina/MinaConsumerTest.java}

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

{snippet:id=e2|lang=java|url=camel/trunk/components/camel-mina/src/test/java/org/apache/camel/component/mina/MinaConsumerTest.java}

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 using use the textline codec. However, this time we want to return a response and indicate that we support this , so we set the sync option to true on the consumer.

{snippet:id=e3|lang=java|url=camel/trunk/components/camel-mina/src/test/java/org/apache/camel/component/mina/MinaConsumerTest.java}

Then we test it 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.

...

Sample with Spring DSL

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

   <route>
     <from uri="mina: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 and we let a spring . We let the Spring bean with the id ID, myTCPOrderHandler, handle the request and return a reply. For instance this can be done as, the handler bean could be implemented as follows:

    public String handleOrder(String payload) {
        ...
        return "Order: OK"
   }

...

Configuration of Mina endpoints is now possible using regular Spring bean style configuration in the Spring DSL.

However configuring , in the underlying Apache Mina itself is quite complex to setup the acceptor, connector as toolkit, it is relatively difficult to set up the acceptor and the connector, because you can not use simple setters. To resolve this difficulty, we will leverage the MinaComponent as a Spring factory bean to configure this for us. If you really need to configure this yourself, there are setters on the MinaEndpoint to set these when needed.

...

And then we can refer to our endpoint directly in the route such , as follows:

{snippet:id=e2|lang=xml|url=camel/trunk/components/camel-mina/src/test/resources/org/apache/camel/component/mina/SpringMinaEndpointTest-context.xml}

...

When acting as a server you sometimes want to close the session when e.g. , for example, a client conversion is finished. To instruct Camel to close the session, you should set add a header with the key CamelMinaCloseSessionWhenComplete set to a boolean true value.

For instance, the example below will close the session after it have has written the bye message back to the client:

...

Avaiable as of Camel 2.0

Filters permits 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 IoFitler, and the filters of type, IoFilter. Any filters you may define are appended at to the end of the FilterChainfilter chain; that is, then after codec and logger.

For instance, the example below will send a keep-alive message after 10 seconds of inactivity:

public class KeepAliveFilter extends IoFilterAdapter {
    @Override
    public void sessionCreated(NextFilter nextFilter, IoSession session)
            throws Exception {
        session.setIdleTime(IdleStatus.BOTH_IDLE, 10);

        nextFilter.sessionCreated(session);
    }

    @Override
    public void sessionIdle(NextFilter nextFilter, IoSession session,
            IdleStatus status) throws Exception {
        session.write("NOOP"); // NOOP is a FTP command for keep alive
        nextFilter.sessionIdle(session, status);
    }
}

As Camel Mina may ues use a request-reply scheme, the endpoint as a client would like to drop some message, such as greeting when the connection is established. For example, when you connect to an FTP server, you will get a 220 message with a greeting (220 Welcome to Pure-FTPd). If you don't drop the message, you your request-reply scheme will be broken.

...

Then, you can configure your endpoint . Using using Spring DSL:

<bean id="myMinaFactory" class="org.apache.camel.component.mina.MinaComponent">
    <constructor-arg index="0" ref="camelContext" />
</bean>
    
<bean id="myMinaEndpoint"
      factory-bean="myMinaFactory"
      factory-method="createEndpoint">
    <constructor-arg index="0" ref="myMinaConfig"/>
</bean>

<bean id="myMinaConfig" class="org.apache.camel.component.mina.MinaConfiguration">
    <property name="protocol" value="tcp" />
    <property name="host" value="localhost" />
    <property name="port" value="2121" />
    <property name="sync" value="true" />
    <property name="minaLogger" value="true" />
    <property name="filters" ref="listFilters"/>
</bean>

<bean id="listFilters" class="java.util.ArrayList" >
    <constructor-arg>
        <list value-type="org.apache.mina.common.IoFilter">
            <bean class="com.example.KeepAliveFilter"/>
            <bean class="com.example.DropGreetingFilter"/>
        </list>
    </constructor-arg>
</bean>

...