Ninja Web Framework Documentation

Ninja is an integrated software stack that provides the following capabilities out of the box:

Frontend

• HTML rendering: Freemarker
• JSON/XML rendering & parsing: Jackson

Stateful RESTful features

• Session & Authentication: ninja-session
• Flash scope: ninja-flash

Core Libraries

• Dependency Injection: Guice
• Configuration: Multiple environment configuration (Ninja)
• Internationalization (i18n): Support for templates and controllers (Ninja)
• Lifecycle Management: Ninja lifecycle
• Mail: Mail sending support
• Scheduling: Scheduler support
• Validation: JSR 303 object validation (Hibernate-validation)
• Utilities: Google Guava
• Logging: slf4j and logback

Data Persistence & Caching

• Relational Data: JPA (Hibernate) and Database migrations (Flyway)
• Cache Layer: Memcached and EhCache

Testing Support

• Mocking: Mockito
• Framework Testing: NinjaTest
• Documentation Testing: NinjaDocTester
• Browser/UI Testing: NinjaFluentLeniumTest

Ninja is an extensible framework. You can add functionality by integrating various modules for runtime platforms, server engines, template engines, databases, authentication, and more.

Runtime Platforms

• Google AppEngine Support: https://github.com/ninjaframework/ninja-appengine

Server Engines

• Undertow standalone: An alternative to Jetty via https://github.com/fizzed/ninja-undertow

Template Engines

• Rythm templates: https://github.com/ninjaframework/ninja-rythm
• Mustache templates: https://github.com/kpacha/ninja-mustache
• Jade4Ninja (Jade) templates: https://github.com/mysu/jade4ninja
• Rocker templates: https://github.com/fizzed/ninja-rocker
• Pebble templates: https://github.com/jjfidalgo/ninja-pebble or https://github.com/bordereast/ninja-pebble-module

Databases and ORM

• EBean RDBMS ORM (for EBean <= 7.2.3): https://github.com/ninjaframework/ninja-ebean
• EBean RDBMS ORM (for EBean > 7.2.3): https://github.com/jfendler/ninja-ebean-ng
• MongoDB/Morphia Integration: https://github.com/bihe/ninja-mongodb
• Cassandra: https://github.com/fizzed/cassandra-plus

Authentication

• Auth0 (SaaS): https://github.com/zileo-net/ninja-auth0

Process Engines

• Activity (Workflow/BPM): http://mortezaadi.github.io/ninja-activiti-module/
• Camunda BPMN Integration: http://github.com/FendlerConsulting/ninja-camunda
• Executors (Long lived tasks): https://github.com/fizzed/executors

Miscellaneous

• Prometheus (Metrics): https://github.com/fizzed/prometheus-plus
• Redis (Cache/Pooling): https://github.com/fizzed/redis-plus
• RabbitMQ (Pooling/Sessions): https://github.com/fizzed/rabbitmq-plus
• Hazelcast Cache: https://github.com/raptaml/ninja-hazelcast-embedded
• Quartz Scheduler: https://github.com/FendlerConsulting/ninja-quartz
• Sitemap Generator: https://github.com/FendlerConsulting/ninja-sitemap

Ninja can automatically inject the Context object, which holds all information about the current request (parameters, headers, etc.).

Additionally, Ninja can automatically parse arbitrary objects passed as method arguments. The parsing format (JSON, XML, or POST form) is determined by the Content-Type request header.

For POST forms, Ninja supports nested objects using dot notation. For example, if a User object contains an Address object with a street field, a form field with the key address.street will be correctly mapped.

package controllers;

@Singleton
public class ApplicationController {

    public Result index(
            @PathParam("id") String id, 
            @PathParam("email") String email, 
            @Param("debug") Optional<String> debug,
            @Param("isAdmin") Boolean isAdmin,
            Context context,
            MyObject myObject) {

        // do something with the parameters...
    }
}