Building MINA

Please read the Developer Infrastructure Information if you haven't yet before you proceed.

Checking out the code

You need Git to check out the source code from our source code repository, and [Maven(http://maven.apache.org/) 2.2.1 to build the source code (Building with Maven 3.0 will also work). The following example shows how to build the current stable branch (2.0.7).

$ git clone http://git-wip-us.apache.org/repos/asf/mina.git mina
$ cd mina
$ mvn -Pserial clean install             # Build packages (JARs) for the core API and other 
                                         # extensions and install them to the local Maven repository.
$ mvn -Pserial site                      # Generate reports (JavaDoc and JXR)
$ mvn -Pserial package assembly:assembly # Generate a tarball (package goal needed to fix an assembly plugin bug)
$ mvn -Pserial eclipse:eclipse           # Generate Eclipse project files if you want

Eclipse users: Don't forget to declare a classpath variable named M2_REPO, pointing to ~/.m2/repository, otherwise many links to existing jars will be broken. You can declare new variables in Eclipse in Windows -> Preferences... and selecting Java -> Build Path -> Classpath Variables

There are also other branches that might interest you:

  • trunk: Where big changes take place everyday

If you want to check out the source code of previous releases, you have to select the branch you want to work on :

$ git clone http://git-wip-us.apache.org/repos/asf/mina.git mina $ git checkout

For instance, to work on the on-going 2.0 version trunk, just do :

$ git clone http://git-wip-us.apache.org/repos/asf/mina.git mina $ git checkout 2.0

Coding Convention

We follow Sun's standard Java coding convention except that we always use spaces instead of tabs. Please download the Eclipse Java formatter settings file before you make any changes to the code.

This file is also available in the /resources directory.

Class header

As class header we use :

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

The headers revisions tags are removed.

Working with Multiple Branches in One Eclipse Workspace

Just running mvn -Pserial eclipse:eclipse won't allow you to import MINA projects from more than one branches into one Eclipse workspace. You have to rename all project names in the generated .project and .classpath files to do that. Maven Eclipse plugin should provide an option that appends the version number to the project name, but this issue is not being resolved yet. Until this issue is resolved, please put the attached shell script files ((mvnroot) and (mvn-eclipse)) to your local path (e.g. /usr/local/bin) and run mvn-eclipse.

$ svn co https://svn.apache.org/repos/asf/mina mina
$ cd mina/tags/2.0.7
$ mvn-eclipse
$ cd ../2.0.5
$ mvn-eclipse
$ cd ../../trunk
$ mvn-eclipse

Then mvn eclipse:eclipse command is executed internally, and the branch name will be appended to all sub-module project files generated by Maven Eclipse plugin.

Working with Eclipse LUNA allows you to import the pom.xml directly into the workspace, instead of running mvn eclipse:eclipse, which is quite convenient. Although you still need to tweak your pom if you want to work with more than one version of MINA in your workspace.

Deploying Snapshots (Commiters Only)

Before running Maven to deploy artifacts, please make sure if your umask is configured correctly. Unless configured properly, other committers will experience annoying 'permission denied' errors. If your default shell is bash, please update your umask setting in the ~/.bashrc file (create one if it doesn't exist.) by adding the following line:

umask 002

Please note that you have to edit the correct shrc file. If you use csh, then you will have to edit ~/.cshrc file.

Now you are ready to deploy the artifacts if you configured your umask correctly.

$ svn co https://svn.apache.org/repos/asf/mina/tags/2.0.7 mina
$ cd mina
$ mvn -Pserial clean deploy site site:deploy    # Make sure to run 'clean' goal first to prevent side effects from your IDE.

Please double-check the mode (i.e. 0664 or -rw-rw-r--, a.k.a permission code) of the deployed artifacts, otherwise you can waste other people's time significantly.

Releasing a Point Release (Committers Only)

Preparing the release for the vote

Before starting be sure to have the java and mvn command in your PATH. On linux you can check with the following commands :

$ type mvn
mvn is hashed (/opt/maven-2.2.1/bin/mvn)
$ type java
java is hashed (/usr/bin/java)

Step 0: Building MINA

As weird as it sounds, for some unknown reason (most certainly a misconfiguration in the Maven poms), we can't just run the release without having previously build all the projects. This is done with the following command :

$ mvn clean install -Pserial

Step 1: Tagging and Deploying

First you need to configure maven for using the good username for scp and operation.

In the ~/.m2/settings.xml you need the following lines :

<settings xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">

  <!-- SERVER SETTINGS -->
  <servers>
    <!-- To publish a snapshot of some part of Maven -->
    <server>
      <id>apache.snapshots.https</id>
      <username>elecharny</username>
      <password>-----Your password here-----</password>
    </server>
    <!-- To publish a website of some part of Maven -->
    <server>
      <id>apache.websites</id>
      <username>elecharny</username>
      <filePermissions>664</filePermissions>
      <directoryPermissions>775</directoryPermissions>
    </server>
    <!-- To stage a release of some part of Maven -->
    <server>
      <id>apache.releases.https</id>
      <username>elecharny</username>
      <password>-----Your password here-----</password>
    </server>
    <!-- To stage a website of some part of Maven -->
    <server>
      <id>stagingSite</id> <!-- must match hard-coded repository identifier in site:stage-deploy -->
      <username>elecharny</username>
      <filePermissions>664</filePermissions>
      <directoryPermissions>775</directoryPermissions>
    </server>
  </servers>

  <!-- PROFILE SETTINGS -->
  <profiles>
    <profile>
      <id>apache-release</id>
      <properties>
        <!-- Configuration for artifacts signature -->
        <gpg.passphrase>-----Your passphrase here-----</gpg.passphrase>
      </properties>
    </profile>
  </profiles>

</settings>

step 2 : Processing with a dry run

After having checked out the trunk, and built it (see step 0),

$ svn co https://svn.apache.org/repos/asf/mina/trunk mina
$ cd mina
$ mvn clean install -Pserial

run the following commands :

$ mvn -Pserial,apache-release -DdryRun=true release:prepare    # Dry-run first.

Answer to maven questions :

"What is the release version for "Apache MINA"? (org.apache.mina:mina-parent) 2.0.7-<version>: :" 
<either use the default version as suggested, or type in the version you@qot;d like to be used>
[..]

Then some other questions will be asked, about the next version to use. The default values should be fine.

**Be Careful** Make sure the change made by the release plugin is correct! (pom.xml, tags created)

Step 3 : Processing with the real release

When the dry run is successful, then you can do in real with the following commands:

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

The first step will clean up the local sources, the second step will release for real. The same questions will be asked as those we had during the dry run step.

At some point, it will ask for your passphrase (the one you used when you created your PGP key). Type it in.

Three mails will be generated, and sent to commits@mina.apache.org :

git commit: [maven-release-plugin] prepare release 2.0.9
Git Push Summary
git commit: [maven-release-plugin] prepare for next development iteration

The first mail tells you that the SNAPSHOT has been moved to the release version in trunk, the second mails tells you that this version has been tagged, and the last mail tells you that trunk has moved to the next version.

Step 4 : perform the release

The last step before launching a vote is to push the potential release to Nexus so that every user can test the created packages. Perform the following actions

$ mvn -Pserial,apache-release release:perform
...
[INFO] [INFO] ------------------------------------------------------------------------
[INFO] [INFO] Reactor Summary:
[INFO] [INFO] ------------------------------------------------------------------------
[INFO] [INFO] Apache MINA ........................................... SUCCESS [1:05.896s]
[INFO] [INFO] Apache MINA Legal ..................................... SUCCESS [30.708s]
[INFO] [INFO] Apache MINA Core ...................................... SUCCESS [4:44.973s]
[INFO] [INFO] Apache MINA APR Transport ............................. SUCCESS [46.082s]
[INFO] [INFO] Apache MINA Compression Filter ........................ SUCCESS [40.230s]
[INFO] [INFO] Apache MINA State Machine ............................. SUCCESS [52.718s]
[INFO] [INFO] Apache MINA JavaBeans Integration ..................... SUCCESS [46.358s]
[INFO] [INFO] Apache MINA XBean Integration ......................... SUCCESS [1:21.054s]
[INFO] [INFO] Apache MINA OGNL Integration .......................... SUCCESS [40.740s]
[INFO] [INFO] Apache MINA JMX Integration ........................... SUCCESS [40.482s]
[INFO] [INFO] Apache MINA Examples .................................. SUCCESS [1:13.837s]
[INFO] [INFO] Apache MINA Serial Communication support .............. SUCCESS [41.684s]
[INFO] [INFO] Apache MINA Distribution .............................. SUCCESS [12:39.542s]
[INFO] [INFO] ------------------------------------------------------------------------
[INFO] [INFO] ------------------------------------------------------------------------
[INFO] [INFO] BUILD SUCCESSFUL
[INFO] [INFO] ------------------------------------------------------------------------
[INFO] [INFO] Total time: 26 minutes 46 seconds
[INFO] [INFO] Finished at: Mon Sep 13 16:45:14 CEST 2010
[INFO] [INFO] Final Memory: 98M/299M
[INFO] [INFO] ------------------------------------------------------------------------
[INFO] Cleaning up after release...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 27 minutes 5 seconds
[INFO] Finished at: Mon Sep 13 16:45:18 CEST 2010
[INFO] Final Memory: 28M/81M
[INFO] ------------------------------------------------------------------------

Done !

Step 5 : closing the staging release on nexus

Now, you have to close the staged project on nexus. In order to do that you must have exported your PGP key to a PGP public server see

Connect to the Nexus server (https://repository.apache.org), login, and select the MINA staging repository you just created, then click on the 'close' button. You are home...

Step 6 : Build the Site

$ cd target/checkout
$ mvn -Pserial site

This creates the site.

Step 7 : Sign the packages

Now, you have to sign the binary packages which are in target/checkout/distribution/target.

Use your PGP key ID (the pub key, 4096R/[XXXXXXX] where [XXXXXXX] is the key ID)

You can get the keys by typing :

gpg --list-keys

You'll get something like :

$ gpg --list-keys /Users/elecharny/.gnupg/pubring.gpg


pub 2048D/xxxxxxxx 2009-12-03 uid Emmanuel Lecharny elecharny@nextury.com sub 2048g/yyyyyyyy 2009-12-03

pub 4096R/zzzzzzzz 2010-09-13 uid Emmanuel Lecharny (CODE SIGNING KEY) elecharny@apache.org sub 4096R/tttttttt 2010-09-13 ...

Take the part of your 4096 bit key.

Use a shell script to sign the packages which are stored in target/checkout/distribution/target. You will first have to delete the created .asc files :

7C6B7034 localhost:target elecharny$ rm *.asc localhost:target elecharny$ ~/sign.sh PGP Key ID: PGP Key Password:

-n Signing: ./apache-mina-2.0.9-bin.tar.bz2 ... - Generated './apache-mina-2.0.9-bin.tar.bz2.md5' - Generated './apache-mina-2.0.9-bin.tar.bz2.sha1' - Generated './apache-mina-2.0.9-bin.tar.bz2.asc' -n Signing: ./apache-mina-2.0.9-bin.tar.gz ... - Generated './apache-mina-2.0.9-bin.tar.gz.md5' - Generated './apache-mina-2.0.9-bin.tar.gz.sha1' - Generated './apache-mina-2.0.9-bin.tar.gz.asc' ...

Here is the sign.sh script you can use :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
#!/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 "*.md5" -or -name "*.sha1" -or -name "*.asc" ')' -and -type f) ; do
    if [ -f "$FILE.asc" ]; then
        echo "Skipping: $FILE"
        continue
    fi

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

    # MD5
    if [ ! -f "$FILE.md5" ];
    then
        openssl md5 < "$FILE" | cut "-d " -f2 > "$FILE.md5"
        echo "  - Generated '$FILE.md5'"
    else
        echo "  - Skipped '$FILE.md5' (file already existing)"
    fi

    # SHA1
    if [ ! -f "$FILE.sha1" ];
    then
        gpg -v --default-key "$DEFAULT_KEY" --print-md SHA1 "$FILE" > "$FILE".sha1
        echo "  - Generated '$FILE.sha1'"
    else
        echo "  - Skipped '$FILE.sha1' (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

Step 8 : Publish Source and Binary Distribution Packages

First of all, create a new directory on people.apache.org/public_html to store the pacckages :

$ ssh people.apache.org
$ mkdir public_html/mina-<version>
$ exit

Then copy the packages :

$ cd target/checkout/distributions/target
$ scp apache-mina-<version>-* people.apache.org:public_html/mina-<version>/

Update your index.html file on people.apach.org/public_html to make the packages visible. Here is an example of possible content :

<h2>Last MINA 2.0.9 tarballs</h2>
  <h3>Sources</h3>

    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.gz">apache-mina-2.0.9-src.tar.gz</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.gz.asc">apache-mina-2.0.9-src.tar.gz.asc</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.gz.asc">apache-mina-2.0.9-src.tar.gz.md5</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.gz.asc">apache-mina-2.0.9-src.tar.gz.sha1</a><br/>

    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.bz2">apache-mina-2.0.9-src.tar.bz2</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.bz2.asc">apache-mina-2.0.9-src.tar.bz2.asc</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.bz2.asc">apache-mina-2.0.9-src.tar.bz2.md5</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.bz2.asc">apache-mina-2.0.9-src.tar.bz2.sha1</a><br/>

    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.zip">apache-mina-2.0.9-src.zip</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.zip.asc">apache-mina-2.0.9-src.zip.asc</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.zip.asc">apache-mina-2.0.9-src.zip.md5</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.zip.asc">apache-mina-2.0.9-src.zip.sha1</a><br/>

  <h3>Binaries</h3>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.gz">apache-mina-2.0.9-bin.tar.gz</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.gz.asc">apache-mina-2.0.9-bin.tar.gz.asc</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.gz.asc">apache-mina-2.0.9-bin.tar.gz.md5</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.gz.asc">apache-mina-2.0.9-bin.tar.gz.sha1</a><br/>

    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.bz2">apache-mina-2.0.9-bin.tar.bz2</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.bz2.asc">apache-mina-2.0.9-bin.tar.bz2.asc</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.bz2.asc">apache-mina-2.0.9-bin.tar.bz2.md5</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.bz2.asc">apache-mina-2.0.9-bin.tar.bz2.sha1</a><br/>

    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.zip">apache-mina-2.0.9-bin.zip</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.zip.asc">apache-mina-2.0.9-bin.zip.asc</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.zip.asc">apache-mina-2.0.9-bin.zip.md5</a><br/>
    <img src="/icons/compressed.gif" alt="[   ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.zip.asc">apache-mina-2.0.9-bin.zip.sha1</a><br/>

Step 9 : Test the New Version with FtpServer, Sshd and Vysper

In FtpServer/pom.xml change the property, build FtpServer. It should build with no error. Do the same thing with Sshd and Vysper.

It's time to launch a vote !

Step 10 : Voting a release

Once the tarballs have been created, and the binaries available in Nexus, a vote can be launched. Simply send a mail on the dev@mina.apache.org mailing list describing the new release.

Here is how you send a [VOTE] mail on the dev mailing list :

Hi,

<blah blah blah>

Here is the list of fixed issues :


   * [DIRMINA-803 <https://issues.apache.org/jira/browse/DIRMINA-803>]
     - ProtocolCodecFilter.filterWrite() is no longer thread-safe
   * ...


Here's the Jira link for this version if you'd like to review issues in more details:

https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=10670&styleName=Html&version=12313702

A temporary tag has been created (it can be removed if the vote is not approved):
http://svn.apache.org/viewvc/mina/tags/2.0.1/
The svn revision is :http://svn.apache.org/viewvc?rev=1026395

The newly approved Nexus has been used for the preparation of this release and all final artifacts are stored 
in a staging repository:
https://repository.apache.org/content/repositories/orgapachemina-002/


The distributions are available for download on :
https://repository.apache.org/content/repositories/orgapachemina-004/org/apache/mina/mina-parent/2.0.1/

Let us vote :
[ ] +1 | Release MINA 2.0.1
[ ] +/- | Abstain
[ ] -1 | Do *NOT*  release MINA 2.0.1

Thanks !

The vote will be open for 72 hours. Once the delay is over, collect the votes, and count the binding +1/-1. If the vote is positive, then we can release.

Step 11 : Close the vote

You can officially close the vote now. There are some more steps to fulfill :

This can be done on people.apache.org :

$ ssh people.apache.org
# svn co https://dist.apache.org/repos/dist/release/mina/mina/ mina-dist
# cd mina-dist
# mkdir <version>
# cp ../public_html/mina-<version>/* <version>
# svn add <version>
# svn ci <version>
...
# exit
$

Step 12: Deploy Web Reports (JavaDoc and JXR)

The javadoc and xref files have been generated in step 6, it's now time to push them into the production site. They are generated in the following directory :

target/checkout/target/site

We will copy two directories :

apidocs
xref

Staging or Production?

Those files will be stored on the production server only !!! And some extra caution ust be taken not to delete them when we will publish the staging site too...

First of all, you must checkout the two CMS store for the site : staging and production.

$ svn co https://svn.apache.org/repos/infra/websites/staging/mina/trunk staging
...
$ svn co https://svn.apache.org/repos/infra/websites/production/mina production
...

Then copy the generated docs :

$ cp -r ~/mina/target/checkout/target/site/apidocs production/content/mina/mina-project/
$ cp -r ~/mina/target/checkout/target/site/xref production/content/mina/mina-project/
$

You have to check in those directories :

$ svn add apidocs
$ svn add xref
$ svn ci apidocs xref -m "Injected MINA <version> javadocs"

Now, you have to update the staging site extpaths.txt

This file list the file on the production site that will not be overriden by the publication of the staging site. It has to be updated

$ cd ~/apacheds/staging/content/
$ vi extpaths.txt

The following lines should be present. If not, add them and commit the file :

mina-project/apidocs
mina-project/testapidocs
mina-project/xref
mina-project/xref-test
...

Step 13: Wait 24 hours

We have to wait at least 24 hours for all mirrors to retrieve the uploaded files before making any announcement. I'd recommend you to wait for 48 hours because some mirrors might lag due to various issues.

Update the links to new distributions in [Downloads] page.

Step 15: Wait another 24 hours

We need to wait until any changes made in the web site and metadata file(s) go live.

Step 16: Announce the New Release

An announcement message can be sent to [mailto:announce@apache.org], [mailto:announce@apachenews.org], [mailto:users@mina.apache.org] and [mailto:dev@mina.apache.org]. Please note that announcement messages are rejected unless your from-address ends with @apache.org. Plus, you shouldn't forget to post a news to the MINA site main page.

Creating a New Release Branch

When you create a new branch, you have to make sure the sections that specifies branch version numbers are configured appropriately in the root pom.xml.

...
<version>1.1.0-SNAPSHOT</version>
...
<scm>
  <connection>scm:svn:http://svn.apache.org/repos/asf/mina/mina/branches/2.0</connection>
  <url>http://svn.apache.org/viewvc/directory/mina/mina/branches/2.0</url>
  <developerConnection>scm:svn:https://svn.apache.org/repos/asf/mina/mina/branches/2.0</developerConnection>
</scm>
...
<distributionManagement>
  <site>
    <id>apache.websites</id>
    <url>scp://people.apache.org/www/mina.apache.org/report/1.1/</url>
  </site>
</distributionManagement>
...

Please note that the example above is for branches/2.0. For example, you have to replace branches/2.0 with branches/3.0 if the version number of the new branch is 3.0. In case of trunk, it's just trunk rather than branches/<version>.