Apache MINA

https://mina.apache.org/mina-project/
Admin
Apache MINA is a network application framework that helps users easily develop high-performance and...
Tokens:50,075
Snippets:783
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Running the MINA Time Server Example

Source: https://mina.apache.org/mina-project/userguide/ch1-getting-started/ch1.4-first-steps.html

Execute the MINA Time Server example from the command line. Ensure all required JARs are in your classpath.

```bash
$ java org.apache.mina.example.gettingstarted.timeserver.MinaTimeServer

```

--------------------------------

### Tape Deck Server Example Session

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

An example interaction session with the tape deck server, demonstrating commands and responses.

```text
telnet localhost 12345
S: + Greetings from your tape deck!
C: list
S: + (1: "The Knife - Silent Shout", 2: "Kings of convenience - Riot on an empty street")
C: load 1
S: + "The Knife - Silent Shout" loaded
C: play
S: + Playing "The Knife - Silent Shout"
C: pause
S: + "The Knife - Silent Shout" paused
C: play
S: + Playing "The Knife - Silent Shout"
C: info
S: + Tape deck is playing. Current tape: "The Knife - Silent Shout"
C: eject
S: - Cannot eject while playing
C: stop
S: + "The Knife - Silent Shout" stopped
C: eject
S: + "The Knife - Silent Shout" ejected
C: quit
S: + Bye! Please come back!
```

--------------------------------

### Example GPG Key Listing Output

Source: https://mina.apache.org/mina-project/developer-guide.html

This is an example of the output you might see when listing GPG keys, showing different key types and IDs.

```text
localhost:target elecharny$ gpg --list-keys
/Users/elecharny/.gnupg/pubring.gpg
-----------------------------------
pub   dsa2048 2009-12-03 [SCA]
  C62BFD988278310B5B7A43D16FC4BEA60A8A0BBA
uid           [ultimate] Emmanuel Lecharny <elecharny@nextury.com>
sub   elg2048 2009-12-03 [E]

pub   rsa4096 2010-09-13 [SC]
  4D2DB2916149BAA9D0C92F3731474E5E7C6B7034
uid           [ultimate] Emmanuel Lecharny (CODE SIGNING KEY) <elecharny@apache.org>
sub   rsa4096 2010-09-13 [E]

...
```

--------------------------------

### MINA Time Server Setup and Binding

Source: https://mina.apache.org/mina-project/quick-start-guide.html

Initializes the MINA acceptor, configures filters, sets the handler, and binds the server to a specific port. This code starts the server and makes it listen for incoming connections.

```java
import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.charset.Charset;

import org.apache.mina.core.service.IoAcceptor;
import org.apache.mina.core.session.IdleStatus;
import org.apache.mina.filter.codec.ProtocolCodecFilter;
import org.apache.mina.filter.codec.textline.TextLineCodecFactory;
import org.apache.mina.filter.logging.LoggingFilter;
import org.apache.mina.transport.socket.nio.NioSocketAcceptor;

public class MinaTimeServer
{
    private static final int PORT = 9123;

    public static void main( String[] args ) throws IOException
    {
        IoAcceptor acceptor = new NioSocketAcceptor();

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

        acceptor.setHandler( new TimeServerHandler() );
    acceptor.getSessionConfig().setReadBufferSize( 2048 );
        acceptor.getSessionConfig().setIdleTime( IdleStatus.BOTH_IDLE, 10 );
        acceptor.bind( new InetSocketAddress(PORT) );
    }
}

```

--------------------------------

### Check Maven and Java Installation

Source: https://mina.apache.org/mina-project/developer-guide.html

Verify that the 'mvn' and 'java' commands are accessible in your system's PATH. This is a prerequisite for using Maven commands.

```bash
$ type mvn
mvn is hashed (/opt/maven-3.8.5/bin/mvn)
$ type java
java is hashed (/usr/bin/java)


```

--------------------------------

### Start Imagine Server (Java 5 or earlier)

Source: https://mina.apache.org/mina-project/userguide/ch16-jmx-support/ch16-jmx-support.html

Launches the Imagine Server application with JMX remote monitoring enabled. Ensure the CLASSPATH includes necessary MINA libraries.

```bash
java -Dcom.sun.management.jmxremote -classpath <CLASSPATH> org.apache.mina.example.imagine.step3.server.ImageServer
```

--------------------------------

### Opening a Session and Getting the Session Object

Source: https://mina.apache.org/mina-project/userguide/ch4-session/ch4-session.html

Demonstrates how to establish a connection and retrieve the session object after the connection is confirmed. Use this when you need to explicitly check connection status before proceeding.

```java
ConnectFuture connectionFuture = connector.connect(address);
connectionFuture.awaitUninterruptibly();

if (!connectionFuture.isConnected()) {
    return false;
}

session = connectionFuture.getSession();
...
```

--------------------------------

### Create an UDP Server Acceptor

Source: https://mina.apache.org/mina-project/userguide/ch3-service/ch3.3-acceptor.html

Demonstrates how to create a NioDatagramAcceptor for UDP communication by replacing the acceptor instantiation line from the TCP example.

```java
// Create an UDP acceptor
IoAcceptor acceptor = new NioDatagramAcceptor();

```

--------------------------------

### Full Sample TCP Client Implementation

Source: https://mina.apache.org/mina-project/userguide/ch2-basics/ch2.3-sample-tcp-client.html

This code demonstrates the complete setup and connection logic for a TCP client. It includes connector initialization, filter chain configuration, and the connection loop with error handling. Use this as a reference for building your own clients.

```java
public static void main(String[] args) throws Throwable {
    NioSocketConnector connector = new NioSocketConnector();
    connector.setConnectTimeoutMillis(CONNECT_TIMEOUT);

    if (USE_CUSTOM_CODEC) {
       connector.getFilterChain().addLast("codec",
        new ProtocolCodecFilter(new SumUpProtocolCodecFactory(false)));
    } else {
        connector.getFilterChain().addLast("codec",
            new ProtocolCodecFilter(new ObjectSerializationCodecFactory()));
    }
    
    connector.getFilterChain().addLast("logger", new LoggingFilter());
    connector.setHandler(new ClientSessionHandler(values));
    IoSession session;
    
    for (;;) {
        try {
            ConnectFuture future = connector.connect(new InetSocketAddress(HOSTNAME, PORT));
            future.awaitUninterruptibly();
            session = future.getSession();
            break;
        } catch (RuntimeIoException e) {
            System.err.println("Failed to connect.");
            e.printStackTrace();
            Thread.sleep(5000);
        }
    }
        
    // wait until the summation is done
    session.getCloseFuture().awaitUninterruptibly();
    connector.dispose();
}

```

--------------------------------

### Example @Transition Annotation

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

Illustrates the @Transition annotation used to define a specific state transition triggered by an event.

```java
@Transition(on = "load", in = EMPTY, next = LOADED)
public void loadTape(String nameOfTape) {
```

--------------------------------

### Java Class Header Example

Source: https://mina.apache.org/mina-project/developer-guide.html

Standard Java class header format including a description and author tag.

```java
/** 
 * Class desciption here.
 *
 * @author <a href="https://mina.apache.org">Apache MINA Project</a>
 */

```

--------------------------------

### Image Server Setup with ProtocolCodecFilter

Source: https://mina.apache.org/mina-project/userguide/ch9-codec-filter/ch9-codec-filter.html

Configures an NioSocketAcceptor with a ProtocolCodecFilter using the ImageCodecFactory. This sets up the server to handle image data communication.

```java
public class ImageServer {
    public static final int PORT = 33789;
    
    public static void main(String[] args) throws IOException {
        ImageServerIoHandler handler = new ImageServerIoHandler();
        NioSocketAcceptor acceptor = new NioSocketAcceptor();
        acceptor.getFilterChain().addLast("protocol", new ProtocolCodecFilter(new ImageCodecFactory(false)));
        acceptor.setLocalAddress(new InetSocketAddress(PORT));
        acceptor.setHandler(handler);
        acceptor.bind();
        System.out.println("server is listenig at port " + PORT);
    }
}
```

--------------------------------

### Start JConsole

Source: https://mina.apache.org/mina-project/userguide/ch16-jmx-support/ch16-jmx-support.html

Launches the JConsole tool, a graphical management console for JMX, allowing you to connect to and monitor your JMX-enabled Java applications.

```bash
<JDK_HOME>/bin/jconsole
```

--------------------------------

### Start Imagine Server (Java 6+)

Source: https://mina.apache.org/mina-project/userguide/ch16-jmx-support/ch16-jmx-support.html

Launches the Imagine Server application. For Java 6 and later, remote JMX is often enabled by default or configured differently, so the explicit -Dcom.sun.management.jmxremote flag might not be needed.

```bash
java  -classpath <CLASSPATH> }}{{{}org.apache.mina.example.imagine.step3.server.ImageServer
```

--------------------------------

### Build MINA Project

Source: https://mina.apache.org/mina-project/developer-guide.html

Compile and install the Apache MINA project using Maven. The '-Pserial' profile is often used for specific build configurations.

```bash
$ mvn clean install -Pserial

```

--------------------------------

### Image Client Setup with ProtocolCodecFilter

Source: https://mina.apache.org/mina-project/userguide/ch9-codec-filter/ch9-codec-filter.html

Initializes a SocketConnector and adds a ProtocolCodecFilter with the ImageCodecFactory for client-side communication. The messageReceived method handles incoming image responses.

```java
public class ImageClient extends IoHandlerAdapter {
    public static final int CONNECT_TIMEOUT = 3000;
    
    private String host;
    private int port;
    private SocketConnector connector;
    private IoSession session;
    private ImageListener imageListener;
    
    public ImageClient(String host, int port, ImageListener imageListener) {
        this.host = host;
        this.port = port;
        this.imageListener = imageListener;
        connector = new NioSocketConnector();
        connector.getFilterChain().addLast("codec", new ProtocolCodecFilter(new ImageCodecFactory(true)));
        connector.setHandler(this);
    }
    
    public void messageReceived(IoSession session, Object message) throws Exception {
        ImageResponse response = (ImageResponse) message;
        imageListener.onImages(response.getImage1(), response.getImage2());
    }
    ...
```

--------------------------------

### Opening a Session in a Shortened Way

Source: https://mina.apache.org/mina-project/userguide/ch4-session/ch4-session.html

A more concise method to connect to a server and immediately get the session object. Suitable for scenarios where immediate session access is desired without explicit connection checks.

```java
session = connector.connect(address).getSession();
...
```

--------------------------------

### Expected Output of State Machine Execution

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

This is the expected console output when the state machine example code is executed, showing the sequence of actions and their results.

```text
Tape 'The Knife - Silent Shout' loaded
Playing tape
Tape paused
Playing tape
Tape stopped
Tape ejected


```

--------------------------------

### MINA Time Server Implementation

Source: https://mina.apache.org/mina-project/userguide/ch2-basics/ch2.2-sample-tcp-server.html

Sets up and starts a TCP server using Apache MINA. It configures logging, text line encoding, and binds the server to a specific port.

```java
import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.charset.Charset;

import org.apache.mina.core.service.IoAcceptor;
import org.apache.mina.core.session.IdleStatus;
import org.apache.mina.filter.codec.ProtocolCodecFilter;
import org.apache.mina.filter.codec.textline.TextLineCodecFactory;
import org.apache.mina.filter.logging.LoggingFilter;
import org.apache.mina.transport.socket.nio.NioSocketAcceptor;

public class MinaTimeServer
{
    private static final int PORT = 9123;
    public static void main( String[] args ) throws IOException
    {
        IoAcceptor acceptor = new NioSocketAcceptor();
        acceptor.getFilterChain().addLast( "logger", new LoggingFilter() );
        acceptor.getFilterChain().addLast( "codec", new ProtocolCodecFilter( new TextLineCodecFactory( Charset.forName( "UTF-8" ))));
        acceptor.setHandler( new TimeServerHandler() );
        acceptor.getSessionConfig().setReadBufferSize( 2048 );
        acceptor.getSessionConfig().setIdleTime( IdleStatus.BOTH_IDLE, 10 );
        acceptor.bind( new InetSocketAddress(PORT) );
    }
}

```

--------------------------------

### Get JMX MBean Server

Source: https://mina.apache.org/mina-project/userguide/ch16-jmx-support/ch16-jmx-support.html

Retrieves the platform's MBean server instance, which is necessary for registering and managing MBeans.

```java
MBeanServer mBeanServer = ManagementFactory.getPlatformMBeanServer();
```

--------------------------------

### Main Method for MINA 1.0/1.1

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

Sets up a SocketAcceptor for MINA 1.0/1.1, configures the codec filter, and binds to a specific port with the created IoHandler.

```java
// This code will work with MINA 1.0/1.1:
public static void main(String[] args) throws Exception {
    SocketAcceptor acceptor = new SocketAcceptor();
    SocketAcceptorConfig config = new SocketAcceptorConfig();
    config.setReuseAddress(true);
    ProtocolCodecFilter pcf = new ProtocolCodecFilter(
            new TextLineEncoder(), new CommandDecoder());
    config.getFilterChain().addLast("codec", pcf);
    acceptor.bind(new InetSocketAddress(12345), createIoHandler(), config);
}
```

--------------------------------

### Build Apache MINA Project Site

Source: https://mina.apache.org/mina-project/developer-guide.html

Navigate to the checkout directory and run the Maven site command to generate the project's website. The site will be created in the target/checkout/target directory.

```bash
cd target/checkout
mvn -Pserial site
```

--------------------------------

### Demonstrate IoBuffer Auto Shrinking and Manual Shrink

Source: https://mina.apache.org/mina-project/userguide/ch8-iobuffer/ch8-iobuffer.html

This snippet demonstrates how to allocate an IoBuffer, enable auto-shrinking, and use the `shrink()` and `capacity()` methods to manage buffer capacity. It shows the effect of manual shrinking and capacity changes on the buffer's allocated size.

```java
IoBuffer buffer = IoBuffer.allocate(16);
buffer.setAutoShrink(true);
buffer.put((byte)1);
System.out.println("Initial Buffer capacity = "+buffer.capacity());

buffer.shrink();
System.out.println("Initial Buffer capacity after shrink = "+buffer.capacity());

buffer.capacity(32);
System.out.println("Buffer capacity after incrementing capacity to 32 = "+buffer.capacity());

buffer.shrink();
System.out.println("Buffer capacity after shrink= "+buffer.capacity());

```

--------------------------------

### Load Tape Transition with IoHandler

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

Handles the 'load' command when the tape deck is in the EMPTY state, transitioning to LOADED.

```java
@IoHandlerTransition(on = MESSAGE_RECEIVED, in = EMPTY, next = LOADED)
public void loadTape(TapeDeckContext context, IoSession session, LoadCommand cmd) {
    if (cmd.getTapeNumber() < 1 || cmd.getTapeNumber() > tapes.length) {
        session.write("- Unknown tape number: " + cmd.getTapeNumber());
        StateControl.breakAndGotoNext(EMPTY);
    } else {
        context.tapeName = tapes[cmd.getTapeNumber() - 1];
        session.write("+ \"" + context.tapeName + "\" loaded");
    }
}
```

--------------------------------

### Checkout MINA 2.0.X Version Trunk (Shorthand)

Source: https://mina.apache.org/mina-project/developer-guide.html

Clones the MINA repository and checks out the 2.0.X branch in a single command. This is a convenient shortcut.

```bash
$ git clone -b 2.0.X https://gitbox.apache.org/repos/asf/mina.git mina
$ cd mina

```

--------------------------------

### Configure Session and Bind Address

Source: https://mina.apache.org/mina-project/userguide/ch2-basics/ch2.4-sample-udp-server.html

Enables address reuse for the UDP session configuration and binds the acceptor to a specific port to start listening for incoming connections.

```java
DatagramSessionConfig dcfg = acceptor.getSessionConfig();
dcfg.setReuseAddress(true);
acceptor.bind(new InetSocketAddress(PORT));
```

--------------------------------

### StartTLS Use Case Flow

Source: https://mina.apache.org/mina-project/userguide/ch5-filters/ch5.19-ssl-filter.html

Illustrates the sequence of events for the StartTLS command, where TLS is initiated on an existing connection. This flow highlights the need for blocking message exchange during TLS establishment.

```text
(C) The client sends a **StartTLS** command
(S) The server receives the command, initialize the **TLS** layer, and send back a response to the client, bypassing the **TLS** layer.
(C) The client received the server response to the command, and setup the **TLS** layer, and initiates the **TLS** _Handshake_
(S/C) The _Handshake_ is processed
(S/C) The session is secured on both side
(S/C) at this point, every message exchanged are encrypted.
```

--------------------------------

### Maven Release Clean and Prepare

Source: https://mina.apache.org/mina-project/developer-guide.html

Clean up temporary files from a previous dry run and then execute the actual release preparation. This involves copying to the tags directory and preparing for the next development iteration.

```bash
$ mvn -Pserial,apache-release release:clean      # Clean up the temporary files created by the dry-run.
$ mvn -Pserial,apache-release release:prepare    # Copy to tags directory.

```

--------------------------------

### Invalid Method Transitions for 'messageReceived' Event

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

Examples of methods that do not match the 'messageReceived' event due to incorrect argument ordering, type mismatches, or incorrect placement of Event/StateContext.

```java
// Incorrect ordering
@Transition(on = "messageReceived")
public void messageReceived(Integer i, List l) { ... }
```

```java
// ((a instanceof LinkedList) == false)
@Transition(on = "messageReceived")
public void messageReceived(LinkedList l, Number n) { ... }
```

```java
// Event must be first argument
@Transition(on = "messageReceived")
public void messageReceived(ArrayList l, Event event) { ... }
```

```java
// StateContext must be second argument if Event is used
@Transition(on = "messageReceived")
public void messageReceived(Event event, ArrayList l, StateContext context) { ... }
```

```java
// Event must come before StateContext
@Transition(on = "messageReceived")
public void messageReceived(StateContext context, Event event) { ... }
```

--------------------------------

### Reconnect to Server After Session Closure

Source: https://mina.apache.org/mina-project/faq.html

Provides an example of how to implement sessionClosed to automatically reconnect to the server after a delay. It's recommended to extract this logic into a reusable 'reconnect()' method.

```java
public void sessionClosed( IoSession session ) throws Exception {
    // Wait for five seconds before reconnecting.
    Thread.sleep( 5000 );

    // Reconnect.
    connector.connect( session.getRemoteAddress(), this );
}

```

--------------------------------

### Main Method for MINA Trunk

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

Sets up a NioSocketAcceptor for MINA trunk, configures the codec filter, and binds to a local address with the created IoHandler.

```java
// This code will work with MINA trunk:
public static void main(String[] args) throws Exception {
    SocketAcceptor acceptor = new NioSocketAcceptor();
    acceptor.setReuseAddress(true);
    ProtocolCodecFilter pcf = new ProtocolCodecFilter(
            new TextLineEncoder(), new CommandDecoder());
    acceptor.getFilterChain().addLast("codec", pcf);
    acceptor.setHandler(createIoHandler());
    acceptor.setLocalAddress(new InetSocketAddress(PORT));
    acceptor.bind();
}
```

--------------------------------

### Clone Repository and Deploy Artifacts with Maven

Source: https://mina.apache.org/mina-project/developer-guide.html

Clones the Apache MINA repository and deploys artifacts using Maven. Ensure the 'clean' goal is run first.

```bash
$ git clone https://gitbox.apache.org/repos/asf/mina.git mina
$ cd mina
$ mvn -Pserial clean deploy site site:deploy    # Make sure to run 'clean' goal first to prevent side effects from your IDE.

```

--------------------------------

### Method Transition with Event and StateContext

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

Methods can accept Event and StateContext as the first two arguments, respectively, in addition to event arguments. Type compatibility rules still apply.

```java
@Transition(on = "foo")
public void someMethod(Event event, StateContext context, One one, Two two, Three three) { ... }
```

```java
@Transition(on = "foo")
public void someMethod(Event event, One one, Two two, Three three) { ... }
```

```java
@Transition(on = "foo")
public void someMethod(StateContext context, One one, Two two, Three three) { ... }
```

--------------------------------

### Perform Apache MINA Release

Source: https://mina.apache.org/mina-project/developer-guide.html

Execute the Maven command to perform a release, pushing artifacts to Nexus. Ensure a clean install with tests skipped and the serial profile activated.

```bash
$ mvn clean install -Pserial -DskipTests
```

```bash
$ mvn -Pserial,apache-release release:perform
```

--------------------------------

### Play Tape Transition with IoHandler

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

Handles the 'play' command when the tape deck is in the LOADED or PAUSED state, transitioning to PLAYING.

```java
@IoHandlerTransitions({
    @IoHandlerTransition(on = MESSAGE_RECEIVED, in = LOADED, next = PLAYING),
    @IoHandlerTransition(on = MESSAGE_RECEIVED, in = PAUSED, next = PLAYING)
})
public void playTape(TapeDeckContext context, IoSession session, PlayCommand cmd) {
    session.write("+ Playing \"" + context.tapeName + "\"");
}
```

--------------------------------

### Tape Deck Example: Unhandled Event Exception

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

Demonstrates a scenario where calling an event ('play') in the 'Empty' state of a Tape Deck results in an UnhandledEventException because no transition is defined for that event in that state.

```java
public static void main(String[] args) {
    ...
    deck.load("The Knife - Silent Shout");
    deck.play();
    deck.pause();
    deck.play();
    deck.stop();
    deck.eject();
    deck.play();
}

...
Tape stopped
Tape ejected
Exception in thread "main" o.a.m.sm.event.UnhandledEventException: 
Unhandled event: org.apache.mina.statemachine.event.Event@15eb0a9[id=play,...]
    at org.apache.mina.statemachine.StateMachine.handle(StateMachine.java:285)
    at org.apache.mina.statemachine.StateMachine.processEvents(StateMachine.java:142)
    ...

```

--------------------------------

### Valid Method Transitions for 'messageReceived' Event

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

Examples of methods that correctly match an event with ID 'messageReceived' and arguments [ArrayList, Integer]. Demonstrates direct, subset, and argument type matching.

```java
// All method arguments matches all event arguments directly
@Transition(on = "messageReceived")
public void messageReceived(ArrayList l, Integer i) { ... }
```

```java
// Matches since ((a instanceof List && b instanceof Number) == true)
@Transition(on = "messageReceived")
public void messageReceived(List l, Number n) { ... }
```

```java
// Matches since ((b instanceof Number) == true)
@Transition(on = "messageReceived")
public void messageReceived(Number n) { ... }
```

```java
// Methods with no arguments always matches
@Transition(on = "messageReceived")
public void messageReceived() { ... }
```

```java
// Methods only interested in the current Event or StateContext always matches
@Transition(on = "messageReceived")
public void messageReceived(StateContext context) { ... }
```

```java
// Matches since ((a instanceof Collection) == true)
@Transition(on = "messageReceived")
public void messageReceived(Event event, Collection c) { ... }
```

--------------------------------

### Initializing Session Attribute Map

Source: https://mina.apache.org/mina-project/userguide/ch4-session/ch4-session.html

This code shows how the attribute map for a session is initialized during session setup, using a factory to provide the map implementation. This is part of the session initialization process.

```java
protected final void initSession(IoSession session,
        IoFuture future, IoSessionInitializer sessionInitializer) {
    ...
    try {
        ((AbstractIoSession) session).setAttributeMap(session.getService()
                .getSessionDataStructureFactory().getAttributeMap(session));
    } catch (IoSessionInitializationException e) {
        throw e;
    } catch (Exception e) {
        throw new IoSessionInitializationException(
                "Failed to initialize an attributeMap.", e);
    }
    ...

}
```

--------------------------------

### Transform String to ByteBuffer in filterWrite

Source: https://mina.apache.org/mina-project/userguide/ch5-filters/ch5-filters.html

This example demonstrates transforming a String into a custom ByteBuffer (MyByteBuffer) in the filterWrite method. It wraps the String's bytes and stores the original String for later retrieval.

```java
public void filterWrite(NextFilter nextFilter, IoSession session, WriteRequest request) {
    String m = (String) request.getMessage();
    ByteBuffer newBuffer = new MyByteBuffer(m, ByteBuffer.wrap(m.getBytes()));
    
    nextFilter.filterWrite(
            session, new WriteRequest(newBuffer, request.getFuture(), request.getDestination()));
}
```

--------------------------------

### Initialize SSLContext

Source: https://mina.apache.org/mina-project/userguide/ch11-ssl-filter/ch11-ssl-filter.html

Initializes an SSLContext for establishing SSL sessions. Provide KeyManager, TrustManager, and SecureRandom instances as needed. If parameters are null, the security provider selects the highest priority implementation.

```java
SSLContext sslContext;

try
{
    // Initialize the SSLContext to work with our key managers.
    sslContext = SSLContext.getInstance( "TLS" );
    sslContext.init( ... ); // Provide the needed KeyManager[], TrustManager[] and SecureRandom instances
}
catch ( Exception e )
{
    // Handle your exception
}

```

--------------------------------

### Copy Packages to Distribution Directory

Source: https://mina.apache.org/mina-project/developer-guide.html

Copy the generated binary and source packages, along with their signatures, to the newly created version-specific directory in the distribution repository.

```bash
$ cd target/checkout/distributions/target
$ cp apache-mina-2.0.14-* ~/mina/dist/dev/mina/mina/2.0.14/
```

--------------------------------

### Create Version Sub-directory

Source: https://mina.apache.org/mina-project/developer-guide.html

Create a new directory within the distribution repository to hold the packages for a specific version of the project.

```bash
$ mkdir ~/mina/dist/dev/mina/mina/2.0.14
```

--------------------------------

### Creating StateMachine Instance

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

Instantiates a StateMachine using the StateMachineFactory, specifying the annotation class and the initial state. The Transition.class argument indicates that @Transition annotations are used.

```java
StateMachine sm = StateMachineFactory.getInstance(Transition.class).create(TapeDeckHandler.EMPTY, handler);

```

--------------------------------

### Checkout Apache Distribution Repository

Source: https://mina.apache.org/mina-project/developer-guide.html

This command checks out the Apache distribution repository, which is used for publishing release artifacts. You can checkout the entire repository or a specific sub-directory.

```bash
$ svn co https://dist.apache.org/repos/dist/dev/mina ~/mina/dist/dev/mina
```

```bash
$ svn co https://dist.apache.org/repos/dist/dev/mina/mina ~/mina/dist/dev/mina/mina
```

--------------------------------

### Initialize UDP Client Connector

Source: https://mina.apache.org/mina-project/userguide/ch2-basics/ch2.5-sample-udp-client.html

Creates a NioDatagramConnector, sets the IoHandler, and initiates a connection to the UDP server. Ensure the host is correctly set in the InetSocketAddress.

```java
connector = new NioDatagramConnector();
connector.setHandler( this );
ConnectFuture connFuture = connector.connect( new InetSocketAddress("localhost", MemoryMonitor.PORT ));
```

--------------------------------

### Building StateMachine Proxy

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

Creates a proxy object that implements the TapeDeck interface, delegating method calls to the provided StateMachine instance. This allows for state-aware interactions.

```java
TapeDeck deck = new StateMachineProxyBuilder().create(TapeDeck.class, sm);

```

--------------------------------

### Checkout Specific Branch (e.g., 2.0.X)

Source: https://mina.apache.org/mina-project/sources.html

After cloning the repository, use this command to checkout a specific branch, such as the 2.0.X branch, and create a local branch for it. This is useful for working on older versions.

```bash
git checkout -b 2.0.X 2.0.X
```

--------------------------------

### Initialize SSLContext

Source: https://mina.apache.org/mina-project/userguide/ch11-ssl-filter/ch11-ssl-filter.html

Create an SSLContext instance required for the SslFilter. This involves setting the protocol and providing necessary KeyManager, TrustManager, and SecureRandom instances.

```java
SSLContext sslContext;

    try
    {
        // Initialize the SSLContext to work with our key managers.
        sslContext = SSLContext.getInstance( "TLS" );
        sslContext.init( ... ); // Provide the needed KeyManager[], TrustManager[] and SecureRandom instances
    }
    catch ( Exception e )
    {
        // Handle your exception
    }


```

--------------------------------

### Configure CompressionFilter with Max Decompressed Size and Ratio

Source: https://mina.apache.org/mina-project

This constructor allows setting limits on both decompressed size and compression ratio, providing more granular control over data inflation. It also includes a minimum size for ratio checks to avoid false positives.

```java
public CompressionFilter(
        final boolean compressInbound, 
        final boolean compressOutbound,
        final int compressionLevel, 
        final int maxDecompressedSize,
        final long maxDecompressRatio, 
        final long decompressRatioMinSize)
```

--------------------------------

### Verify PGP Signatures with PGP/GPG

Source: https://mina.apache.org/mina-project/downloads_2_2.html

Commands to verify the PGP signatures of downloaded MINA distribution files using PGP or GPG.

```bash
$ pgpk -a KEYS
$ pgpv mina-2.2.9.tar.gz.asc
```

```bash
$ pgp -ka KEYS
$ pgp mina-2.2.9.tar.gz.asc
```

```bash
$ gpg --import KEYS
$ gpg --verify mina-2.2.9.tar.gz.asc
```

--------------------------------

### Check License Headers

Source: https://mina.apache.org/mina-project/developer-guide.html

Ensure all project files have the correct Apache license headers using the 'apache-rat:check' Maven goal. This is crucial for compliance.

```bash
$ mvn apache-rat:check -Pserial

```

--------------------------------

### Sign Packages with Shell Script

Source: https://mina.apache.org/mina-project/developer-guide.html

This script automates the signing of binary packages using your PGP key. It prompts for the key ID and passphrase, generates SHA-512 checksums, and creates detached ASCII-armored signatures (.asc files).

```bash
#!/bin/sh

echo "PGP Key ID: "
read DEFAULT_KEY

echo "PGP Key Password: "
stty -echo
read PASSWORD
stty echo
echo ""

for FILE in $(find . -maxdepth 1 -not '(' -name "sign.sh" -or -name ".*" -or -name "*.sha256" -or -name "*.sha512" -or -name "*.asc" ')' -and -type f) ;
do
  if [ -f "$FILE.asc" ]; then
      echo "Skipping: $FILE"
      continue
  fi

  echo -n "Signing: $FILE ... "

  # SHA-512
  if [ ! -f "$FILE.sha512" ];
  then
      gpg -v --default-key "$DEFAULT_KEY" --print-md SHA512 "$FILE" > "$FILE".sha512
      echo "  - Generated '$FILE.sha512'"
  else
      echo "  - Skipped '$FILE.sha512' (file already existing)"
  fi

  # ASC
  if [ ! -f "$FILE.asc" ];
  then
      echo "$PASSWORD" | gpg --default-key "$DEFAULT_KEY" --detach-sign --armor --no-tty --yes --passphrase-fd 0 "$FILE"
      echo "  - Generated '$FILE.asc'"
  else
      echo "  - Skipped '$FILE.asc' (file already existing)"
  fi
done

```

--------------------------------

### List GPG Public Keys

Source: https://mina.apache.org/mina-project/developer-guide.html

Use this command to list your available GPG public keys, which is necessary for identifying the correct key ID for signing.

```bash
gpg --list-keys
```

--------------------------------

### Connecting to the MINA Time Server

Source: https://mina.apache.org/mina-project/userguide/ch1-getting-started/ch1.4-first-steps.html

Use telnet to connect to the running MINA Time Server on the default port to test its functionality.

```bash
telnet 127.0.0.1 9123

```

--------------------------------

### Configure NioSocketAcceptor for MINA Time Server

Source: https://mina.apache.org/mina-project/userguide/ch2-basics/ch2.2-sample-tcp-server.html

Sets up the acceptor with logging, text line codec, session handler, buffer size, and idle time. Binds the server to a specific port.

```java
import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.charset.Charset;

import org.apache.mina.core.session.IdleStatus;
import org.apache.mina.core.service.IoAcceptor;
import org.apache.mina.filter.codec.ProtocolCodecFilter;
import org.apache.mina.filter.codec.textline.TextLineCodecFactory;
import org.apache.mina.filter.logging.LoggingFilter;
import org.apache.mina.transport.socket.nio.NioSocketAcceptor;

public class MinaTimeServer
{
    private static final int PORT = 8080;
    public static void main( String[] args ) throws IOException
    {
        IoAcceptor acceptor = new NioSocketAcceptor();
        acceptor.getFilterChain().addLast( "logger", new LoggingFilter() );
        acceptor.getFilterChain().addLast( "codec", new ProtocolCodecFilter( new TextLineCodecFactory( Charset.forName( "UTF-8" ))));
        acceptor.setHandler(  new TimeServerHandler() );
        acceptor.getSessionConfig().setReadBufferSize( 2048 );
        acceptor.getSessionConfig().setIdleTime( IdleStatus.BOTH_IDLE, 10 );
        acceptor.bind( new InetSocketAddress(PORT) );
    }
}

```

--------------------------------

### Creating and Using a State Machine Proxy

Source: https://mina.apache.org/mina-project/userguide/ch14-state-machine/ch14-state-machine.html

This snippet shows how to create a StateMachine instance from an annotated handler class and build a proxy object that implements a given interface. The proxy allows interaction with the state machine through method calls.

```java
public static void main(String[] args) {
    TapeDeckHandler handler = new TapeDeckHandler();
    StateMachine sm = StateMachineFactory.getInstance(Transition.class).create(TapeDeckHandler.EMPTY, handler);
    TapeDeck deck = new StateMachineProxyBuilder().create(TapeDeck.class, sm);

    deck.load("The Knife - Silent Shout");
    deck.play();
    deck.pause();
    deck.play();
    deck.stop();
    deck.eject();
}


```

--------------------------------

### Basic MinaTimeServer Class Structure

Source: https://mina.apache.org/mina-project/userguide/ch2-basics/ch2.2-sample-tcp-server.html

Initializes the main class for the MINA time server. The main method serves as the entry point for the application.

```java
public class MinaTimeServer {
    public static void main(String[] args) {
        // code will go here next
    }
}
```
Tokens:
Raw