This is an automated email from the ASF dual-hosted git repository. elecharny pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/mina-site.git
commit 887c35681545611c1620d2b1ffa1841e571099e9 Author: Roy Lenferink <lenferink...@gmail.com> AuthorDate: Thu Feb 27 13:50:48 2020 +0100 Fixed displaying of html characters --- layouts/shortcodes/html.html | 1 + source/asyncweb-project/contributors.md | 2 +- source/contributors.md | 6 ++-- .../ftpserver-project/configuration_listeners.md | 10 +++--- source/ftpserver-project/configuration_server.md | 4 +-- .../configuration_user_manager_db.md | 22 ++++++------ .../configuration_user_manager_file.md | 2 +- source/ftpserver-project/contributors.md | 2 +- source/ftpserver-project/ftplet.md | 20 +++++------ source/ftpserver-project/managing_users.md | 36 +++++++++++-------- source/ftpserver-project/messages.md | 4 +-- source/mina-project/__index.md | 8 ++--- source/mina-project/conferences.md | 2 +- source/mina-project/documentation.md | 2 +- source/mina-project/features.md | 3 +- source/mina-project/testimonials.md | 8 ++--- .../ch1-getting-started/ch1.3-features.md | 2 +- .../ch2-basics/ch2.1-application-architecture.md | 2 +- .../ch2-basics/ch2.2-sample-tcp-server.md | 2 +- .../ch2-basics/ch2.3-sample-tcp-client.md | 2 +- .../userguide/ch4-session/ch4-session.md | 2 +- .../userguide/ch5-filters/ch5-filters.md | 24 ++++++------- source/special-thanks.md | 4 +-- source/sshd-project/contributors.md | 6 ++-- source/vysper-project/embed.md | 12 +++---- source/vysper-project/service_discovery.md | 6 ++-- source/vysper-project/socks5.md | 2 +- source/vysper-project/standards_supported.md | 40 +++++++++++----------- 28 files changed, 120 insertions(+), 116 deletions(-) diff --git a/layouts/shortcodes/html.html b/layouts/shortcodes/html.html new file mode 100644 index 0000000..6755cc9 --- /dev/null +++ b/layouts/shortcodes/html.html @@ -0,0 +1 @@ +{{ $html := .Get 0 }}{{ safeHTML $html }} \ No newline at end of file diff --git a/source/asyncweb-project/contributors.md b/source/asyncweb-project/contributors.md index df70358..88e9b48 100644 --- a/source/asyncweb-project/contributors.md +++ b/source/asyncweb-project/contributors.md @@ -12,7 +12,7 @@ The following is a list of developers with commit privileges that have directly * Jeff Genender * Mike Heath * Alex Karasulu -* Emmanuel Lécharny +* Emmanuel L{{< html "é" >}}charny * Sangjin Lee * Trustin Lee * Rick McGuire diff --git a/source/contributors.md b/source/contributors.md index 69f52d6..bf9512a 100644 --- a/source/contributors.md +++ b/source/contributors.md @@ -6,9 +6,9 @@ title: Apache MINA - Contributors * Alex Karasulu (akarasulu) * [Ashish Paliwal](http://ashishpaliwal.com/blog) (apaliwal) -* [Emmanuel Lécharny](http://www.iktek.com) (elecharny) +* [Emmanuel L{{< html "é" >}}charny](http://www.iktek.com) (elecharny) * Guillaume Nodet (gnodet) -* Jean-François Maury (chairman) (jeffmaury) +* Jean-Fran{{< html "ç" >}}ois Maury (chairman) (jeffmaury) * Jeff Genender (jgenender) * Jonathan Valliere (johnnyv) * [Julien Vermillard](http://people.apache.org/~jvermillard/) (jvermillard) @@ -26,7 +26,7 @@ title: Apache MINA - Contributors * Lyor Goldstein (lgoldstein) * Michael Jakl (mjakl) * Mike Mahonay (foodmike) -* Raphaël P. Barazzutti (rbarazzutti) +* Rapha{{< html "ë" >}}l P. Barazzutti (rbarazzutti) * Richard McGuire (rickmcguire) * Sai Pullabhotla (sai) * Sangjin Lee (sjlee) diff --git a/source/ftpserver-project/configuration_listeners.md b/source/ftpserver-project/configuration_listeners.md index f06f45f..1e1a646 100644 --- a/source/ftpserver-project/configuration_listeners.md +++ b/source/ftpserver-project/configuration_listeners.md @@ -39,7 +39,7 @@ The listener shipped with FtpServer is called "nio-listener" since it is based J | Attribute | Description | Required | Default value | |---|---|---|---| -| name | The listener name, if "default" it will override the settings on the default listener | Yes | | +| name | The listener name, if "default" it will override the settings on the default listener | Yes | {{< html " " >}} | | port | The port on which the listener will accept connections | No | 21 | | local-address | Server address the listener will bind to | No | All available | | implicit-ssl | True if the listener should use implicit SSL | No | false | @@ -61,8 +61,8 @@ This element is required if the ssl element is provided. It provides configurati | Attribute | Description | Required | Default value | |---|---|---|---| -| file | Path to the key store file | Yes | | -| password | The password for the key store | Yes | | +| file | Path to the key store file | Yes | {{< html " " >}} | +| password | The password for the key store | Yes | {{< html " " >}} | | key-password | Password for the key within the key store | No | Key store password | | key-alias | Alias of the key to use within the key store | No <| Uses first key found | | type | Key store type | No | JRE key store default type, normally JKS | @@ -73,7 +73,7 @@ This element provides configuration for the trust store used for locating truste | Attribute | Description | Required | Default value | |---|---|---|---| -| file | Path to the trust store file | Yes | | +| file | Path to the trust store file | Yes | {{< html " " >}} | | password | The password for the trust store | No | Certificates can be read without password | | type | Trust store type | No | JRE key store default type, normally JKS | | algorithm | Trust store algorithm | No | SunX509 |> @@ -106,7 +106,7 @@ This element provides configuration for passive data connections. |---|---|---|---| | ports| The ports on which the server is allowed to accept passive data connections, see [Configure passive ports](configuration_passive_ports.html) for details| No| Any available port | | address| The address on which the server will listen to passive data connections| No| The same address as the control socket for the session | -| external-address| The address the server will claim to be listening on in the PASV reply. Useful when the server is behind a NAT firewall and the client sees a different address than the server is using| No| | +| external-address| The address the server will claim to be listening on in the PASV reply. Useful when the server is behind a NAT firewall and the client sees a different address than the server is using | No | {{< html " " >}} | ## blacklist element diff --git a/source/ftpserver-project/configuration_server.md b/source/ftpserver-project/configuration_server.md index 7d81911..ce51108 100644 --- a/source/ftpserver-project/configuration_server.md +++ b/source/ftpserver-project/configuration_server.md @@ -27,12 +27,10 @@ Using the XML configuration, this following examples shows all available configu | Attribute | Description | Required | Default value | |---|---|---|---| -| id | A unique identifier for this server within this XML configuration | Yes | | +| id | A unique identifier for this server within this XML configuration | Yes | {{< html " " >}} | | max-threads | The maximum number of threads used in the thread pool for handling client connections | No | max-logins, or 16 if neither value is set | | max-logins | The maximum number of simultaneous users | No | 10 | | max-anon-logins | The maximum number of simultaneous anonymous users | No | 10 | | anon-enabled | Are anonymous logins enabled? | No | true | | max-login-failures | The number of failed login attempts before the connection is closed | No | 3 | | login-failure-delay | The number of milliseconds that the connection is delayed after a failed login attempt. Used to limit to possibility of brute force guessing passwords. | No | 500 | - - diff --git a/source/ftpserver-project/configuration_user_manager_db.md b/source/ftpserver-project/configuration_user_manager_db.md index 9f4eddc..334f4ba 100644 --- a/source/ftpserver-project/configuration_user_manager_db.md +++ b/source/ftpserver-project/configuration_user_manager_db.md @@ -66,14 +66,14 @@ You must include the required JAR files for your database in the classpath of Ft | Child element | Description | Required | Default value | |---|---|---|---| -| data-source | The data source configured using the regular Spring bean element | Yes | | -| insert-user | The SQL statement to insert a new user. All the dynamic values will be replaced during runtime. | Yes | | -| update-user | The SQL statement to update a user. All the dynamic values will be replaced during runtime. | Yes | | -| delete-user | The SQL statement to delete a user. All the dynamic values will be replaced during runtime. | Yes | | -| select-user | The SQL statement to select a user. All the dynamic values will be replaced during runtime. | Yes | | -| select-all-users | The SQL statement to select all users. All the dynamic values will be replaced during runtime. | Yes | | -| is-admin | The SQL statement to find whether an user is admin or not. All the dynamic values will be replaced during runtime. | Yes | | -| authenticate | The SQL statement to authenticate a user. All the dynamic values will be replaced during runtime. | Yes | | +| data-source | The data source configured using the regular Spring bean element | Yes | {{< html " " >}} | +| insert-user | The SQL statement to insert a new user. All the dynamic values will be replaced during runtime. | Yes | {{< html " " >}} | +| update-user | The SQL statement to update a user. All the dynamic values will be replaced during runtime. | Yes | {{< html " " >}} | +| delete-user | The SQL statement to delete a user. All the dynamic values will be replaced during runtime. | Yes | {{< html " " >}} | +| select-user | The SQL statement to select a user. All the dynamic values will be replaced during runtime. | Yes | {{< html " " >}} | +| select-all-users | The SQL statement to select all users. All the dynamic values will be replaced during runtime. | Yes | {{< html " " >}} | +| is-admin | The SQL statement to find whether an user is admin or not. All the dynamic values will be replaced during runtime. | Yes | {{< html " " >}} | +| authenticate | The SQL statement to authenticate a user. All the dynamic values will be replaced during runtime. | Yes | {{< html " " >}} | ### Data source configuration @@ -96,9 +96,9 @@ The data source must be configured as described by the database provider. You ca | Column | Type | Default value | |---|---|---| -| userid | VARCHAR(64), Primary key | | -| userpassword | VARCHAR(64) | | -| homedirectory | VARCHAR(128) | | +| userid | VARCHAR(64), Primary key | {{< html " " >}} | +| userpassword | VARCHAR(64) | {{< html " " >}} | +| homedirectory | VARCHAR(128) | {{< html " " >}} | | enableflag | BOOLEAN | TRUE | | writepermission | BOOLEAN | FALSE | | idletime | INT | 0 | diff --git a/source/ftpserver-project/configuration_user_manager_file.md b/source/ftpserver-project/configuration_user_manager_file.md index 5cc6311..bcc07b2 100644 --- a/source/ftpserver-project/configuration_user_manager_file.md +++ b/source/ftpserver-project/configuration_user_manager_file.md @@ -17,5 +17,5 @@ This is the default user manager. It uses a properties file to store all the use | Attribute | Description | Required | Default value | |---|---|---|---| -| file | Path to the properties file for storing users | Yes | | +| file | Path to the properties file for storing users | Yes | {{< html " " >}} | | encrypt-passwords | It indicates how to stored password are encrypted. Possible values are "clear" for clear text, "md5" for hashed using MD5 or "salted" for hashed salted passwords (including multiple hash iterations). "salted" is encouraged. | No | md5 | diff --git a/source/ftpserver-project/contributors.md b/source/ftpserver-project/contributors.md index 58f46eb..838a53d 100644 --- a/source/ftpserver-project/contributors.md +++ b/source/ftpserver-project/contributors.md @@ -13,6 +13,6 @@ The following is a list of developers with commit privileges that have directly * [Niklas Gustavsson](http://protocol7.com/) * Paul Hammant * David Latorre -* Emmanuel Lécharny +* Emmanuel L{{< html "é" >}}charny * Sai Pullabhotla * Sergey M Vladimirov diff --git a/source/ftpserver-project/ftplet.md b/source/ftpserver-project/ftplet.md index 98259d4..9c29376 100644 --- a/source/ftpserver-project/ftplet.md +++ b/source/ftpserver-project/ftplet.md @@ -83,13 +83,13 @@ This section gives an overview on different response codes which might be useful | onConnect | 220 | Service ready for new user. | | onConnect | 530 | No server access from the IP. | | onConnect | 530 | Maximum server connection has been reached. | -| onDisconnect | | | -| onLogin | | | +| onDisconnect | {{< html " " >}} | {{< html " " >}} | +| onLogin | {{< html " " >}} | {{< html " " >}} | | onDeleteStart | 250 | Requested file action okay | | onDeleteStart | 450 | No permission to delete. | | onDeleteStart | 550 | Not a valid file. | | onDeleteStart | 450 | Can't delete file. | -| onDeleteEnd | | | +| onDeleteEnd | {{< html " " >}} | {{< html " " >}} | | onUploadStart | 150 | File status okay; about to open data connection. | | onUploadStart | 226 | Transfer complete. | | onUploadStart | 550 | Invalid path. | @@ -97,7 +97,7 @@ This section gives an overview on different response codes which might be useful | onUploadStart | 425 | Can't open data connection. | | onUploadStart | 426 | Data connection error. | | onUploadStart | 551 | Error on output file. | -| onUploadEnd | | | +| onUploadEnd | {{< html " " >}} | {{< html " " >}} | | onDownloadStart | 150 | File status okay; about to open data connection. | | onDownloadStart | 226 | Transfer complete. | | onDownloadStart | 550 | No such file or directory. | @@ -106,18 +106,18 @@ This section gives an overview on different response codes which might be useful | onDownloadStart | 425 | Can't open data connection. | | onDownloadStart | 426 | Data connection error. | | onDownloadStart | 551 | Error on input file. | -| onDownloadEnd | | | +| onDownloadEnd | {{< html " " >}} | {{< html " " >}} | | onRmdirStart | 250 | Directory removed. | | onRmdirStart | 550 | Not a valid directory. | | onRmdirStart | 550 | Permission denied. | | onRmdirStart | 550 | Can't remove directory. | -| onRmdirEnd | | | +| onRmdirEnd | {{< html " " >}} | {{< html " " >}} | | onMkdirStart | 250 | Directory created. | | onMkdirStart | 550 | Not a valid file. | | onMkdirStart | 550 | Permission denied | | onMkdirStart | 550 | Directory already exists. | | onMkdirStart | 550 | Can't create directory. | -| onMkdirEnd | | | +| onMkdirEnd | {{< html " " >}} | {{< html " " >}} | | onAppendStart | 150 | File status okay; about to open data connection. | | onAppendStart | 226 | Transfer complete. | | onAppendStart | 550 | Not a plain file. | @@ -125,7 +125,7 @@ This section gives an overview on different response codes which might be useful | onAppendStart | 425 | Can't open data connection. | | onAppendStart | 426 | Data connection error. | | onAppendStart | 551 | Error on output file. | -| onAppendEnd | | | +| onAppendEnd | {{< html " " >}} | {{< html " " >}} | | onUploadUniqueStart | 150 | File status okay; about to open data connection. | | onUploadUniqueStart | 250 | filename: Transfer started. | | onUploadUniqueStart | 226 | filename: Transfer complete. | @@ -134,14 +134,14 @@ This section gives an overview on different response codes which might be useful | onUploadUniqueStart | 425 | Can't open data connection. | | onUploadUniqueStart | 426 | Data connection error. | | onUploadUniqueStart | 551 | Error on output file. | -| onUploadUniqueEnd | | | +| onUploadUniqueEnd | {{< html " " >}} | {{< html " " >}} | | onRenameStart | 250 | Requested file action okay, file renamed. | | onRenameStart | 503 | Can't find the file which has to be renamed. | | onRenameStart | 553 | Not a valid file name. | | onRenameStart | 553 | Permission denied. | | onRenameStart | 553 | No such file or directory. | | onRenameStart | 553 | Can't rename file. | -| onRenameEnd | | | +| onRenameEnd | {{< html " " >}} | {{< html " " >}} | | onSite | 200 | Command SITE okay. | | onSite | 530 | Permission denied. | | onSite | 502 | Not implemented. | diff --git a/source/ftpserver-project/managing_users.md b/source/ftpserver-project/managing_users.md index 4d55a81..cf45acc 100644 --- a/source/ftpserver-project/managing_users.md +++ b/source/ftpserver-project/managing_users.md @@ -15,15 +15,17 @@ Using either the PropertiesUserManager or DbUserManager you can access the data Using the FtpServer API, you can create a user manager, configure it as your real user manager and use that to edit users. This is a simple example: - PropertiesUserManagerFactory userManagerFactory = new PropertiesUserManagerFactory(); - userManagerFactory.setFile(new File("myusers.properties")); - userManagerFactory.setPasswordEncryptor(new SaltedPasswordEncryptor()); - UserManager um = userManagerFactory.createUserManager(); - BaseUser user = new BaseUser(); - user.setName("myNewUser"); - user.setPassword("secret"); - user.setHomeDirectory("ftproot"); - um.save(user); +```java +PropertiesUserManagerFactory userManagerFactory = new PropertiesUserManagerFactory(); +userManagerFactory.setFile(new File("myusers.properties")); +userManagerFactory.setPasswordEncryptor(new SaltedPasswordEncryptor()); +UserManager um = userManagerFactory.createUserManager(); +BaseUser user = new BaseUser(); +user.setName("myNewUser"); +user.setPassword("secret"); +user.setHomeDirectory("ftproot"); +um.save(user); +``` ## Using command line tool @@ -33,14 +35,18 @@ In the examples below, make sure you update the versions to reflect the correct Windows: - java -cp ftpserver-core-1.0.0-M4.jar;ftplet-api-1.0.0-M4.jar;mina-core-2.0.0-M3.jar; - [slf4j-api-1.5.2.jar;<br>slf4j-simple-1.5.2.jar - [ org.apache.ftpserver.main.AddUser path/to/your/config.xml +```bash +java -cp ftpserver-core-1.0.0-M4.jar;ftplet-api-1.0.0-M4.jar;mina-core-2.0.0-M3.jar; + [slf4j-api-1.5.2.jar;<br>slf4j-simple-1.5.2.jar + [ org.apache.ftpserver.main.AddUser path/to/your/config.xml +``` MacOS/Linux/Unix - java -cp ftpserver-core-1.0.0-M4.jar:ftplet-api-1.0.0-M4.jar:mina-core-2.0.0-M3.jar:\ - slf4j-api-1.5.2.jar:<br>slf4j-simple-1.5.2.jar \ - org.apache.ftpserver.main.AddUser path/to/your/config.xml +```bash +java -cp ftpserver-core-1.0.0-M4.jar:ftplet-api-1.0.0-M4.jar:mina-core-2.0.0-M3.jar:\ + slf4j-api-1.5.2.jar:<br>slf4j-simple-1.5.2.jar \ + org.apache.ftpserver.main.AddUser path/to/your/config.xml +``` The program will ask you for the required data. diff --git a/source/ftpserver-project/messages.md b/source/ftpserver-project/messages.md index 7e20b75..06dfee5 100644 --- a/source/ftpserver-project/messages.md +++ b/source/ftpserver-project/messages.md @@ -19,8 +19,8 @@ The FtpServer project is interested in localized message bundles, please [contac | Attribute | Description | Required | Default value | |--|--|--|--| -| directory | The directory in which message bundles can be located | No | | -| languages | A comma separated list of the languages that the server will provide messages in | No | | +| directory | The directory in which message bundles can be located | No | {{< html " " >}} | +| languages | A comma separated list of the languages that the server will provide messages in | No | {{< html " " >}} | ## Creating a customized message bundle diff --git a/source/mina-project/__index.md b/source/mina-project/__index.md index 6af993b..ea89ae2 100644 --- a/source/mina-project/__index.md +++ b/source/mina-project/__index.md @@ -8,13 +8,13 @@ slug: index ## Overview -Apache <abbr title="Multipurpose Infrastructure for Network Applications">MINA</abbr> is a network application framework which helps users develop high performance and high scalability network applications easily. It provides an abstract ·event-driven · asynchronous API over various transports such as TCP/IP and UDP/IP via Java NIO. +Apache <abbr title="Multipurpose Infrastructure for Network Applications">MINA</abbr> is a network application framework which helps users develop high performance and high scalability network applications easily. It provides an abstract {{< html "·" >}} event-driven · asynchronous API over various transports such as TCP/IP and UDP/IP via Java NIO. Apache MINA is often called: -* NIO framework · library, -* client · server framework · library, or -* a networking · socket library. +* NIO framework {{< html "·" >}} library, +* client {{< html "·" >}} server framework {{< html "·" >}} library, or +* a networking {{< html "·" >}} socket library. However, it's much more than that. Please take a look around the list of the *[features](features.html)* that enable rapid network application development, and *[what people says about MINA](testimonials.html)*. diff --git a/source/mina-project/conferences.md b/source/mina-project/conferences.md index cd0a8b7..da63aca 100644 --- a/source/mina-project/conferences.md +++ b/source/mina-project/conferences.md @@ -6,7 +6,7 @@ title: MINA Presentation Materials # Presentation Materials These presentation materials will help you understand the overall architecture and core constructs of MINA. -* [MINA in real life](/assets/pdfs/Mina_in_real_life_ASEU-2009.pdf) (ApacheCon EU 2009) by Emmanuel Lécharny +* [MINA in real life](/assets/pdfs/Mina_in_real_life_ASEU-2009.pdf) (ApacheCon EU 2009) by Emmanuel L{{< html "é" >}}charny * [Rapid Network Application Development with Apache MINA](/assets/pdfs/JavaOne2008.pdf) (JavaOne 2008) by Trustin Lee * [Apache MINA - The High Performance Protocol Construction Toolkit](/assets/pdfs/ACUS2007.pdf) (ApacheCon US 2007) by Peter Royal * [Introduction to MINA (ApacheCon Asia 2006)](/assets/pdfs/ACAsia2006.pdf) by Trustin Lee diff --git a/source/mina-project/documentation.md b/source/mina-project/documentation.md index d531ce4..c88281e 100644 --- a/source/mina-project/documentation.md +++ b/source/mina-project/documentation.md @@ -15,7 +15,7 @@ title: Documentation These presentation materials will help you understand the overall architecture and core constructs of MINA -* [MINA in real life (ApacheCon EU 2009)](resources/Mina_in_real_life_ASEU-2009.pdf) by Emmanuel Lécharny +* [MINA in real life (ApacheCon EU 2009)](resources/Mina_in_real_life_ASEU-2009.pdf) by Emmanuel L{{< html "é" >}}charny * [Rapid Network Application Development with Apache MINA (JavaOne 2008)](resources/JavaOne2008.pdf) by Trustin Lee * [Apache MINA - The High Performance Protocol Construction Toolkit (ApacheCon US 2007)](resources/ACUS2007.pdf) by Peter Royal * [Introduction to MINA (ApacheCon Asia 2006)](resources/ACAsia2006.pdf) by Trustin Lee diff --git a/source/mina-project/features.md b/source/mina-project/features.md index 24e453a..1dd2264 100644 --- a/source/mina-project/features.md +++ b/source/mina-project/features.md @@ -20,11 +20,10 @@ MINA is a simple yet full-featured network application framework which provides: * Single thread * One thread pool * More than one thread pools (i.e. [SEDA](https://web.archive.org/web/20061208181754/http://www.eecs.harvard.edu/~mdw/papers/mdw-phdthesis.pdf)) -* Out-of-the-box SSL · TLS · StartTLS support using Java 5 `SSLEngine` +* Out-of-the-box SSL {{< html "·" >}} TLS {{< html "·" >}} StartTLS support using Java 5 `SSLEngine` * Overload shielding & traffic throttling * Unit testability using mock objects * JMX managability * Stream-based I/O support via `StreamIoHandler` * Integration with well known containers such as PicoContainer and Spring * Smooth migration from Netty, an ancestor of Apache MINA. - diff --git a/source/mina-project/testimonials.md b/source/mina-project/testimonials.md index 5c5a1f7..644d97d 100644 --- a/source/mina-project/testimonials.md +++ b/source/mina-project/testimonials.md @@ -13,7 +13,7 @@ __Maarten Bosteels__ says: > We found the speed and stability of MINA to be excellent. And although we > are still using MINA 0.8.1, we found the API very elegant and easy. -__Frédéric Brégier__ says: +__Fr{{< html "é" >}}d{{< html "é" >}}ric Br{{< html "é" >}}gier__ says: > MINA helped us to get the network layout of OpenLSD done in about 2 months, > saving us about 9 months to 1 year of development and fine-grained testing, > so we were able to focus on our problem; Open Legacy Storage Document, a > framework for document archiving in a huge storage. OpenLSD brings security, > network layout, JDBC, and good performance, and allows at least 2 petabytes > of documents (2000 terabytes, the limit is virtually 2^192 bytes). @@ -32,7 +32,7 @@ __Nicholas Clare__ says: > We use MINA as a networking library to handle concurrent connections to our > text based communication server. MINA has worked like a charm. It makes > writing server applications simple and is much easier to use than Java's NIO > libraries. Because of MINA's stability and ease of use, we plan on using > MINA more in our future projects. -__Jean-François Daune__ says: +__Jean-Fran{{< html "ç" >}}ois Daune__ says: > We use MINA to communicate with [Banksys](http://www.banksys.com/) 'point of > sale' terminals (Visa, Mastercard...) for technical management operations. > (software upgrade, remote monitoring, log transfer...) @@ -50,7 +50,7 @@ __Paolo Perrucci__ says: > We are using MINA to build the network layer of our multiplayer game server > at [Leonardo.it](http://ludonet.leonardo.it/). Using MINA, we implemented > different protocols in a few days; Game and HTTP tunneling. In the past, we > used NIO, and the advantage of using MINA is evident; the MINA API is > elegant and very simple to use. Last, but not least, MINA have a really > responsive support. -__Frédéric Soulier__ says: +__Fr{{< html "é" >}}d{{< html "é" >}}ric Soulier__ says: > In 3 days, starting from scratch (knowing nothing about MINA) and with help > from this list, I've re-implemented something that took us 2+ months to > develop! I've thrown 4000 concurrent connections at it without a problem. > The only problem I faced was to increase the limit for open files on my > linux box (default was 1024). @@ -68,7 +68,7 @@ __Julien Vermillard__ says: > see [White > Paper](http://www.hsc.com/HSFiles/Wpos/WhitePaper_Trap_Receiver_using_Apache_MINA.pdf) -__Emmanuel Lécharny__ says: +__Emmanuel L{{< html "é" >}}charny__ says: > MINA handles the following protocols in ADS : diff --git a/source/mina-project/userguide/ch1-getting-started/ch1.3-features.md b/source/mina-project/userguide/ch1-getting-started/ch1.3-features.md index 7e72ac5..56a17de 100644 --- a/source/mina-project/userguide/ch1-getting-started/ch1.3-features.md +++ b/source/mina-project/userguide/ch1-getting-started/ch1.3-features.md @@ -26,7 +26,7 @@ MINA is a simple yet full-featured network application framework which provides: * Single thread * One thread pool * More than one thread pools (i.e. SEDA) -* Out-of-the-box SSL · TLS · StartTLS support using Java 5 SSLEngine +* Out-of-the-box SSL {{< html "·" >}} TLS {{< html "·" >}} StartTLS support using Java 5 SSLEngine * Overload shielding & traffic throttling * Unit testability using mock objects * JMX managability diff --git a/source/mina-project/userguide/ch2-basics/ch2.1-application-architecture.md b/source/mina-project/userguide/ch2-basics/ch2.1-application-architecture.md index 8b05f4c..8ffc41e 100644 --- a/source/mina-project/userguide/ch2-basics/ch2.1-application-architecture.md +++ b/source/mina-project/userguide/ch2-basics/ch2.1-application-architecture.md @@ -28,7 +28,7 @@ Lets take a deeper dive into the details now. The following image shows a bit mo  -(The image is from Emmanuel Lécharny presentation [MINA in real life (ApacheCon EU 2009)](/assets/pdfs/Mina_in_real_life_ASEU-2009.pdf)) +(The image is from Emmanuel L{{< html "é" >}}charny presentation [MINA in real life (ApacheCon EU 2009)](/assets/pdfs/Mina_in_real_life_ASEU-2009.pdf)) Broadly, MINA based applications are divided into 3 layers diff --git a/source/mina-project/userguide/ch2-basics/ch2.2-sample-tcp-server.md b/source/mina-project/userguide/ch2-basics/ch2.2-sample-tcp-server.md index a1b5d07..72b3162 100644 --- a/source/mina-project/userguide/ch2-basics/ch2.2-sample-tcp-server.md +++ b/source/mina-project/userguide/ch2-basics/ch2.2-sample-tcp-server.md @@ -23,7 +23,7 @@ This tutorial will walk you through the process of building a MINA based program For instance, slf4j-log4j12.jar and log4j-1.3.x.jar can not be used together, and will malfunction. -We have tested this program on both Windows© 2000 professional and linux. If you have any problems getting this program to work, please do not hesitate to [contact us](../../../contact.html) in order to talk to the MINA developers. Also, this tutorial has tried to remain independent of development environments (IDE, editors..etc). This tutorial will work with any environment that you are comfortable with. Compilation commands and steps to execute the program have been removed fo [...] +We have tested this program on both Windows{{< html "©" >}} 2000 professional and linux. If you have any problems getting this program to work, please do not hesitate to [contact us](../../../contact.html) in order to talk to the MINA developers. Also, this tutorial has tried to remain independent of development environments (IDE, editors..etc). This tutorial will work with any environment that you are comfortable with. Compilation commands and steps to execute the program have [...] ## Writing the MINA time server diff --git a/source/mina-project/userguide/ch2-basics/ch2.3-sample-tcp-client.md b/source/mina-project/userguide/ch2-basics/ch2.3-sample-tcp-client.md index 1285beb..c252dd8 100644 --- a/source/mina-project/userguide/ch2-basics/ch2.3-sample-tcp-client.md +++ b/source/mina-project/userguide/ch2-basics/ch2.3-sample-tcp-client.md @@ -41,7 +41,7 @@ public static void main(String[] args) throws Throwable { session = future.getSession(); break; } catch (RuntimeIoException e) { - System.err.println("Failed to connect."); + System.err.println("Failed to connect."); e.printStackTrace(); Thread.sleep(5000); } diff --git a/source/mina-project/userguide/ch4-session/ch4-session.md b/source/mina-project/userguide/ch4-session/ch4-session.md index 37d1973..4f5c706 100644 --- a/source/mina-project/userguide/ch4-session/ch4-session.md +++ b/source/mina-project/userguide/ch4-session/ch4-session.md @@ -194,7 +194,7 @@ There are many methods available to manipulate the session's attributes : * boolean containsAttribute(Object key) : tells if a given attribute is present * Object getAttribute(Object key) : gets the value for a given attribute * Object getAttribute(Object key, Object defaultValue) : gets the value for a given attribute, or a default value if absent -* Set<Object> getAttributeKeys() : gets the set of all the stored attributes +* Set{{< html "<" >}}Object{{< html ">" >}} getAttributeKeys() : gets the set of all the stored attributes * Object removeAttribute(Object key) : remove a given attribute * boolean removeAttribute(Object key, Object value) : remove a given attribute/value pair * boolean replaceAttribute(Object key, Object oldValue, Object newValue) : replace a give attribute/value pair diff --git a/source/mina-project/userguide/ch5-filters/ch5-filters.md b/source/mina-project/userguide/ch5-filters/ch5-filters.md index c291d17..7797bb8 100644 --- a/source/mina-project/userguide/ch5-filters/ch5-filters.md +++ b/source/mina-project/userguide/ch5-filters/ch5-filters.md @@ -54,24 +54,24 @@ We have many filters already written. The following table list all the existing |---|---|---| | Blacklist | [BlacklistFilter](http://mina.apache.org/mina-project/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/mina-project/xref/org/apache/mina/filter/buffer/BufferedWriteFilter.html) | Buffers outgoing requests like the BufferedOutputStream does | -| Compression | [CompressionFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/compression/CompressionFilter.html) | | -| ConnectionThrottle | [ConnectionThrottleFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/firewall/ConnectionThrottleFilter.html) | | -| ErrorGenerating | [ErrorGeneratingFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/errorgenerating/ErrorGeneratingFilter.html) | | -| Executor | [ExecutorFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/executor/ExecutorFilter.html) | | -| FileRegionWrite | [FileRegionWriteFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/stream/FileRegionWriteFilter.html) | | -| KeepAlive | [KeepAliveFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/keepalive/KeepAliveFilter.html) | | +| Compression | [CompressionFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/compression/CompressionFilter.html) | {{< html " " >}} | +| ConnectionThrottle | [ConnectionThrottleFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/firewall/ConnectionThrottleFilter.html) | {{< html " " >}} | +| ErrorGenerating | [ErrorGeneratingFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/errorgenerating/ErrorGeneratingFilter.html) | {{< html " " >}} | +| Executor | [ExecutorFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/executor/ExecutorFilter.html) | {{< html " " >}} | +| FileRegionWrite | [FileRegionWriteFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/stream/FileRegionWriteFilter.html) | {{< html " " >}} | +| KeepAlive | [KeepAliveFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/keepalive/KeepAliveFilter.html) | {{< html " " >}} | | Logging | [LoggingFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/logging/LoggingFilter.html) | Logs event messages, like MessageReceived, MessageSent, SessionOpened, ... | | MDC Injection | [MdcInjectionFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/logging/MdcInjectionFilter.html) | Inject key IoSession properties into the MDC | | Noop | [NoopFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/util/NoopFilter.html) | A filter that does nothing. Useful for tests. | | Profiler | [ProfilerTimerFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/statistic/ProfilerTimerFilter.html) | Profile event messages, like MessageReceived, MessageSent, SessionOpened, ... | | ProtocolCodec | [ProtocolCodecFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/codec/ProtocolCodecFilter.html) | A filter in charge of encoding and decoding messages | -| Proxy | [ProxyFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/proxy/filter/ProxyFilter.html) | | +| Proxy | [ProxyFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/proxy/filter/ProxyFilter.html) | {{< html " " >}} | | Reference counting | [ReferenceCountingFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/util/ReferenceCountingFilter.html) | Keeps track of the number of usages of this filter | -| RequestResponse | [RequestResponseFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/reqres/RequestResponseFilter.html) | | -| SessionAttributeInitializing | [SessionAttributeInitializingFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/util/SessionAttributeInitializingFilter.html) | | -| StreamWrite | [StreamWriteFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/stream/StreamWriteFilter.html) | | -| SslFilter | [SslFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/ssl/SslFilter.html) | | -| WriteRequest | [WriteRequestFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/util/WriteRequestFilter.html) | | +| RequestResponse | [RequestResponseFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/reqres/RequestResponseFilter.html) | {{< html " " >}} | +| SessionAttributeInitializing | [SessionAttributeInitializingFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/util/SessionAttributeInitializingFilter.html) | {{< html " " >}} | +| StreamWrite | [StreamWriteFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/stream/StreamWriteFilter.html) | {{< html " " >}} | +| SslFilter | [SslFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/ssl/SslFilter.html) | {{< html " " >}} | +| WriteRequest | [WriteRequestFilter](http://mina.apache.org/mina-project/xref/org/apache/mina/filter/util/WriteRequestFilter.html) | {{< html " " >}} | ## Overriding Events Selectively diff --git a/source/special-thanks.md b/source/special-thanks.md index 153c9c0..7997341 100644 --- a/source/special-thanks.md +++ b/source/special-thanks.md @@ -22,5 +22,5 @@ We would also like to thank the organizations who provided some tools and images | Company/Organization | Donation type | Organization contact | Apache contact | |---|---|---|---| -| | Licenses for YourKit | Vladimir Kondratyev <br> (sales at yourkit.com) | Emmanuel Lécharny | -||[http://creativecommons.org/licenses/by/2.5/](http://creativecommons.org/licenses/by/2.5/)| Mark James | Emmanuel Lécharny| +| | Licenses for YourKit | Vladimir Kondratyev <br> (sales at yourkit.com) | Emmanuel L{{< html "é" >}}charny | +||[http://creativecommons.org/licenses/by/2.5/](http://creativecommons.org/licenses/by/2.5/)| Mark James | Emmanuel L{{< html "é" >}}charny| diff --git a/source/sshd-project/contributors.md b/source/sshd-project/contributors.md index 1584b82..79608ae 100644 --- a/source/sshd-project/contributors.md +++ b/source/sshd-project/contributors.md @@ -7,7 +7,7 @@ title: SSHD Contributors The following is a list of developers with commit privileges that have directly contributed to the project in one way or another. -* Emmanuel Lécharny +* Emmanuel L{{< html "é" >}}charny * Guillaume Nodet * Lyor Goldstein * Shawn Pearce @@ -17,9 +17,9 @@ The following is a list of developers with commit privileges that have directly The following additional people have contributed to this project through the way of suggestions, patches or documentation. * Leo Bayer -* André Bierwolf +* Andr{{< html "é" >}} Bierwolf * Shikhar Bhushan -* Cédric Chantepie +* C{{< html "é" >}}dric Chantepie * Patrick Dessalle * Ken Diep * Laurent Duchesne diff --git a/source/vysper-project/embed.md b/source/vysper-project/embed.md index 41cedbe..519a342 100644 --- a/source/vysper-project/embed.md +++ b/source/vysper-project/embed.md @@ -23,7 +23,7 @@ Having a Vysper XMPP server instance embedded into your own application is easy: ```java import org.apache.vysper.xmpp.server; -XMPPServer server = new XMPPServer("myembeddedjabber.com"); +XMPPServer server = new XMPPServer("myembeddedjabber.com"); server.start(); ``` @@ -41,8 +41,8 @@ StorageProviderRegistry providerRegistry = new JcrStorageProviderRegistry(); final AccountManagement accountManagement = (AccountManagement) providerRegistry.retrieve(AccountManagement.class); -if(!accountManagement.verifyAccountExists(EntityImpl.parse("us...@myembeddedjabber.com"))) { - accountManagement.addUser(EntityImpl.parse("us...@myembeddedjabber.com"), "password1"); +if(!accountManagement.verifyAccountExists(EntityImpl.parse("us...@myembeddedjabber.com"))) { + accountManagement.addUser(EntityImpl.parse("us...@myembeddedjabber.com"), "password1"); } ``` @@ -52,11 +52,11 @@ SSL needs a TLS certificate. There is one coming along with Vysper for testing p Or, even better, create your own. ```java -XMPPServer server = new XMPPServer("myembeddedjabber.com"); +XMPPServer server = new XMPPServer("myembeddedjabber.com"); server.addEndpoint(new TCPEndpoint()); server.setStorageProviderRegistry(providerRegistry); -server.setTLSCertificateInfo(new File("src/main/config/bogus_mina_tls.cert"), "boguspw"); +server.setTLSCertificateInfo(new File("src/main/config/bogus_mina_tls.cert"), "boguspw"); ``` With initializing completed, just give it a go: @@ -64,7 +64,7 @@ With initializing completed, just give it a go: ```java try { server.start(); - System.out.println("server is running..."); + System.out.println("server is running..."); } catch (Exception e) { e.printStackTrace(); } diff --git a/source/vysper-project/service_discovery.md b/source/vysper-project/service_discovery.md index 67c3446..20a36d4 100644 --- a/source/vysper-project/service_discovery.md +++ b/source/vysper-project/service_discovery.md @@ -31,12 +31,12 @@ This is how a feature is advertised in the XEP-0092 implementation: ```java public class SoftwareVersionModule extends DefaultDiscoAwareModule implements ServerInfoRequestListener { @Override - protected void addServerInfoRequestListeners(List<ServerInfoRequestListener> serverInfoRequestListeners) { + protected void addServerInfoRequestListeners(List<ServerInfoRequestListener> serverInfoRequestListeners) { serverInfoRequestListeners.add(this); } - public List<InfoElement> getServerInfosFor(InfoRequest request) { - List<InfoElement> infoElements = new ArrayList<InfoElement>(); + public List<InfoElement> getServerInfosFor(InfoRequest request) { + List<InfoElement> infoElements = new ArrayList<InfoElement>(); infoElements.add(new Feature(NamespaceURIs.JABBER_IQ_VERSION)); return infoElements; } diff --git a/source/vysper-project/socks5.md b/source/vysper-project/socks5.md index eaeb9ce..262d14b 100644 --- a/source/vysper-project/socks5.md +++ b/source/vysper-project/socks5.md @@ -14,7 +14,7 @@ The Vysper SOCKS5 Bytestream module implements mediated connections from XEP-006 The example below shows how to add the module using the API: ```java -XMPPServer server = new XMPPServer(“vysper.org”); +XMPPServer server = new XMPPServer("vysper.org"); server.addEndpoint(new TCPEndpoint()); // other initialization diff --git a/source/vysper-project/standards_supported.md b/source/vysper-project/standards_supported.md index c95e388..1cb1cb8 100644 --- a/source/vysper-project/standards_supported.md +++ b/source/vysper-project/standards_supported.md @@ -7,25 +7,25 @@ title: Vysper Standards Supported | Specification | Status | Comment | |---|---|---| -| [RFC 3920 XMPP Core](http://www.ietf.org/rfc/rfc3920.txt) | Complete | | -| [RFC 3921 XMPP Instant Messaging and Presence](http://www.ietf.org/rfc/rfc3921.txt) | 80% | | -| [XEP-0004 Data Forms](http://xmpp.org/extensions/xep-0004.html) | Complete | | -| [XEP-0030 Service Discovery](http://xmpp.org/extensions/xep-0030.html) | Complete | | -| [XEP-0045 Multi-User Chat](http://xmpp.org/extensions/xep-0045.html) | 80% | | -| [XEP-0049 Private XML Storage](http://xmpp.org/extensions/xep-0029.html) | Complete | | -| [XEP-0050 Ad-Hoc Commands](http://xmpp.org/extensions/xep-0050.html) | Complete | | -| [XEP-0054 vcard-temp](http://xmpp.org/extensions/xep-0054.html) | Complete | | -| [XEP-0060 Publish-Subscribe](http://xmpp.org/extensions/xep-0060.html) | Complete | | +| [RFC 3920 XMPP Core](http://www.ietf.org/rfc/rfc3920.txt) | Complete | {{< html " " >}} | +| [RFC 3921 XMPP Instant Messaging and Presence](http://www.ietf.org/rfc/rfc3921.txt) | 80% | {{< html " " >}} | +| [XEP-0004 Data Forms](http://xmpp.org/extensions/xep-0004.html) | Complete | {{< html " " >}} | +| [XEP-0030 Service Discovery](http://xmpp.org/extensions/xep-0030.html) | Complete | {{< html " " >}} | +| [XEP-0045 Multi-User Chat](http://xmpp.org/extensions/xep-0045.html) | 80% | {{< html " " >}} | +| [XEP-0049 Private XML Storage](http://xmpp.org/extensions/xep-0029.html) | Complete | {{< html " " >}} | +| [XEP-0050 Ad-Hoc Commands](http://xmpp.org/extensions/xep-0050.html) | Complete | {{< html " " >}} | +| [XEP-0054 vcard-temp](http://xmpp.org/extensions/xep-0054.html) | Complete | {{< html " " >}} | +| [XEP-0060 Publish-Subscribe](http://xmpp.org/extensions/xep-0060.html) | Complete | {{< html " " >}} | | [XEP-0065 SOCKS5 Bytestreams](http://xmpp.org/extensions/xep-0065.html) | Complete | The optional UDP support not implemented | | [XEP-0077 In-band registration](http://xmpp.org/extensions/xep-0077.html) | 80% | Canceling existing registration not supported | -| [XEP-0082 XMPP Date and Time Profiles](http://xmpp.org/extensions/xep-0082.html) | Complete | | -| [XEP-0092 Software Version](http://xmpp.org/extensions/xep-0092.html) | Complete | | -| [XEP-0124 Bidirectional-streams Over Synchronous HTTP (BOSH)](http://xmpp.org/extensions/xep-0124.html) | Complete | | -| [XEP-0133 Service Administration](http://xmpp.org/extensions/xep-0133.html) | 40% | | -| [XEP-0185 Dialback Key Generation and Validation](http://xmpp.org/extensions/xep-0185.html) | Complete | | -| [XEP-0199 XMPP Ping](http://xmpp.org/extensions/xep-0199.html) | Complete | | -| [XEP-0202 Entity Time](http://xmpp.org/extensions/xep-0202.html) | Complete | | -| [XEP-0206 XMPP Over BOSH](http://xmpp.org/extensions/xep-0206.html) | Complete | | -| [XEP-0220 Server Dialback](http://xmpp.org/extensions/xep-0220.html) | Complete | | -| [XEP-0220 Server Dialback](http://xmpp.org/extensions/xep-0220.html) | Complete | | -| [An XMPP Sub-protocol for WebSocket](http://tools.ietf.org/html/draft-moffitt-xmpp-over-websocket-00 ) | Complete | | +| [XEP-0082 XMPP Date and Time Profiles](http://xmpp.org/extensions/xep-0082.html) | Complete | {{< html " " >}} | +| [XEP-0092 Software Version](http://xmpp.org/extensions/xep-0092.html) | Complete | {{< html " " >}} | +| [XEP-0124 Bidirectional-streams Over Synchronous HTTP (BOSH)](http://xmpp.org/extensions/xep-0124.html) | Complete | {{< html " " >}} | +| [XEP-0133 Service Administration](http://xmpp.org/extensions/xep-0133.html) | 40% | {{< html " " >}} | +| [XEP-0185 Dialback Key Generation and Validation](http://xmpp.org/extensions/xep-0185.html) | Complete | {{< html " " >}} | +| [XEP-0199 XMPP Ping](http://xmpp.org/extensions/xep-0199.html) | Complete | {{< html " " >}} | +| [XEP-0202 Entity Time](http://xmpp.org/extensions/xep-0202.html) | Complete | {{< html " " >}} | +| [XEP-0206 XMPP Over BOSH](http://xmpp.org/extensions/xep-0206.html) | Complete | {{< html " " >}} | +| [XEP-0220 Server Dialback](http://xmpp.org/extensions/xep-0220.html) | Complete | {{< html " " >}} | +| [XEP-0220 Server Dialback](http://xmpp.org/extensions/xep-0220.html) | Complete | {{< html " " >}} | +| [An XMPP Sub-protocol for WebSocket](http://tools.ietf.org/html/draft-moffitt-xmpp-over-websocket-00 ) | Complete | {{< html " " >}} |