Apache MINA - Quick Start Guide

http://mina.apache.org/quick-start-guide.html

Introduction

This tutorial will walk you through the process of building a MINA based program. This tutorial will walk through building a time server. The following prerequisites are required for this tutorial:

• MINA 1.1 Core
• JDK 1.5 or greater
• SLF4J 1.3.0 or greater
  • Log4J 1.2 users: slf4j-api.jar, slf4j-log4j12.jar, andLog4J 1.2.x
  • Log4J 1.3 users: slf4j-api.jar, slf4j-log4j13.jar, andLog4J 1.3.x
  • java.util.logging users: slf4j-api.jar andslf4j-jdk14.jar
  • IMPORTANT: Please make sure you are using the right slf4j-*.jar that matches to your logging framework.\
    For instance, slf4j-log4j12.jar and log4j-1.3.x.jar can not be used together, and will malfunction.

I have tested this program on both Windows© 2000 professional and linux. If you have any problems getting this program to work, please do not hesitate tocontact us in order to talk to the MINA developers. Also, this tutorial has tried to remain independent of development environments (IDE, editors..etc). This tutorial will work with any environment that you are comfortable with. Compilation commands and steps to execute the program have been removed for brevity. If you need help learning how to either compile of execute java programs, please consult theJava tutorial.

Writing the MINA time server

We will begin by creating a file called MinaTimeServer.java. The initial code can be found below:

public class MinaTimeServer {

    public static void main(String[] args) {
    	// code will go here next
    }
}

This code should be straightforward to all. We are simply defining a main method that will be used to kick off the program. At this point, we will begin to add the code that will make up our server. First off, we need an object that will be used to listen for incoming connections. Since this program will be TCP/IP based, we will add aSocketAcceptor to our program.

import org.apache.mina.common.ByteBuffer;
import org.apache.mina.common.IoAcceptor;
import org.apache.mina.common.SimpleByteBufferAllocator;
import org.apache.mina.transport.socket.nio.SocketAcceptor;

public class MinaTimeServer {

    public static void main(String[] args) {
        // The following two lines change the default buffer type to 'heap',
        // which yields better performance.c
        ByteBuffer.setUseDirectBuffers(false);
        ByteBuffer.setAllocator(new SimpleByteBufferAllocator());

        IoAcceptor acceptor = new SocketAcceptor();
    }
}

With the SocketAcceptor class in place, we can go ahead and define the handler class and bind theSocketAcceptor to a port. If you are interested in adding a thread model to theSocketAcceptor, please read the Configuring Thread Model tutorial.
We will now add in the SocketAcceptor configuration. This will allow us to make socket-specific settings for the socket that will be used to accept connections from clients.

import java.io.IOException;
import java.nio.charset.Charset;
import org.apache.mina.common.ByteBuffer;
import org.apache.mina.common.IoAcceptor;
import org.apache.mina.common.SimpleByteBufferAllocator;
import org.apache.mina.filter.LoggingFilter;
import org.apache.mina.filter.codec.ProtocolCodecFilter;
import org.apache.mina.filter.codec.textline.TextLineCodecFactory;
import org.apache.mina.transport.socket.nio.SocketAcceptor;
import org.apache.mina.transport.socket.nio.SocketAcceptorConfig;

public class MinaTimeServer {

    private static final int PORT = 9123;

    public static void main(String[] args) throws IOException {
        ByteBuffer.setUseDirectBuffers(false);
        ByteBuffer.setAllocator(new SimpleByteBufferAllocator());

        IoAcceptor acceptor = new SocketAcceptor();

        SocketAcceptorConfig cfg = new SocketAcceptorConfig();
        cfg.getFilterChain().addLast( "logger", new LoggingFilter() );
        cfg.getFilterChain().addLast( "codec", new ProtocolCodecFilter( new TextLineCodecFactory( Charset.forName( "UTF-8" ))));
    }
}

Here was have created a new instance of the SocketAcceptorConfig class that will be used to pass in to the acceptor once we are ready to start up the acceptor. First, we have set the reuse address flag. See more information about this in theJDK Documentation. Next we add a filter to the configuration. This filter will log all information such as newly created sessions, messages received, messages sent, session closed. The next filter is aProtocolCodecFilter. This filter will translate binary or protocol specific data into message object and vice versa.

This last addition will bind the acceptor to the port. This method will signal the startup of the server process. Without this method call, the server will not service client connections.

import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.charset.Charset;
import org.apache.mina.common.ByteBuffer;
import org.apache.mina.common.IoAcceptor;
import org.apache.mina.common.SimpleByteBufferAllocator;
import org.apache.mina.filter.LoggingFilter;
import org.apache.mina.filter.codec.ProtocolCodecFilter;
import org.apache.mina.filter.codec.textline.TextLineCodecFactory;
import org.apache.mina.transport.socket.nio.SocketAcceptor;
import org.apache.mina.transport.socket.nio.SocketAcceptorConfig;

public class MinaTimeServer {

    private static final int PORT = 9123;

    public static void main(String[] args) throws IOException {
        ByteBuffer.setUseDirectBuffers(false);
        ByteBuffer.setAllocator(new SimpleByteBufferAllocator());

        IoAcceptor acceptor = new SocketAcceptor();

        SocketAcceptorConfig cfg = new SocketAcceptorConfig();
        cfg.getFilterChain().addLast( "logger", new LoggingFilter() );
        cfg.getFilterChain().addLast( "codec", new ProtocolCodecFilter( new TextLineCodecFactory( Charset.forName( "UTF-8" ))));

        acceptor.bind( new InetSocketAddress(PORT), new TimeServerHandler(), cfg);
        System.out.println("MINA Time server started.");
    }
}

What you see here is that we have defined a variable port of type integer and made a call to SocketAcceptor.bind(SocketAddress,IoHandler). The first parameter is theSocketAddress that describes the network address that will be listening on, in this case port 9123, and the local address.

The second parameter passed to the bind method is a class that must implement the interfaceIoHandler. For almost all programs that use MINA, this becomes the workhorse of the program, as it services all incoming requests from the clients. For this tutorial, we will extend the classIoHandlerAdapter. This is a class that follows the adapter design pattern which simplifies the amount of code that needs to be written in order to satisfy the requirement of passing in a class that implements theIoHandler interface.

The third parameter is the configuration object, cfg, which has been configured with a logger filter and a codec filter. MINA is set up such that each message that is received will be passed through any and all filters in the filter chain defined for theIoAcceptor. In this case, we will pass all messages through a logging filter and then a codec filter. The logging filter will simply log the message using the SL4J library, and the codec filter will decode each message received and encode each message sent using the supplied TextLineCodecFactory class.

Below is the class TimeServerHandler:

import java.util.Date;
import org.apache.mina.common.IdleStatus;
import org.apache.mina.common.IoHandlerAdapter;
import org.apache.mina.common.IoSession;
import org.apache.mina.common.TransportType;
import org.apache.mina.transport.socket.nio.SocketSessionConfig;

public class TimeServerHandler extends IoHandlerAdapter {
	public void exceptionCaught(IoSession session, Throwable t) throws Exception {
		t.printStackTrace();
		session.close();
	}

	public void messageReceived(IoSession session, Object msg) throws Exception {
		String str = msg.toString();
		if( str.trim().equalsIgnoreCase("quit") ) {
			session.close();
			return;
		}

		Date date = new Date();
		session.write( date.toString() );
		System.out.println("Message written...");
	}

	public void sessionCreated(IoSession session) throws Exception {
		System.out.println("Session created...");

		if( session.getTransportType() == TransportType.SOCKET )
			((SocketSessionConfig) session.getConfig() ).setReceiveBufferSize( 2048 );

        session.setIdleTime( IdleStatus.BOTH_IDLE, 10 );
	}
}

Here we have the code for the handler portion of the tutorial program. We have overridden the methods exceptionCaught, messageReceived and sessionCreated. As stated previously, this class extends theIoHandlerAdapter, which is a class that follows the Adapter design pattern.

The exceptionCaught method will simply print the stack trace of the error and close the session. For most programs, this will be standard practice unless the handler can recover from the exception condition.

The messageReceived method will receive the data from the client and write back to the client the current time. If the message received from the client is the word "quit", then the session will be closed. This method will also print out the current time to the client. Depending on the protocol codec that you use, the object (second parameter) that gets passed in to this method will be different, as well as the object that you pass in to the session.write(Object) method. If you do not specify a protocol codec, you will most likely receive a ByteBuffer object, and be required to write out aByteBuffer object.

The sessionCreated method is typically where your session initialization occurs. In this case, we print out that the method has been entered, and then test if the transport type of the sesion is socket based (versus UDP), and then set the receive buffer size. In the case above, the incoming buffer size is set to 2048 bytes. The idle time is also set to 10 seconds. If we were to override the sessionIdle method, the sessionIdle method would get called every 10 seconds.

Try out the Time server

At this point, we can go ahead and compile the program. Once you have compiled the program you can run the program in order to test out what happens. The easiest way to test the program is to start the program, and then telnet in to the program:

Client Output	Server Output
user@myhost:~> telnet 127.0.0.1 9123 Trying 127.0.0.1... Connected to 127.0.0.1. Escape character is '^]'. hello Mon Apr 09 23:42:55 EDT 2007 quit Connection closed by foreign host. user@myhost:~>	MINA Time server started. Session created... Message written...

Using MINA in restricted Java environnements

DIRMINA-659 issue rised the necessity of adding a special permission when running MINA framework in a restricted environnement like applets or Java Webstart technology. This happens when shutting down the thread pools (ExecutorService).

In order to get it to work properly, you will need to set the following permission :

permission java.lang.RuntimePermission "modifyThread"; 

Or you can also choose to sign your code.

What's Next?

Please visit our Documentation page to find out more resources. You can also keep reading other tutorials.