https://github.com/fizzed/ninja-undertow
Undertow standalone container for NinjaFramework
https://github.com/fizzed/ninja-undertow
Last synced: about 1 month ago
JSON representation
Undertow standalone container for NinjaFramework
- Host: GitHub
- URL: https://github.com/fizzed/ninja-undertow
- Owner: fizzed
- Created: 2016-02-19T04:27:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-13T17:23:08.000Z (about 7 years ago)
- Last Synced: 2025-03-27T03:51:21.666Z (about 2 months ago)
- Language: Java
- Size: 1.72 MB
- Stars: 2
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
Undertow for Ninja Framework by Fizzed
=======================================
[](https://travis-ci.org/fizzed/ninja-undertow)
[](https://maven-badges.herokuapp.com/maven-central/com.fizzed/ninja-undertow)
[Fizzed, Inc.](http://fizzed.com) (Follow on Twitter: [@fizzed_inc](http://twitter.com/fizzed_inc))
## Overview
Standalone implementation for the [Ninja Framework](https://github.com/ninjaframework/ninja)
using Undertow. Ninja-undertow does *not use servlets* under-the-hood -- therefore
it bypasses a significant amount of code that Ninja's default Jetty-based standalone
uses. Ninja-undertow is a drop-in replacement for Ninja's Jetty-based standalone.
## Performance
Based on this [benchmark](ninja-benchmark/src/main/java/ninja/benchmark/NinjaBenchmark.java) ninja-undertow
is 15.5% faster than ninja-jetty for standard GET requests and 7.6% faster than
ninja-jetty for POST requests w/ JSON. Future optimizations and tuning should
continue to wident the performance gap.
```
Benchmark results for ninja.undertow.NinjaUndertow
----------------------------------------------------
threads: 50
requests: 50000
get_with_params benchmark: 2096 ms (23854.96/sec)
post_object_as_form benchmark: 2913 ms (17164.43/sec)
post_object_as_json benchmark: 2246 ms (22261.80/sec)
Benchmark results for ninja.standalone.NinjaJetty
----------------------------------------------------
threads: 50
requests: 50000
get_with_params benchmark: 2521 ms (19833.40/sec)
post_object_as_form benchmark: 3098 ms (16139.44/sec)
post_object_as_json benchmark: 2402 ms (20815.99/sec)
```
## Ninja 5 (or lower) support?
Please use `ninja-undertow` v5.7.0.undertow2 or below if you need to target
an older version of Ninja.
## Differences with ninja-standalone (jetty)?
Ninja-undertow passes **all** current Ninja unit tests. As of Ninja v6, this
library supplies everything ninja-jetty (standalone) provides.
## Usage
Ninja-undertow is on maven central. The version will always be the Ninja
version it was compiled against + `undertowN` which represents the undertow
build increment. As of Ninja v5.4.0, as long as you don't have `ninja.standalone.NinjaJetty`
on your classpath, Ninja will automatically find ninja-undertow and use it
for everything (maven-plugin, testing, standalone). So if you previously had
a dependency on `ninja-standalone`, you'll want to make sure you are only
pulling `ninja-core` and `ninja-undertow`.
```xml
org.ninjaframework
ninja-core
6.0.0-beta2
com.fizzed
ninja-undertow
6.0.0-undertow1
```
## Configuration
The following Ninja (conf/application.conf) properties are supported.
`ninja.host =
`
Host interface to bind undertow server to. "0.0.0.0" will bind to any address or
"localhost" would bind to just the local interface.
`ninja.port = `
HTTP port to bind undertow server to. Any value greater than zero activates
the HTTP server.
`ninja.ssl.port = `
HTTPS port to bind undertow server to. Any value greater than zero activates
the HTTPS server. All Ninja `ninja.ssl.*` properties are supported for setting
up the keystore and truststore.
`undertow.tracing = `
If true then an undertow `RequestDumpingHandler` will be added to the request
handling pipeline to log all requests and responses. Please note that this
is an expensive feature and should only be enabled during development or in
cases of troubleshooting in production. False by default.
`undertow.http2 = `
If true then HTTP/2.0 will be activated for HTTP/HTTPS ports. Undertow v1.4.0+
does not require ALPN support like in previous versions. Please note that most
browsers (Chrome, Firefox, etc.) only try `h2` over HTTPS. Recent versions of
`curl` support `h2` over HTTP.
## Demo and benchmark
This project uses [Blaze](https://github.com/fizzed/blaze) for assisting with
running sample apps. To run a demo:
java -jar blaze.jar demo
To run a benchmark
java -jar blaze.jar benchmark
The benchmark supports a number of system properties to run with various
configurations. To run the benchmark against jetty:
java -jar blaze.jar benchmark -Dbm.server=jetty
To benchmark ssl:
java -jar blaze.jar benchmark -Dbm.ssl=true
To activate http/2.0 for undertow and ssl:
java -jar blaze.jar benchmark -Dbm.ssl=true -Dundertow.http2=true
## Testing
Compile and test project by itself and install it
mvn test
Use Ninja's unit tests to verify. Install ninja-undertow followed by a [Blaze](https://github.com/fizzed/blaze)
script to clone Ninja's upstream git repo.
mvn install
java -jar blaze.jar cloneOrRebaseNinjaRepo
Then edit ninja's standalone module to include ninja-undertow. This means any
other module in ninja that pulls in ninja-standalone will also have ninja-undertow.
nano ninja-upstream/ninja-standalone/pom.xml
Add the following as a dependency
```xml
com.fizzed
ninja-undertow
```
cd ninja-upstream
mvn test -Dninja.standalone.class=ninja.undertow.NinjaUndertow -DasyncMachineTests=false
That system property controls the underlying implementation that ninja creates
for its own standalone instance. Results in NinjaUndertow entirely replacing
every occurrence where NinjaJetty is used. Therefore, it taps into all the
NinjaFramework unit tests :-)
## License
Copyright (C) 2016 Fizzed, Inc.
This work is licensed under the Apache License, Version 2.0. See LICENSE for details.