You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2012/11/01 06:13:13 UTC
svn commit: r1404465 [1/2] - in /mina/site/trunk/content: ./ mina/
mina/userguide/ mina/userguide/ch1-getting-started/
mina/userguide/ch12-logging-filter/ mina/userguide/ch14-state-machine/
mina/userguide/ch16-jmx-support/ mina/userguide/ch17-spring-in...
Author: elecharny
Date: Thu Nov 1 05:13:12 2012
New Revision: 1404465
URL: http://svn.apache.org/viewvc?rev=1404465&view=rev
Log:
Update all the MINA pages, removed the table, etc
Modified:
mina/site/trunk/content/mina/codec-repo.mdtext
mina/site/trunk/content/mina/developper-guide.mdtext
mina/site/trunk/content/mina/faq.mdtext
mina/site/trunk/content/mina/features.mdtext
mina/site/trunk/content/mina/issue-tracking.mdtext
mina/site/trunk/content/mina/news.mdtext
mina/site/trunk/content/mina/performances.mdtext
mina/site/trunk/content/mina/related-projects.mdtext
mina/site/trunk/content/mina/road-map.mdtext
mina/site/trunk/content/mina/set-svnprops-tortoisesvn.mdtext
mina/site/trunk/content/mina/userguide/ch1-getting-started/first-steps.mdtext
mina/site/trunk/content/mina/userguide/ch12-logging-filter/ch12-logging-filter.mdtext
mina/site/trunk/content/mina/userguide/ch14-state-machine/ch14-state-machine.mdtext
mina/site/trunk/content/mina/userguide/ch16-jmx-support/ch16-jmx-support.mdtext
mina/site/trunk/content/mina/userguide/ch17-spring-integration/ch17-spring-integration.mdtext
mina/site/trunk/content/mina/userguide/ch2-basics/sample-tcp-client.mdtext
mina/site/trunk/content/mina/userguide/ch2-basics/sample-tcp-server.mdtext
mina/site/trunk/content/mina/userguide/ch2-basics/sample-udp-client.mdtext
mina/site/trunk/content/mina/userguide/ch2-basics/sample-udp-server.mdtext
mina/site/trunk/content/mina/userguide/ch3-service/acceptor.mdtext
mina/site/trunk/content/mina/userguide/ch4-session/ch4-session.mdtext
mina/site/trunk/content/mina/userguide/ch5-filters/ch5-filters.mdtext
mina/site/trunk/content/mina/userguide/ch6-transports/apr-transport.mdtext
mina/site/trunk/content/mina/userguide/ch6-transports/serial-transport.mdtext
mina/site/trunk/content/mina/userguide/ch7-handler/ch7-handler.mdtext
mina/site/trunk/content/mina/userguide/ch8-iobuffer/ch8-iobuffer.mdtext
mina/site/trunk/content/mina/userguide/ch9-codec-filter/ch9-codec-filter.mdtext
mina/site/trunk/content/mina/userguide/codec-repo.mdtext
mina/site/trunk/content/special-thanks.mdtext
Modified: mina/site/trunk/content/mina/codec-repo.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/codec-repo.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/codec-repo.mdtext (original)
+++ mina/site/trunk/content/mina/codec-repo.mdtext Thu Nov 1 05:13:12 2012
@@ -28,97 +28,22 @@ This page captures known MINA Codecs ava
The table below summarizes some of the known codecs
-<DIV class="table-wrap">
-<TABLE class="confluenceTable"><TBODY>
-<TR>
-<TH class="confluenceTh"> Protocol </TH>
-<TH class="confluenceTh"> Project </TH>
-<TH class="confluenceTh"> Description </TH>
-</TR>
-<TR>
-<TD class="confluenceTd"> Prefixed String </TD>
-<TD class="confluenceTd"> <A href="http://mina.apache.org/" class="external-link" rel="nofollow">Apache MINA</A> </TD>
-<TD class="confluenceTd"> Encodes/Decodes a a String with fixed length prefix </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Object Serializer </TD>
-<TD class="confluenceTd"> <A href="http://mina.apache.org/" class="external-link" rel="nofollow">Apache MINA</A> </TD>
-<TD class="confluenceTd"> Serializes and deserializes Java objects </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Text Line </TD>
-<TD class="confluenceTd"> <A href="http://mina.apache.org/" class="external-link" rel="nofollow">Apache MINA</A> </TD>
-<TD class="confluenceTd"> Encoding/Decoding between a text line data and a Java string object </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Ftp </TD>
-<TD class="confluenceTd"> <A href="http://mina.apache.org/ftpserver/" class="external-link" rel="nofollow">Apache FtpServer</A> </TD>
-<TD class="confluenceTd"> FTP codecs </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> LDAP </TD>
-<TD class="confluenceTd"> <A href="http://directory.apache.org/" class="external-link" rel="nofollow">Apache Directory</A> </TD>
-<TD class="confluenceTd"> LDAP protocol Codecs </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> DNS </TD>
-<TD class="confluenceTd"> <A href="http://directory.apache.org/" class="external-link" rel="nofollow">Apache Directory</A> </TD>
-<TD class="confluenceTd"> DNS protocol Codecs </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Kerberos </TD>
-<TD class="confluenceTd"> <A href="http://directory.apache.org/" class="external-link" rel="nofollow">Apache Directory</A> </TD>
-<TD class="confluenceTd"> Kerberos protocol Codecs </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> NTP </TD>
-<TD class="confluenceTd"> <A href="http://directory.apache.org/" class="external-link" rel="nofollow">Apache Directory</A> </TD>
-<TD class="confluenceTd"> NTP protocol Codecs </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> DHCP </TD>
-<TD class="confluenceTd"> <A href="http://directory.apache.org/" class="external-link" rel="nofollow">Apache Directory</A> </TD>
-<TD class="confluenceTd"> DHCP protocol Codecs </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> <A href="http://jira.red5.org/confluence/display/docs/Chapter%2016.%20Clustering" class="external-link" rel="nofollow">MRTMP</A> </TD>
-<TD class="confluenceTd"> <A href="http://www.red5.org/" class="external-link" rel="nofollow">Red5</A> </TD>
-<TD class="confluenceTd"> Codecs for Multiplexing RTMP </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> RTMP </TD>
-<TD class="confluenceTd"> <A href="http://www.red5.org/" class="external-link" rel="nofollow">Red5</A> </TD>
-<TD class="confluenceTd"> Codecs for RTMP </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> RTSP </TD>
-<TD class="confluenceTd"> <A href="http://www.red5.org/" class="external-link" rel="nofollow">Red5</A> </TD>
-<TD class="confluenceTd"> Codecs for RTSP </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> SMTP </TD>
-<TD class="confluenceTd"> <A href="http://tedorg.free.fr/en/projects.php?section=smtp" class="external-link" rel="nofollow">MailsterSMTP</A> </TD>
-<TD class="confluenceTd"> SMTP Codecs </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> AMQP </TD>
-<TD class="confluenceTd"> <A href="http://cwiki.apache.org/qpid/" class="external-link" rel="nofollow">Apache Qpid</A> </TD>
-<TD class="confluenceTd"> AMQP Codecs </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> XMPP </TD>
-<TD class="confluenceTd"> <A href="http://www.jivesoftware.com/products/openfire/" class="external-link" rel="nofollow">Jive Software Openfire</A> </TD>
-<TD class="confluenceTd"> XMPP Codecs </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> XMPP </TD>
-<TD class="confluenceTd"> Apache Vysper </TD>
-<TD class="confluenceTd"> XMPP/XML Codecs. Subproject of MINA. Still in <A href="http://svn.apache.org/repos/asf/mina/sandbox/vysper/" class="external-link" rel="nofollow">sanbox</A> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Google Protocol Buffers </TD>
-<TD class="confluenceTd"> Apache MINA </TD>
-<TD class="confluenceTd"> Codecs are still in <A href="http://svn.apache.org/repos/asf/mina/sandbox/protocol-buffers/" class="external-link" rel="nofollow">sandbox</A> </TD>
-</TR>
-</TBODY></TABLE>
-</DIV>
+| Protocol | Project | Description |
+|---|---|---|
+| Prefixed String | [Apache MINA](http://mina.apache.org/) | Encodes/Decodes a a String with fixed length prefix |
+| Object Serializer | [Apache MINA](http://mina.apache.org/) | Serializes and deserializes Java objects |
+| Text Line | [Apache MINA](http://mina.apache.org/) | Encoding/Decoding between a text line data and a Java string object |
+| Ftp | [Apache FtpServer](http://mina.apache.org/ftpserver) | FTP codecs |
+| LDAP | [Apache Directory](http://directory.apache.org/)| LDAP protocol Codecs |
+| DNS | [Apache Directory](http://directory.apache.org/)| DNS protocol Codecs |
+| Kerberos | [Apache Directory](http://directory.apache.org/)| Kerberos protocol Codecs |
+| NTP | [Apache Directory](http://directory.apache.org/) | NTP protocol Codecs |
+| DHCP | [Apache Directory](http://directory.apache.org/) | DHCP protocol Codecs |
+| [MRTMP](http://jira.red5.org/confluence/display/docs/Chapter%2016.%20Clustering)| [Red5](http://www.red5.org/) | Codecs for Multiplexing RTMP |
+| RTMP | [Red5](http://www.red5.org/) | Codecs for RTMP |
+| RTSP | [Red5](http://www.red5.org/) | Codecs for RTSP |
+| SMTP | [MailsterSMTP](http://tedorg.free.fr/en/projects.php?section=smtp)</A> | SMTP Codecs |
+| AMQP | [Apache Qpid](http://cwiki.apache.org/qpid/)</A> | AMQP Codecs |
+| XMPP | <A href="" class="external-link" rel="nofollow">[Jive Software Openfire](http://www.jivesoftware.com/products/openfire/)| XMPP Codecs |
+ | XMPP | [Vysper](http://mina.apache.org/vysper)| XMPP/XML Codecs. Subproject of MINA. |
+| Google Protocol Buffers | Apache MINA | Codecs are still in [sandbox](http://svn.apache.org/repos/asf/mina/sandbox/protocol-buffers/)</A> |
Modified: mina/site/trunk/content/mina/developper-guide.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/developper-guide.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/developper-guide.mdtext (original)
+++ mina/site/trunk/content/mina/developper-guide.mdtext Thu Nov 1 05:13:12 2012
@@ -120,6 +120,7 @@ First you need to configure maven for us
In the `~/.m2/settings.xml` you need the following lines :
+ :::xml
<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
@@ -384,6 +385,7 @@ An announcement message can be sent to [
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`.
+ :::xml
...
<version>1.1.0-SNAPSHOT</version>
...
Modified: mina/site/trunk/content/mina/faq.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/faq.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/faq.mdtext (original)
+++ mina/site/trunk/content/mina/faq.mdtext Thu Nov 1 05:13:12 2012
@@ -20,7 +20,7 @@ Notice: Licensed to the Apache Softwa
[TOC]
-# General
+<H2>General</H2>
## What does MINA mean?
@@ -110,7 +110,7 @@ Please refer to <TT>DemuxingIoHandler</T
### How do I close my sessions and dispose my Connector?
You have to do it in two steps : first close your sessions, then dispose the connector. Of course, if you dispose your Connector first, then all the sessions will be closed. Here is the code :
-
+ :::java
ConnectFuture cf = connector.connect(new InetSocketAddress("localhost", 8080));
// Get the close future for this session
@@ -138,6 +138,7 @@ You have to do it in two steps : first c
Here is an example code:
+ :::java
public void sessionClosed( IoSession session ) throws Exception {
// Wait for five seconds before reconnecting.
Thread.sleep( 5000 );
@@ -169,7 +170,7 @@ We recommend to switch the default buffe
ByteBuffer.setUseDirectBuffers(false);
ByteBuffer.setAllocator(new SimpleByteBufferAllocator());
-If you prefer direct buffers to heap buffers, JVM might have ran out of direct memory. Please try increasing maximum direct memory size using <TT>-XX:MaxDirectMemorySize</TT> option (e.g. <TT>-XX:MaxDirectMemorySize=128M</TT>)
+If you prefer direct buffers to heap buffers, JVM might have ran out of direct memory. Please try increasing maximum direct memory size using **-XX:MaxDirectMemorySize** option (e.g. **-XX:MaxDirectMemorySize=128M**)
### No data is writtin out to the session even if the buffer is not empty.
@@ -181,10 +182,11 @@ Please make sure you called `SSLFilter.s
### Why does SocketConnector send several messages as one message?
-<EM>For example, I tried using SocketConnector to send "abc" and "def", but it sent "abcdef". Is it a MINA bug?</EM>
+_For example, I tried using SocketConnector to send "abc" and "def", but it sent "abcdef". Is it a MINA bug?_
No, this is due to your OS trying to send packets more efficiently (see [Nagle algorithm](http://en.wikipedia.org/wiki/Nagle_algorithm)). You can enable/disable Nagle's algorithm by a call to SocketSessionConfig.setTcpNoDelay(), e.g.:
+ :::java
((SocketSessionConfig) connector.getSessionConfig()).setTcpNoDelay(false)
However, even if you do this you cannot expect one session.write(bytes) in MINA to correspond to one TCP packet on your network. You should probably implement your own MINA ProtocolDecoder to handle the assembly of incoming bytes into message objects. The TextLineCodec is a good start if the protocol you're implementing is based on text lines. For a more advanced example have a look at the SumUp example in the MINA distribution.
Modified: mina/site/trunk/content/mina/features.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/features.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/features.mdtext (original)
+++ mina/site/trunk/content/mina/features.mdtext Thu Nov 1 05:13:12 2012
@@ -1,18 +1,38 @@
+Title: Features
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# Features
+
MINA is a simple yet full-featured network application framework which provides:
* Unified API for various transport types:
-** TCP/IP & UDP/IP via Java NIO
-** Serial communication (RS232) via RXTX
-** In-VM pipe communication
-** You can implement your own!
+ * TCP/IP & UDP/IP via Java NIO
+ * Serial communication (RS232) via RXTX
+ * In-VM pipe communication
+ * You can implement your own!
* Filter interface as an extension point; similar to Servlet filters
* Low-level and high-level API:
-** Low-level: uses ByteBuffers
-** High-level: uses user-defined message objects and codecs
+ * Low-level: uses ByteBuffers
+ * High-level: uses user-defined message objects and codecs
* Highly customizable thread model:
-** Single thread
-** One thread pool
-** More than one thread pools (i.e. [SEDA](http://www.eecs.harvard.edu/~mdw/proj/seda/))
+ * Single thread
+ * One thread pool
+ * More than one thread pools (i.e. [SEDA](http://www.eecs.harvard.edu/~mdw/proj/seda/))
* Out-of-the-box SSL · TLS · StartTLS support using Java 5 `SSLEngine`
* Overload shielding & traffic throttling
* Unit testability using mock objects
Modified: mina/site/trunk/content/mina/issue-tracking.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/issue-tracking.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/issue-tracking.mdtext (original)
+++ mina/site/trunk/content/mina/issue-tracking.mdtext Thu Nov 1 05:13:12 2012
@@ -37,21 +37,7 @@ Remember that this issue tracking system
Issues, bugs, and feature requests should be submitted to the following issue tracking system :
-<DIV class="table-wrap">
- <TABLE class="confluenceTable">
- <TBODY>
- <TR>
- <TH class="confluenceTh"> Project </TH>
- <TH class="confluenceTh"> JIRA key </TH>
- <TH class="confluenceTh"> Corresponding link to issue tracking system </TH>
- </TR>
- <TR>
- <TD class="confluenceTd"> MINA </TD>
- <TD class="confluenceTd"> DIRMINA </TD>
- <TD class="confluenceTd">
- [http://issues.apache.org/jira/browse/DIRMINA](http://issues.apache.org/jira/browse/DIRMINA)
- </TD>
- </TR>
- </TBODY>
- </TABLE>
-</DIV>
+| | | |
+|---|---|---|
+| Project | JIRA key | Corresponding link to issue tracking system |
+| MINA | DIRMINA | [http://issues.apache.org/jira/browse/DIRMINA](http://issues.apache.org/jira/browse/DIRMINA) |
Modified: mina/site/trunk/content/mina/news.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/news.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/news.mdtext (original)
+++ mina/site/trunk/content/mina/news.mdtext Thu Nov 1 05:13:12 2012
@@ -1,3 +1,20 @@
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
# News
## MINA 2.0.7 released _posted on October, 12, 2012_
Modified: mina/site/trunk/content/mina/performances.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/performances.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/performances.mdtext (original)
+++ mina/site/trunk/content/mina/performances.mdtext Thu Nov 1 05:13:12 2012
@@ -20,35 +20,35 @@ Notice: Licensed to the Apache Softwa
This page exhibits the performance test results under various conditions (e.g. various protocols and system environments). Please [contact us|Mailing Lists] if you have any specific performance test results to publish for your MINA-based application.
-{note}The following performance test results may have critical flaws in test design or contain wrong values. Please regard these reports as just a hint for understanding general performance characteristics of Apache MINA. Additionally, these reports are not meant to claim that Apache MINA outperforms a certain product purposely{note}
+<DIV class="note" markdown="1">
+The following performance test results may have critical flaws in test design or contain wrong values. Please regard these reports as just a hint for understanding general performance characteristics of Apache MINA. Additionally, these reports are not meant to claim that Apache MINA outperforms a certain product purposely{note}
+</DIV>
# Apache MINA 2.0.0-M1-SNAPSHOT + AsyncWeb 0.9.0-SNAPSHOT
-[Trustin Lee|http://gleamynode.net/] ran a HTTP performance test with the latest snapshot of Apache MINA and [AsyncWeb|http://asyncweb.safehaus.org/] combo, using [the AsyncWeb lightweight HTTP server example|https://svn.safehaus.org/repos/asyncweb/trunk/example/src/main/java/org/safehaus/asyncweb/example/lightweight/].
+[Trustin Lee](http://gleamynode.net/) ran a HTTP performance test with the latest snapshot of Apache MINA and [AsyncWeb](http://asyncweb.safehaus.org/) combo, using [the AsyncWeb lightweight HTTP server example](https://svn.safehaus.org/repos/asyncweb/trunk/example/src/main/java/org/safehaus/asyncweb/example/lightweight/).
* Protocol
-** HTTP
-** Tested keep-alive mode using [ApacheBench|http://en.wikipedia.org/wiki/ApacheBench].
-** Content length: 128 (excluding the header)
+ * HTTP
+ * Tested keep-alive mode using [ApacheBench|http://en.wikipedia.org/wiki/ApacheBench].
+ * Content length: 128 (excluding the header)
* Client
-** Pentium 4 3GHz
-** Ubuntu Linux 6.10
+ * Pentium 4 3GHz
+ * Ubuntu Linux 6.10
* Server
-** 2 dual-core Opterons (4 cores, 270 Italy)
-** Gentoo Linux 2.6.18-r6 x86_64
+ * 2 dual-core Opterons (4 cores, 270 Italy)
+ * Gentoo Linux 2.6.18-r6 x86_64
* Network
-** 100Mbit Ethernet (direct link)
+ * 100Mbit Ethernet (direct link)
* JVM
-** Sun Java HotSpot(TM) 64-Bit Server VM (build 1.6.0-b105, mixed mode)
-** {{-server -Xms512m -Xmx512m -Xss128k -XX:+AggressiveOpts -XX:+UseParallelGC -XX:+UseBiasedLocking -XX:NewSize=64m}}
+ * Sun Java HotSpot(TM) 64-Bit Server VM (build 1.6.0-b105, mixed mode)
+ * {{-server -Xms512m -Xmx512m -Xss128k -XX:+AggressiveOpts -XX:+UseParallelGC -XX:+UseBiasedLocking -XX:NewSize=64m}}
To show the performance characteristics of Apache MINA doesn't differ with the production-ready Web servers, the same test has been run on [the Apache HTTPD 2.0.58|http://httpd.apache.org/]. Because I don't know how to write an Apache HTTPD module, I simply used a dummy static file. Because the amount of the response header two HTTP servers generate is different, I changed the AsyncWeb to generate more traffic in the content. The size of one response was about 405 bytes.
-<div class="" align="center">
- <span class="image-wrap" style="">
- <img src="./staticresources/images/AsyncWeb-0.9.0-SNAPSHOT.png" style="border: 0px solid black" />
- </span>
-</div>
+<CENTER>
+
+<CENTER/>
The client machine in my company doesn't have 1Gbps Ethernet adapter nor a gigabit-capable CPU, I was not able to increase the content size. I made sure the network didn't saturate while the test at least.
Modified: mina/site/trunk/content/mina/related-projects.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/related-projects.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/related-projects.mdtext (original)
+++ mina/site/trunk/content/mina/related-projects.mdtext Thu Nov 1 05:13:12 2012
@@ -16,87 +16,89 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
+<H1>Related Projects</H1>
+
This page lists the projects which use Apache MINA as its networking layer. Please contact us if you are using MINA and you want to add a link to this page. You could also read the users' testimonials. To compare MINA to other network application frameworks, please refer to the 'Other network application frameworks' section below.
[TOC]
-## <a name="Othernetworkapplicationframeworks" />Other network application frameworks
+## Other network application frameworks
<DIV class="note" markdown="1">
The projects referred in this section 'Other network application frameworks' are <B>not</B> based on MINA but are their own network application frameworks. These links are provided for users who want to compare MINA to other network application frameworks.
</DIV>
-### <a name="Grizzly"/>[Grizzly](https://grizzly.dev.java.net/)
+### [Grizzly](https://grizzly.dev.java.net/)
Grizzly framework has been designed to help developers to take advantage of the Java⢠NIO API. Originally developed under the GlassFish umbrella, the framework is now available as a standalone project. Grizzly goals is to help developers to build scalable and robust servers using NIO.
-### <a name="Netty3" />[Netty 3](http://www.jboss.org/netty/)
+### [Netty 3](http://www.jboss.org/netty/)
The new version of Netty Trustin Lee is working on now. The Netty project is an effort to provide an asynchronous event-driven network application framework and tools for rapid development of maintainable high performance and high scalability protocol servers and clients.
-### <a name="NIOFramework" />[NIO Framework](http://nioframework.sourceforge.net/)
+### [NIO Framework](http://nioframework.sourceforge.net/)
The NIO Framework is a library on top of NIO that hides most of the complexity of plain NIO. With the NIO Framework you can implement high-performance Java network applications without having to deal with all the nasty details of NIO. The issues above are resolved while the performance is preserved.
-### <a name="QuickServer" />[QuickServer](http://www.quickserver.org/)
+### [QuickServer](http://www.quickserver.org/)
QuickServer is an open source Java library/framework for quick creation of robust multi-client TCP server applications. QuickServer provides an abstraction over the ServerSocket, Socket and other network and input output classes and it eases the creation of powerful network servers.
-### <a name="xSocket" />[xSocket](http://xsocket.sourceforge.net/)
+### [xSocket](http://xsocket.sourceforge.net/)
xSocket is a easy to use NIO-based library to build high performance, highly scalable network applications. It supports writing client-side applications as well as server-side applications in an intuitive way. Issues like low level NIO selector programming, connection pool management, connection timeout detection or fragmented buffer reads are encapsulated by xSocket.
-## <a name="Messaging" />Messaging
+## Messaging
-### <a name="ApacheCamel" />[Apache Camel](http://activemq.apache.org/camel/)
+### [Apache Camel](http://activemq.apache.org/camel/)
Apache Camel is a POJO routing and mediation library for working with files, FTP, HTTP, MINA, JMS, JBI and web services.
-### <a name="ApacheQpid" />[Apache Qpid (incubating)](http://cwiki.apache.org/qpid/)
+### [Apache Qpid (incubating)](http://cwiki.apache.org/qpid/)
The Apache Qpid Project implemented [AMQP (Advanced Message Queuing Protocol)](http://www.amqp.org/) using Apache MINA.
-### <a name="Avis" />[Avis](http://avis.sourceforge.net/)
+### [Avis](http://avis.sourceforge.net/)
Avis is an event router service compatible with the commercial Elvin implementation developed by Mantara Software. Avis provides a fast, general-purpose publish/subscribe message bus.
-### <a name="MailsterSMTP" />[MailsterSMTP](http://tedorg.free.fr/en/projects.php?section=smtp)
+### [MailsterSMTP](http://tedorg.free.fr/en/projects.php?section=smtp)
MailsterSMTP is designed to be a easy to understand Java library which provides a receptive SMTP server component. Using this library, you can easily receive mails using a simple Java interface, extend the set of implemented commands or control how mails are delivered by plugging your custom implementations.
-## <a name="InstantMessaging" />Instant Messaging
+## Instant Messaging
-### <a name="JiveSoftwareOpenfire" />[Jive Software Openfire](http://www.jivesoftware.com/products/openfire/)
+### [Jive Software Openfire](http://www.jivesoftware.com/products/openfire/)
Jive Software Openfire implemented [XMPP (Extensible Messaging and Presence Protocol)](http://www.xmpp.org/) server on top of Apache MINA. After switching to Apache MINA, [they gained 11 times scalability boost](http://www.igniterealtime.org/blog/2006/12/19/scalability-turn-it-to-eleven/).
-## <a name="MediaStorageStreaming" />Media Storage & Streaming
+## Media Storage & Streaming
-### <a name="OpenLSD" />[OpenLSD](http://openlsd.free.fr/en/OpenLSD.html)
+### [OpenLSD](http://openlsd.free.fr/en/OpenLSD.html)
OpenLSD is an open source framework for massive document archiving. The web site also contains an interesting performance test report.
-### <a name="Red5" />[Red5](http://www.osflash.org/red5)
+### [Red5](http://www.osflash.org/red5)
OSFlash.org team implemented an open-source flash media streaming ([RTMP, Real Time Messaging Protocol](http://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol)) server with Apache MINA.
-## <a name="Finance" />Finance
+## Finance
-### <a name="QuickFIXJ" />[QuickFIX/J](http://www.quickfixj.org/)
+### [QuickFIX/J](http://www.quickfixj.org/)
QuickFIX/J is a Java implementation of [FIX (Financial Information eXchange) protocol](http://www.fixprotocol.org/).
-## <a name="Miscellaneous" />Miscellaneous
+## Miscellaneous
-### <a name="ApacheDirectoryProject" />[Apache Directory Project](http://directory.apache.org/)
+### [Apache Directory Project](http://directory.apache.org/)
The Apache Directory Project implemented LDAP v3, Kerberos, DNS, DHCP, NTP, and ChangePW using Apache MINA.
-### <a name="Beep4j" />[Beep4j](http://beep4j.sourceforge.net/)
+### [Beep4j](http://beep4j.sourceforge.net/)
Beep4j is an open-source implementation of the [BEEP](http://www.beepcore.org/) specification (RFC3080 and RFC3081).
-### <a name="VFSFTPServerBridge" />[VFS FTPServer Bridge](http://vfs-utils.sourceforge.net/ftpserver/index.html)
+### [VFS FTPServer Bridge](http://vfs-utils.sourceforge.net/ftpserver/index.html)
This project provides an Apache Commons VFS implementation for the Apache FTPServer project. Instead of working only on local files, with this VFS bridge you can connect to any VFS provider. You can still use a local file system, but you can also use a ZIP file, loop through to another FTP server, or use any other available VFS implementation such as DctmVFS.
Modified: mina/site/trunk/content/mina/road-map.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/road-map.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/road-map.mdtext (original)
+++ mina/site/trunk/content/mina/road-map.mdtext Thu Nov 1 05:13:12 2012
@@ -1,3 +1,21 @@
+Title: Testimonials
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
Please click the following links to find out what issues have been resolved and what issues will be resolved.
* [Road map for the future releases](http://issues.apache.org/jira/browse/DIRMINA?report=com.atlassian.jira.plugin.system.project:roadmap-panel&subset=-1)
Modified: mina/site/trunk/content/mina/set-svnprops-tortoisesvn.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/set-svnprops-tortoisesvn.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/set-svnprops-tortoisesvn.mdtext (original)
+++ mina/site/trunk/content/mina/set-svnprops-tortoisesvn.mdtext Thu Nov 1 05:13:12 2012
@@ -31,11 +31,11 @@ Lets see how to set these properties in
Open Tortoise SVN Client setting, (Right Click-> Tortoise SVN -> Settings)
-
+
Click Edit button (as shown in figure)
-
+
The svn properties config file shall open up.
@@ -46,6 +46,7 @@ Configure the properties auto-props sect
Please note that I have taken these properties from <http://wiki.apache.org/incubator-yoko/SetUpAutoProps>. Feel free to
update as per your needs.
+ :::text
*.java = svn:eol-style=native;svn:keywords=Rev Date
*.xml = svn:mime-type=text/xml;svn:eol-style=native;svn:keywords=Rev Date
*.xsl = svn:mime-type=text/xml;svn:eol-style=native;svn:keywords=Rev Date
Modified: mina/site/trunk/content/mina/userguide/ch1-getting-started/first-steps.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch1-getting-started/first-steps.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch1-getting-started/first-steps.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch1-getting-started/first-steps.mdtext Thu Nov 1 05:13:12 2012
@@ -77,14 +77,16 @@ Put the following jars in the classpath
* log4j-1.2.17.jar
<DIV class="tip" markdown="1">
- <B>Logging Tip</B><BR>
- * Log4J 1.2 users: slf4j-api.jar, slf4j-log4j12.jar, and Log4J 1.2.x<BR/>
- * Log4J 1.3 users: slf4j-api.jar, slf4j-log4j13.jar, and Log4J 1.3.x<BR/>
- * java.util.logging users: slf4j-api.jar and slf4j-jdk14.jar<BR/>
- IMPORTANT: Please make sure you are using the right slf4j-*.jar that matches to your logging framework.<BR>
- For instance, slf4j-log4j12.jar and log4j-1.3.x.jar can not be used together, and will malfunction.<BR>
- If you don't need a logging framework you can use slf4j-nop.jar for no logging or slf4j-simple.jar for<BR>
- very basic logging.
+**Logging Tip**
+
+* Log4J 1.2 users: slf4j-api.jar, slf4j-log4j12.jar, and Log4J 1.2.x
+* Log4J 1.3 users: slf4j-api.jar, slf4j-log4j13.jar, and Log4J 1.3.x
+* java.util.logging users: slf4j-api.jar and slf4j-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.
+If you don't need a logging framework you can use slf4j-nop.jar for no logging or slf4j-simple.jar for
+very basic logging.
</DIV>
On the command prompt, issue the following command :
Modified: mina/site/trunk/content/mina/userguide/ch12-logging-filter/ch12-logging-filter.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch12-logging-filter/ch12-logging-filter.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch12-logging-filter/ch12-logging-filter.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch12-logging-filter/ch12-logging-filter.mdtext Thu Nov 1 05:13:12 2012
@@ -37,30 +37,12 @@ MINA employs the Simple Logging Facade f
SLF4J uses a static binding. This means there is one JAR file for each supported logging framework. You can use your favorite logging framework by choosing the JAR file that calls the logging framework you chose statically. The following is the table of required JAR files to use a certain logging framework.
-<DIV class="table-wrap">
-<TABLE class="confluenceTable"><TBODY>
-<TR>
-<TH class="confluenceTh"> Logging framework </TH>
-<TH class="confluenceTh"> Required JARs </TH>
-</TR>
-<TR>
-<TD class="confluenceTd"> Log4J 1.2.x </TD>
-<TD class="confluenceTd"> <TT>slf4j-api.jar</TT>, <TT>slf4j-log4j12.jar</TT> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Log4J 1.3.x </TD>
-<TD class="confluenceTd"> <TT>slf4j-api.jar</TT>, <TT>slf4j-log4j13.jar</TT> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> <TT>java.util.logging</TT> </TD>
-<TD class="confluenceTd"> <TT>slf4j-api.jar</TT>, <TT>slf4j-jdk14.jar</TT> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Commons Logging </TD>
-<TD class="confluenceTd"> <TT>slf4j-api.jar</TT>, <TT>slf4j-jcl.jar</TT> </TD>
-</TR>
-</TBODY></TABLE>
-</DIV>
+| Logging framework | Required JARs |
+|---|---|
+| Log4J 1.2.x | **sl**f4j-api.jar**, **slf4j-log4j12.jar** |
+| Log4J 1.3.x | **slf4j-api.jar**, **slf4j-log4j13.jar** |
+| java.util.logging | <TT>slf4j-api.jar**, **slf4j-jdk14.jar** |
+| Commons Logging | **slf4j-api.jar**, **slf4j-jcl.jar** |
There are a few things to keep in mind:
@@ -96,6 +78,7 @@ This file will be placed in the src dire
Next we will set up a simple example server in order to generate some logs. Here we have taken the EchoServer example project and added logging to the class:
+ :::java
public static void main(String[] args) throws Exception {
IoAcceptor acceptor = new SocketAcceptor();
DefaultIoFilterChainBuilder chain = acceptor.getFilterChain();
@@ -112,76 +95,26 @@ Next we will set up a simple example ser
As you can see we removed the addLogger method and added in the 2 lines added to the example EchoServer. With a reference to the LoggingFilter, you can set the logging level per event type in your handler that is associated with the IoAcceptor here. In order to specify the IoHandler events that trigger logging and to what levels the logging is performed, there is a method in the LoggingFilter called setLogLevel(IoEventType, LogLevel). Below are the options for this method:
-<DIV class="table-wrap">
-<TABLE class="confluenceTable"><TBODY>
-<TR>
-<TH class="confluenceTh"> IoEventType </TH>
-<TH class="confluenceTh"> Description <BR class="atl-forced-newline"> </TH>
-</TR>
-<TR>
-<TD class="confluenceTd"> SESSION_CREATED </TD>
-<TD class="confluenceTd"> Called when a new session has been created <BR class="atl-forced-newline"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> SESSION_OPENED <BR class="atl-forced-newline"> </TD>
-<TD class="confluenceTd"> Called when a new session has been opened <BR class="atl-forced-newline"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> SESSION_CLOSED </TD>
-<TD class="confluenceTd"> Called when a session has been closed </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> MESSAGE_RECEIVED <BR class="atl-forced-newline"> </TD>
-<TD class="confluenceTd"> Called when data has been received <BR class="atl-forced-newline"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> MESSAGE_SENT </TD>
-<TD class="confluenceTd"> Called when a message has been sent </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> SESSION_IDLE </TD>
-<TD class="confluenceTd"> Called when a session idle time has been reached <BR class="atl-forced-newline"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> EXCEPTION_CAUGHT </TD>
-<TD class="confluenceTd"> Called when an exception has been thrown <BR class="atl-forced-newline"> </TD>
-</TR>
-</TBODY></TABLE>
-</DIV>
+| IoEventType | Description |
+|---|---|
+| SESSION_CREATED | Called when a new session has been created |
+| SESSION_OPENED | Called when a new session has been opened |
+| SESSION_CLOSED | Called when a session has been closed |
+| MESSAGE_RECEIVED | Called when data has been received |
+| MESSAGE_SENT | Called when a message has been sent |
+| SESSION_IDLE | Called when a session idle time has been reached |
+| EXCEPTION_CAUGHT | Called when an exception has been thrown |
+
Here are the descriptions of the LogLevels:
-<DIV class="table-wrap">
-<TABLE class="confluenceTable"><TBODY>
-<TR>
-<TH class="confluenceTh"> LogLevel </TH>
-<TH class="confluenceTh"> Description <BR class="atl-forced-newline"> </TH>
-</TR>
-<TR>
-<TD class="confluenceTd"> NONE </TD>
-<TD class="confluenceTd"> This will result in no log event being created regardless of the configuration <BR class="atl-forced-newline"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> TRACE </TD>
-<TD class="confluenceTd"> Creates a TRACE event in the logging system <BR class="atl-forced-newline"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> DEBUG </TD>
-<TD class="confluenceTd"> Generates debug messages in the logging system <BR class="atl-forced-newline"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> INFO </TD>
-<TD class="confluenceTd"> Generates informational messages in the logging system <BR class="atl-forced-newline"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> WARN </TD>
-<TD class="confluenceTd"> Generates warning messages in the logging system <BR class="atl-forced-newline"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> ERROR </TD>
-<TD class="confluenceTd"> Generates error messages in the logging system <BR class="atl-forced-newline"> </TD>
-</TR>
-</TBODY></TABLE>
-</DIV>
+| LogLevel | Description |
+|---|---|
+| NONE | This will result in no log event being created regardless of the configuration |
+| TRACE | Creates a TRACE event in the logging system |
+| DEBUG | Generates debug messages in the logging system |
+| INFO | Generates informational messages in the logging system |
+| WARN | Generates warning messages in the logging system |
+| ERROR | Generates error messages in the logging system |
With this information, you should be able to get a basic system up and running and be able to expand upon this simple example in order to be generating log information for your system.
Modified: mina/site/trunk/content/mina/userguide/ch14-state-machine/ch14-state-machine.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch14-state-machine/ch14-state-machine.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch14-state-machine/ch14-state-machine.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch14-state-machine/ch14-state-machine.mdtext Thu Nov 1 05:13:12 2012
@@ -38,6 +38,7 @@ Initially, the tape deck is in the __Emp
Now let's write some code. The outside world (the code interfacing with the tape deck) will only see the TapeDeck interface:
+ :::java
public interface TapeDeck {
void load(String nameOfTape);
void eject();
@@ -48,6 +49,7 @@ Now let's write some code. The outside w
Next we will write the class which contains the actual code executed when a transition occurs in the state machine. First we will define the states. The states are all defined as constant String objects and are annotated using the @State annotation:
+ :::java
public class TapeDeckHandler {
@State public static final String EMPTY = "Empty";
@State public static final String LOADED = "Loaded";
@@ -57,6 +59,7 @@ Next we will write the class which conta
Now when we have the states defined we can set up the code corresponding to each transition. Each transition will correspond to a method in TapeDeckHandler. Each transition method is annotated using the @Transition annotation which defines the event id which triggers the transition (on), the start state of the transition (in) and the end state of the transition (next):
+ :::java
public class TapeDeckHandler {
@State public static final String EMPTY = "Empty";
@State public static final String LOADED = "Loaded";
@@ -96,11 +99,13 @@ Please note that the TapeDeckHandler cla
Now, let's have a closer look at some of this code. The @Transition annotation on the loadTape method
+ :::java
@Transition(on = "load", in = EMPTY, next = LOADED)
public void loadTape(String nameOfTape) {
specifies that when the tape deck is in the EMPTY state and the load event occurs the loadTape method will be invoked and then the tape deck will move on to the LOADED state. The @Transition annotations on the pauseTape, stopTape and ejectTape methods should not require any further explanation. The annotation on the playTape method looks slightly different though. As can be seen in the diagram above, when the tape deck is in either the LOADED or in the PAUSED state the play event will play the tape. To have the same method called for multiple transitions the @Transitions annotation has to be used:
+ :::java
@Transitions({
@Transition(on = "play", in = LOADED, next = PLAYING),
@Transition(on = "play", in = PAUSED, next = PLAYING)
@@ -120,6 +125,7 @@ The @Transitions annotation simply lists
Now the final step is to create a StateMachine object from the annotated class and use it to create a proxy object which implements TapeDeck:
+ :::java
public static void main(String[] args) {
TapeDeckHandler handler = new TapeDeckHandler();
StateMachine sm = StateMachineFactory.getInstance(Transition.class).create(TapeDeckHandler.EMPTY, handler);
@@ -135,6 +141,7 @@ Now the final step is to create a StateM
The lines
+ :::java
TapeDeckHandler handler = new TapeDeckHandler();
StateMachine sm = StateMachineFactory.getInstance(Transition.class).create(TapeDeckHandler.EMPTY, handler);
@@ -147,12 +154,14 @@ creates the StateMachine instance from a
The TapeDeck instance is created by calling StateMachineProxyBuilder:
+ :::java
TapeDeck deck = new StateMachineProxyBuilder().create(TapeDeck.class, sm);
The StateMachineProxyBuilder.create() method takes the interfaces the returned proxy object should implement and the StateMachine instance which will receive the events generated by the method calls on the proxy.
When the code is executed the output should be:
+ :::text
Tape 'The Knife - Silent Shout' loaded
Playing tape
Tape paused
@@ -201,11 +210,13 @@ MethodTransition is very important and r
So, if the Event looks like {id = "foo", arguments = [a, b, c]} the method
+ :::java
@Transition(on = "foo")
public void someMethod(One one, Two two, Three three) { ... }
matches if and only if ((a instanceof One && b instanceof Two && c instanceof Three) == true). On match the method will be called with the matching event arguments bound to the method's arguments:
+ :::java
someMethod(a, b, c);
<DIV class="info" markdown="1">
@@ -214,6 +225,7 @@ matches if and only if ((a instanceof On
As stated above also a subset would match:
+ :::java
@Transition(on = "foo")
public void someMethod(Two two) { ... }
@@ -221,11 +233,13 @@ matches if ((a instanceof Two || b insta
A method which takes no arguments always matches if the event id matches:
+ :::java
@Transition(on = "foo")
public void someMethod() { ... }
To make things even more complicated the first two method arguments also matches against the Event class and the StateContext interface. This means that
+ :::java
@Transition(on = "foo")
public void someMethod(Event event, StateContext context, One one, Two two, Three three) { ... }
@Transition(on = "foo")
@@ -237,6 +251,7 @@ also matches the Event {id = "foo", argu
As before a subset of the event arguments can be used. Also, a specific StateContext implementation may be specified instead of using the generic interface:
+ :::java
@Transition(on = "foo")
public void someMethod(MyStateContext context, Two two) { ... }
@@ -248,6 +263,7 @@ If you've made it this far, congratulati
Consider the Event {id = "messageReceived", arguments = [ArrayList a = [...], Integer b = 1024]}. The following methods match this Event:
+ :::java
// All method arguments matches all event arguments directly
@Transition(on = "messageReceived")
public void messageReceived(ArrayList l, Integer i) { ... }
@@ -274,6 +290,7 @@ Consider the Event {id = "messageReceive
The following would not match:
+ :::java
// Incorrect ordering
@Transition(on = "messageReceived")
public void messageReceived(Integer i, List l) { ... }
@@ -300,6 +317,7 @@ State instances may have a parent State.
This feature is useful when you want to add some generic code to all states without having to specify @Transition annotations for each state. Here's how you create a hierarchy of states using the @State annotation:
+ :::java
@State public static final String A = "A";
@State(A) public static final String B = "A->B";
@State(A) public static final String C = "A->C";
@@ -310,6 +328,7 @@ This feature is useful when you want to
Let's go back to the TapeDeck example. What happens if you call deck.play() when there's no tape in the deck? Let's try:
+ :::java
public static void main(String[] args) {
...
deck.load("The Knife - Silent Shout");
@@ -332,6 +351,7 @@ Let's go back to the TapeDeck example. W
Oops! We get an UnhandledEventException because when we're in the Empty state there's no transition which handles the play event. We could add a special transition to all states which handles unmatched Event objects:
+ :::java
@Transitions({
@Transition(on = "*", in = EMPTY, weight = 100),
@Transition(on = "*", in = LOADED, weight = 100),
@@ -351,6 +371,7 @@ Now when you run the main() method above
Now this seems to work very well, right? But what if we had 30 states instead of only 4? Then we would need 30 @Transition annotations on the error() method. Not good. Let's use state inheritance instead:
+ :::java
public static class TapeDeckHandler {
@State public static final String ROOT = "Root";
@State(ROOT) public static final String EMPTY = "Empty";
@@ -399,6 +420,7 @@ The complete code for the TapeDeckServer
Now, let's have a look at how this server works. The important class which implements the state machine is the TapeDeckServer class. The first thing we do is to define the states:
+ :::java
@State public static final String ROOT = "Root";
@State(ROOT) public static final String EMPTY = "Empty";
@State(ROOT) public static final String LOADED = "Loaded";
@@ -407,6 +429,7 @@ Now, let's have a look at how this serve
Nothing new there. However, the methods which handle the events now look different. Let's look at the playTape method:
+ :::java
@IoHandlerTransitions({
@IoHandlerTransition(on = MESSAGE_RECEIVED, in = LOADED, next = PLAYING),
@IoHandlerTransition(on = MESSAGE_RECEIVED, in = PAUSED, next = PLAYING)
@@ -419,12 +442,14 @@ This code doesn't use the general @Trans
We're now using MESSAGE_RECEIVED instead of "play" for the event name (the on attribute in @IoHandlerTransition). This constant is defined in org.apache.mina.statemachine.event.IoHandlerEvents and has the value "messageReceived" which of course corresponds to the messageReceived() method in MINA's IoHandler interface. Thanks to Java5's static imports we don't have to write out the name of the class holding the constant. We just need to put the
+ :::java
import static org.apache.mina.statemachine.event.IoHandlerEvents.*;
statement in the imports section.
Another thing that has changed is that we're using a custom StateContext implementation, TapeDeckContext. This class is used to keep track of the name of the current tape:
+ :::java
static class TapeDeckContext extends AbstractStateContext {
public String tapeName;
}
@@ -438,6 +463,7 @@ The last thing to note about the playTap
Before the tape deck can play anything a tape has to be loaded. When a LoadCommand is received from the client the supplied tape number will be used to get the name of the tape to load from the tapes array of available tapes:
+ :::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) {
@@ -451,12 +477,14 @@ Before the tape deck can play anything a
This code uses the StateControl class to override the next state. If the user specify an unknown tape number we shouldn't move to the LOADED state but instead remain in EMPTY which is what the
+ :::java
StateControl.breakAndGotoNext(EMPTY);
line does. The StateControl class is described more in a later section.
The connect() method will always be called at the start of a session when MINA calls sessionOpened() on the IoHandler:
+ :::java
@IoHandlerTransition(on = SESSION_OPENED, in = EMPTY)
public void connect(IoSession session) {
session.write("+ Greetings from your tape deck!");
@@ -468,6 +496,7 @@ The pauseTape(), stopTape() and ejectTap
Now let's have a look at error handling. The error() method will be called when the client sends a Command which isn't legal in the current state:
+ :::java
@IoHandlerTransition(on = MESSAGE_RECEIVED, in = ROOT, weight = 10)
public void error(Event event, StateContext context, IoSession session, Command cmd) {
session.write("- Cannot " + cmd.getName() + " while "
@@ -484,6 +513,7 @@ The last @IoHandlerTransition method is
The last piece of code we're going to have a look at is the code which creates the IoHandler proxy and the main() method:
+ :::java
private static IoHandler createIoHandler() {
StateMachine sm = StateMachineFactory.getInstance(IoHandlerTransition.class).create(EMPTY, new TapeDeckServer());
Modified: mina/site/trunk/content/mina/userguide/ch16-jmx-support/ch16-jmx-support.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch16-jmx-support/ch16-jmx-support.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch16-jmx-support/ch16-jmx-support.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch16-jmx-support/ch16-jmx-support.mdtext Thu Nov 1 05:13:12 2012
@@ -40,6 +40,7 @@ We shall follow \src\main\java\org\apach
## Create/Get MBean server
+ :::java
// create a JMX MBean Server server instance
MBeanServer mBeanServer = ManagementFactory.getPlatformMBeanServer();
@@ -49,6 +50,7 @@ This lines get the MBean Server instance
We create an MBean for IoService
+ :::java
// create a JMX-aware bean that wraps a MINA IoService object. In this
// case, a NioSocketAcceptor.
IoServiceMBean acceptorMBean = new IoServiceMBean( acceptor );
@@ -59,6 +61,7 @@ Similarly, you can add IoFilterMBean and
## Registering MBeans with MBean Server
+ :::java
// create a JMX ObjectName. This has to be in a specific format.
ObjectName acceptorName = new ObjectName( acceptor.getClass().getPackage().getName() +
":type=acceptor,name=" + acceptor.getClass().getSimpleName());
@@ -84,6 +87,6 @@ If you are using Java 6:
Start JConsole using the following command:
- <JDK_HOME>/bin/jconsole
+ <JDK_HOME>/bin/jconsole
We can see the different attributes and operations that are exposed by the MBeans
Modified: mina/site/trunk/content/mina/userguide/ch17-spring-integration/ch17-spring-integration.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch17-spring-integration/ch17-spring-integration.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch17-spring-integration/ch17-spring-integration.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch17-spring-integration/ch17-spring-integration.mdtext Thu Nov 1 05:13:12 2012
@@ -36,6 +36,7 @@ We shall take a standard MINA applicatio
Lets see the code first. For simplicity we have omitted the glue code.
+ :::java
public void initialize() throws IOException {
// Create an Acceptor
@@ -75,11 +76,13 @@ Now lets pull things together
Lets set the IO Handler in the spring context file
+ :::xml
<!-- The IoHandler implementation -->
<bean id="trapHandler" class="com.ashishpaliwal.udp.mina.server.ServerHandler">
Lets create the Filter chain
+ :::xml
<bean id="snmpCodecFilter" class="org.apache.mina.filter.codec.ProtocolCodecFilter">
<constructor-arg>
<bean class="com.ashishpaliwal.udp.mina.snmp.SNMPCodecFactory" />
@@ -102,6 +105,7 @@ Here, we create instance of our IoFilter
Lets complete the last part of creating the Socket and completing the chain
+ :::xml
<bean class="org.springframework.beans.factory.config.CustomEditorConfigurer">
<property name="customEditors">
<map>
@@ -121,6 +125,7 @@ Lets complete the last part of creating
Now we create our ioAcceptor, set IO handler and Filter Chain. Now we have to write a function to read this file using Spring and start our application. Here's the code
+ :::java
public void initializeViaSpring() throws Exception {
new ClassPathXmlApplicationContext("trapReceiverContext.xml");
}
Modified: mina/site/trunk/content/mina/userguide/ch2-basics/sample-tcp-client.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch2-basics/sample-tcp-client.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch2-basics/sample-tcp-client.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch2-basics/sample-tcp-client.mdtext Thu Nov 1 05:13:12 2012
@@ -30,6 +30,7 @@ We shall use [Sumup Client](http://mina.
We will remove boiler plate code and concentrate on the important constructs. Below the code for the Client :
+ :::java
public static void main(String[] args) throws Throwable {
NioSocketConnector connector = new NioSocketConnector();
connector.setConnectTimeoutMillis(CONNECT_TIMEOUT);
@@ -75,12 +76,14 @@ Lets examine each one in detail
## Create a Connector
+ :::java
NioSocketConnector connector = new NioSocketConnector();
Here we have created a NIO Socket connector
## Create a Filter Chain
+ :::java
if (USE_CUSTOM_CODEC) {
connector.getFilterChain().addLast("codec",
new ProtocolCodecFilter(new SumUpProtocolCodecFactory(false)));
@@ -93,12 +96,14 @@ We add Filters to the Filter Chain for t
## Create IOHandler
+ :::java
connector.setHandler(new ClientSessionHandler(values));
Here we create an instance of [ClientSessionHandler](http://mina.apache.org/report/trunk/xref/org/apache/mina/example/sumup/ClientSessionHandler.html) and set it as a handler for the Connector.
## Bind to Server
+ :::java
IoSession session;
for (;;) {
Modified: mina/site/trunk/content/mina/userguide/ch2-basics/sample-tcp-server.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch2-basics/sample-tcp-server.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch2-basics/sample-tcp-server.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch2-basics/sample-tcp-server.mdtext Thu Nov 1 05:13:12 2012
@@ -42,6 +42,7 @@ We have tested this program on both Wind
We will begin by creating a file called MinaTimeServer.java. The initial code can be found below:
+ :::java
public class MinaTimeServer {
public static void main(String[] args) {
// code will go here next
@@ -50,6 +51,7 @@ We will begin by creating a file called
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 a SocketAcceptor to our program.
+ :::java
import org.apache.mina.transport.socket.nio.NioSocketAcceptor;
public class MinaTimeServer
@@ -62,6 +64,7 @@ This code should be straightforward to a
With the NioSocketAcceptor class in place, we can go ahead and define the handler class and bind the NioSocketAcceptor to a port :
+ :::java
import java.net.InetSocketAddress;
import org.apache.mina.core.service.IoAcceptor;
@@ -81,6 +84,7 @@ As you see, there is a call to acceptor.
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 a ProtocolCodecFilter. This filter will translate binary or protocol specific data into message object and vice versa. We use an existing TextLine factory because it will handle text base message for you (you don't have to write the codec part)
+ :::java
import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.charset.Charset;
@@ -104,6 +108,7 @@ Next we add a filter to the configuratio
At this point, we will define the handler that will be used to service client connections and the requests for the current time. The handler class is a class that must implement the interface IoHandler. 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 class IoHandlerAdapter. This is a class that follows the [adapter design pattern](http://en.wikipedia.org/wiki/Adapter_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 the IoHandler interface.
+ :::java
import java.net.InetSocketAddress;
import java.nio.charset.Charset;
@@ -127,6 +132,7 @@ At this point, we will define the handle
We will now add in the NioSocketAcceptor configuration. This will allow us to make socket-specific settings for the socket that will be used to accept connections from clients.
+ :::java
import java.net.InetSocketAddress;
import java.nio.charset.Charset;
@@ -155,6 +161,7 @@ There are 2 new lines in the MinaTimeSer
The code for the handler is shown below:
+ :::java
import java.util.Date;
import org.apache.mina.core.session.IdleStatus;
@@ -197,6 +204,7 @@ The sessionIdle method will be called on
All that is left to do is define the socket address that the server will listen on, and actually make the call that will start the server. That code is shown below:
+ :::java
import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.charset.Charset;
@@ -227,33 +235,9 @@ All that is left to do is define the soc
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:
-<DIV class="table-wrap">
- <TABLE class="confluenceTable">
- <TBODY>
- <TR>
- <TH class="confluenceTh"> Client Output <BR class="atl-forced-newline"> </TH>
- <TH class="confluenceTh"> Server Output <BR class="atl-forced-newline"> </TH>
- </TR>
- <TR>
- <TD class="confluenceTd">
- user@myhost:~> telnet 127.0.0.1 9123 <BR class="atl-forced-newline">
- Trying 127.0.0.1... <BR class="atl-forced-newline">
- Connected to 127.0.0.1. <BR class="atl-forced-newline">
- Escape character is '^]'. <BR class="atl-forced-newline">
- hello <BR class="atl-forced-newline">
- Wed Oct 17 23:23:36 EDT 2007 <BR class="atl-forced-newline">
- quit <BR class="atl-forced-newline">
- Connection closed by foreign host. <BR class="atl-forced-newline">
- user@myhost:~>
- </TD>
- <TD class="confluenceTd">
- MINA Time server started. <BR class="atl-forced-newline">
- Message written...
- </TD>
- </TR>
- </TBODY>
- </TABLE>
-</DIV>
+| Client Output | Server Output |
+|---|---|
+| user@myhost:~> telnet 127.0.0.1 9123 <br/>Trying 127.0.0.1... <br/>Connected to 127.0.0.1. <br/>Escape character is '^]'. <br/>hello <br/>Wed Oct 17 23:23:36 EDT 2007 <br/>quit <br/>Connection closed by foreign host. <br/>user@myhost:~> | MINA Time server started. <br/>Message written... |
## What's Next?
Modified: mina/site/trunk/content/mina/userguide/ch2-basics/sample-udp-client.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch2-basics/sample-udp-client.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch2-basics/sample-udp-client.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch2-basics/sample-udp-client.mdtext Thu Nov 1 05:13:12 2012
@@ -35,12 +35,14 @@ To implement the Client we need to do fo
We will begin by looking at the file [MemMonClient.java](http://mina.apache.org/report/trunk/xref/org/apache/mina/example/udp/client/MemMonClient.html), found in the org.apache.mina.example.udp.client java package. The first few lines of the code are simple and straightforward.
+ :::java
connector = new NioDatagramConnector();
connector.setHandler( this );
ConnectFuture connFuture = connector.connect( new InetSocketAddress("localhost", MemoryMonitor.PORT ));
Here we create a NioDatagramConnector, set the handler and connect to the server. One gotcha I ran into was that you must set the host in the InetSocketAddress object or else nothing seems to work. This example was mostly written and tested on a Windows XP machine, so things may be different elsewhere. Next we will wait for acknowledgment that the client has connected to the server. Once we know we are connected, we can start writing data to the server. Here is that code:
+ :::java
connFuture.addListener( new IoFutureListener(){
public void operationComplete(IoFuture future) {
ConnectFuture connFuture = (ConnectFuture)future;
@@ -59,6 +61,7 @@ Here we create a NioDatagramConnector, s
Here we add a listener to the ConnectFuture object and when we receive a callback that the client has connected, we will start to write data. The writing of data to the server will be handled by a method called sendData. This method is shown below:
+ :::java
private void sendData() throws InterruptedException {
for (int i = 0; i < 30; i++) {
long free = Runtime.getRuntime().freeMemory();
Modified: mina/site/trunk/content/mina/userguide/ch2-basics/sample-udp-server.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch2-basics/sample-udp-server.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch2-basics/sample-udp-server.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch2-basics/sample-udp-server.mdtext Thu Nov 1 05:13:12 2012
@@ -33,16 +33,19 @@ To construct the server, we shall have t
Here is the first snippet that addresses Point# 1:
+ :::java
NioDatagramAcceptor acceptor = new NioDatagramAcceptor();
acceptor.setHandler(new MemoryMonitorHandler(this));
Here, we create a NioDatagramAcceptor to listen for incoming Client requests, and set the IoHandler.The variable 'PORT' is just an int. The next step is to add a logging filter to the filter chain that this DatagramAcceptor will use. LoggingFilter is a very nice way to see MINA in Action. It generate log statements at various stages, providing an insight into how MINA works.
+ :::java
DefaultIoFilterChainBuilder chain = acceptor.getFilterChain();
chain.addLast("logger", new LoggingFilter());
Next we get into some more specific code for the UDP traffic. We will set the acceptor to reuse the address
+ :::java
DatagramSessionConfig dcfg = acceptor.getSessionConfig();
dcfg.setReuseAddress(true);acceptor.bind(new InetSocketAddress(PORT));
@@ -60,6 +63,7 @@ Lets look at each of them in detail
### Session Created Event
+ :::java
@Override
public void sessionCreated(IoSession session) throws Exception {
SocketAddress remoteAddress = session.getRemoteAddress();
@@ -70,6 +74,7 @@ In the session creation event, we just c
### Message Received Event
+ :::java
@Override
public void messageReceived(IoSession session, Object message) throws Exception {
if (message instanceof IoBuffer) {
@@ -83,6 +88,7 @@ In the message received event, we just d
### Session Closed Event
+ :::java
@Override
public void sessionClosed(IoSession session) throws Exception {
System.out.println("Session closed...");
Modified: mina/site/trunk/content/mina/userguide/ch3-service/acceptor.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch3-service/acceptor.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch3-service/acceptor.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch3-service/acceptor.mdtext Thu Nov 1 05:13:12 2012
@@ -51,6 +51,7 @@ Here is the class diagram for the _IoAcc
You first have to select the type of _IoAcceptor_ you want to instanciate. This is a choice you will made early in the process, as it all boils down to which network protocol you will use. Let's see with an example how it works :
+ :::java
public TcpServer() throws IOException {
// Create a TCP acceptor
IoAcceptor acceptor = new NioSocketAcceptor();
@@ -66,20 +67,23 @@ You first have to select the type of _Io
That's it ! You have created a TCP server. If you want to start an UDP server, simply replace the first line of code :
- ...
- // Create an UDP acceptor
- IoAcceptor acceptor = new NioDatagramAcceptor();
- ...
+ :::java
+ ...
+ // Create an UDP acceptor
+ IoAcceptor acceptor = new NioDatagramAcceptor();
+ ...
## Disposal
The service can be stopped by calling the _dispose()_ method. The service will be stopped only when all the pending sessions have been processed :
+ :::java
// Stop the service, waiting for the pending sessions to be inactive
acceptor.dispose();
You can also wait for every thread being executed to be properly completed by passing a boolean parameter to this method :
+ :::java
// Stop the service, waiting for the processing session to be properly completed
acceptor.dispose( true );
@@ -99,12 +103,14 @@ You can add or get the associated _IoHan
if you want to manage the filters chain, you will have to call the _getFilterChain()_ method. Here is an example :
+ :::java
// Add a logger filter
DefaultIoFilterChainBuilder chain = acceptor.getFilterChain();
chain.addLast("logger", new LoggingFilter());
You can also create the chain before and set it into the service :
+ :::java
// Add a logger filter
DefaultIoFilterChainBuilder chain = new DefaultIoFilterChainBuilder();
chain.addLast("logger", new LoggingFilter());
Modified: mina/site/trunk/content/mina/userguide/ch4-session/ch4-session.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch4-session/ch4-session.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch4-session/ch4-session.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch4-session/ch4-session.mdtext Thu Nov 1 05:13:12 2012
@@ -61,6 +61,7 @@ It might be necessary to store some data
For instance, if you want to track the number of request a user has sent since the session has been created, it's easy to store it into this map: just create a key that will be associated with this value.
+ :::java
...
int counterValue = session.getAttribute( "counter" );
session.setAttribute( "counter", counterValue + 1 );
@@ -76,6 +77,7 @@ As we said, this container is a key/valu
This snippet of code shows how the container is created during the session initialization :
+ :::java
protected final void initSession(IoSession session,
IoFuture future, IoSessionInitializer sessionInitializer) {
...
@@ -122,6 +124,7 @@ and many other useful informations.
Last, not least, a session is attached to a Handler, in charge of dispatching the messages to your application. This handler will also send pack response by using the session, simply by calling the write() method :
+ :::java
...
- session.write( <your message> );
+ session.write( <your message> );
...
Modified: mina/site/trunk/content/mina/userguide/ch5-filters/ch5-filters.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch5-filters/ch5-filters.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch5-filters/ch5-filters.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch5-filters/ch5-filters.mdtext Thu Nov 1 05:13:12 2012
@@ -40,120 +40,34 @@ In this tutorial, we will walk through h
We have many filters already written. The following table list all the existing filters, with a short description of their usage.
-<DIV class="table-wrap">
-<TABLE class="confluenceTable"><TBODY>
-<TR>
-<TH class="confluenceTh"> Filter </TH>
-<TH class="confluenceTh"> class </TH>
-<TH class="confluenceTh"> Description </TH>
-</TR>
-<TR>
-<TD class="confluenceTd"> Blacklist </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/firewall/BlacklistFilter.html" class="external-link" rel="nofollow">BlacklistFilter</A></TT> </TD>
-<TD class="confluenceTd"> Blocks connections from blacklisted remote addresses<BR class="atl-forced-newline"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Buffered Write </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/buffer/BufferedWriteFilter.html" class="external-link" rel="nofollow">BufferedWriteFilter</A></TT> </TD>
-<TD class="confluenceTd"> Buffers outgoing requests like the BufferedOutputStream does </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Compression </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/compression/CompressionFilter.html" class="external-link" rel="nofollow">CompressionFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> ConnectionThrottle </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/firewall/ConnectionThrottleFilter.html" class="external-link" rel="nofollow">ConnectionThrottleFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> ErrorGenerating </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/errorgenerating/ErrorGeneratingFilter.html" class="external-link" rel="nofollow">ErrorGeneratingFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Executor </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/executor/ExecutorFilter.html" class="external-link" rel="nofollow">ExecutorFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> FileRegionWrite </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/stream/FileRegionWriteFilter.html" class="external-link" rel="nofollow">FileRegionWriteFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> KeepAlive </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/keepalive/KeepAliveFilter.html" class="external-link" rel="nofollow">KeepAliveFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Logging </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/logging/LoggingFilter.html" class="external-link" rel="nofollow">LoggingFilter</A></TT> </TD>
-<TD class="confluenceTd"> Logs event messages, like MessageReceived, MessageSent, SessionOpened, ... </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> MDC Injection </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/logging/MdcInjectionFilter.html" class="external-link" rel="nofollow">MdcInjectionFilter</A></TT> </TD>
-<TD class="confluenceTd"> Inject key IoSession properties into the MDC </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Noop </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/util/NoopFilter.html" class="external-link" rel="nofollow">NoopFilter</A></TT> </TD>
-<TD class="confluenceTd"> A filter that does nothing. Useful for tests. </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Profiler </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/statistic/ProfilerTimerFilter.html" class="external-link" rel="nofollow">ProfilerTimerFilter</A></TT> </TD>
-<TD class="confluenceTd"> Profile event messages, like MessageReceived, MessageSent, SessionOpened, ... </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> ProtocolCodec </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/codec/ProtocolCodecFilter.html" class="external-link" rel="nofollow">ProtocolCodecFilter</A></TT> </TD>
-<TD class="confluenceTd"> A filter in charge of encoding and decoding messages </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Proxy </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/proxy/filter/ProxyFilter.html" class="external-link" rel="nofollow">ProxyFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> Reference counting </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/util/ReferenceCountingFilter.html" class="external-link" rel="nofollow">ReferenceCountingFilter</A></TT> </TD>
-<TD class="confluenceTd"> Keeps track of the number of usages of this filter </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> RequestResponse </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/reqres/RequestResponseFilter.html" class="external-link" rel="nofollow">RequestResponseFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> SessionAttributeInitializing </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/util/SessionAttributeInitializingFilter.html" class="external-link" rel="nofollow">SessionAttributeInitializingFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> StreamWrite </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/stream/StreamWriteFilter.html" class="external-link" rel="nofollow">StreamWriteFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> SslFilter </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/ssl/SslFilter.html" class="external-link" rel="nofollow">SslFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-<TR>
-<TD class="confluenceTd"> WriteRequest </TD>
-<TD class="confluenceTd"> <TT><A href="http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/util/WriteRequestFilter.html" class="external-link" rel="nofollow">WriteRequestFilter</A></TT> </TD>
-<TD class="confluenceTd"> </TD>
-</TR>
-</TBODY></TABLE>
-</DIV>
+| Filter | class | Description |
+|---|---|---|
+| Blacklist | [BlacklistFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/firewall/BlacklistFilter.html) | Blocks connections from blacklisted remote addresses<BR class="atl-forced-newline"> |
+| Buffered Write | [BufferedWriteFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/buffer/BufferedWriteFilter.html) | Buffers outgoing requests like the BufferedOutputStream does |
+| Compression | [CompressionFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/compression/CompressionFilter.html) | |
+| ConnectionThrottle | [ConnectionThrottleFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/firewall/ConnectionThrottleFilter.html) | |
+| ErrorGenerating | [ErrorGeneratingFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/errorgenerating/ErrorGeneratingFilter.html) | |
+| Executor | [ExecutorFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/executor/ExecutorFilter.html) | |
+| FileRegionWrite | [FileRegionWriteFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/stream/FileRegionWriteFilter.html) | |
+| KeepAlive | [KeepAliveFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/keepalive/KeepAliveFilter.html) | |
+| Logging | [LoggingFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/logging/LoggingFilter.html) | Logs event messages, like MessageReceived, MessageSent, SessionOpened, ... |
+| MDC Injection | [MdcInjectionFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/logging/MdcInjectionFilter.html) | Inject key IoSession properties into the MDC |
+| Noop | [NoopFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/util/NoopFilter.html) | A filter that does nothing. Useful for tests. |
+| Profiler | [ProfilerTimerFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/statistic/ProfilerTimerFilter.html) | Profile event messages, like MessageReceived, MessageSent, SessionOpened, ... |
+| ProtocolCodec | [ProtocolCodecFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/codec/ProtocolCodecFilter.html) | A filter in charge of encoding and decoding messages |
+| Proxy | [ProxyFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/proxy/filter/ProxyFilter.html) | |
+| Reference counting | [ReferenceCountingFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/util/ReferenceCountingFilter.html) | Keeps track of the number of usages of this filter |
+| RequestResponse | [RequestResponseFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/reqres/RequestResponseFilter.html) | |
+| SessionAttributeInitializing | [SessionAttributeInitializingFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/util/SessionAttributeInitializingFilter.html) | |
+| StreamWrite | [StreamWriteFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/stream/StreamWriteFilter.html) | |
+| SslFilter | [SslFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/ssl/SslFilter.html) | |
+| WriteRequest | [WriteRequestFilter](http://mina.apache.org/report/trunk/xref/org/apache/mina/filter/util/WriteRequestFilter.html) | |
## Overriding Events Selectively
You can extend IoAdapter instead of implementing IoFilter directly. Unless overriden, any received events will be forward to the next filter immediately:
+ :::java
public class MyFilter extends IoFilterAdapter {
@Override
public void sessionOpened(NextFilter nextFilter, IoSession session) throws Exception {
@@ -171,6 +85,7 @@ Please also note that you still need to
Let's assume that you are implementing a filter that transforms a String into a char[]. Your filter's filterWrite() will look like the following:
+ :::java
public void filterWrite(NextFilter nextFilter, IoSession session, WriteRequest request) {
nextFilter.filterWrite(
session, new DefaultWriteRequest(
@@ -179,12 +94,14 @@ Let's assume that you are implementing a
Now, we need to do the reverse in messageSent():
+ :::java
public void messageSent(NextFilter nextFilter, IoSession session, Object message) {
nextFilter.messageSent(session, new String((char[]) message));
}
What about String-to-ByteBuffer transformation? We can be a little bit more efficient because we don't need to reconstruct the original message (String). However, it's somewhat more complex than the previous example:
+ :::java
public void filterWrite(NextFilter nextFilter, IoSession session, WriteRequest request) {
String m = (String) request.getMessage();
ByteBuffer newBuffer = new MyByteBuffer(m, ByteBuffer.wrap(m.getBytes());
@@ -215,6 +132,7 @@ If you are using MINA 2.0, it will be so
sessionCreated is a special event that must be executed in the I/O processor thread (see Configuring Thread Model). Never forward sessionCreated event to the other thread.
+ :::java
public void sessionCreated(NextFilter nextFilter, IoSession session) throws Exception {
// ...
nextFilter.sessionCreated(session);
@@ -234,6 +152,7 @@ MINA uses an empty buffer as an internal
ProtocolCodecFilter uses an empty buffer (i.e. buf.hasRemaining() = 0) to mark the end of the message. If your filter is placed before the ProtocolCodecFilter, please make sure your filter forward the empty buffer to the next filter if your filter implementation can throw a unexpected exception if the buffer is empty:
+ :::java
public void messageSent(NextFilter nextFilter, IoSession session, Object message) {
if (message instanceof ByteBuffer && !((ByteBuffer) message).hasRemaining()) {
nextFilter.messageSent(nextFilter, session, message);
Modified: mina/site/trunk/content/mina/userguide/ch6-transports/apr-transport.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch6-transports/apr-transport.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch6-transports/apr-transport.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch6-transports/apr-transport.mdtext Thu Nov 1 05:13:12 2012
@@ -41,6 +41,7 @@ Refer [Time Server](http://mina.apache.o
Lets see how NIO based Time server implementation looks like
+ :::java
IoAcceptor acceptor = new NioSocketAcceptor();
acceptor.getFilterChain().addLast( "logger", new LoggingFilter() );
@@ -55,6 +56,7 @@ Lets see how NIO based Time server imple
Lets see how to use APR Transport
+ :::java
IoAcceptor acceptor = new AprSocketAcceptor();
acceptor.getFilterChain().addLast( "logger", new LoggingFilter() );
Modified: mina/site/trunk/content/mina/userguide/ch6-transports/serial-transport.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch6-transports/serial-transport.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch6-transports/serial-transport.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch6-transports/serial-transport.mdtext Thu Nov 1 05:13:12 2012
@@ -51,6 +51,7 @@ At this point you are supposed to have a
Now for connecting to a serial port you need a SerialConnector :
+ :::java
// create your connector
IoConnector connector = new SerialConnector()
connector.setHandler( ... here your buisness logic IoHandler ... );
@@ -59,6 +60,7 @@ Nothing very different of a SocketConnec
Let's create an address for connecting to our serial port.
+ :::java
SerialAddress portAddress=new SerialAddress( "/dev/ttyS0", 38400, 8, StopBits.BITS_1, Parity.NONE, FlowControl.NONE );
The first parameter is your port identifier. For Windows computer, the serial ports are called "COM1", "COM2", etc... For Linux and some other Unix : "/dev/ttyS0", "/dev/ttyS1", "/dev/ttyUSB0".
@@ -72,6 +74,7 @@ The remaining parameters are depending o
Once it's done, connect the connector to the address :
+ :::java
ConnectFuture future = connector.connect( portAddress );
future.await();
IoSession sessin = future.getSession();
Modified: mina/site/trunk/content/mina/userguide/ch7-handler/ch7-handler.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch7-handler/ch7-handler.mdtext?rev=1404465&r1=1404464&r2=1404465&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch7-handler/ch7-handler.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch7-handler/ch7-handler.mdtext Thu Nov 1 05:13:12 2012
@@ -40,7 +40,7 @@ IoHandler has following functions
Session Created event is fired when a new connection is created. For TCP its the result of connection accept, and for UDP this is generated when a UDP packet is received. This function can be used to initialize session attributes, and perform one time activities for a particular connection.
- This function is invoked from the I/O processor thread context, hence should be implemented in a way that it consumes minimal amount of time, as the same thread handles multiple sessions.
+This function is invoked from the I/O processor thread context, hence should be implemented in a way that it consumes minimal amount of time, as the same thread handles multiple sessions.
## sessionOpened Event