krail

Krail provides a framework for rapid Java web development by combining Vaadin, Guice, Apache Shiro, Apache Commons Configuration and others. For more information, see the comprehensive Tutorial, which also makes a reasonable demo. (You can clone directly from the Tutorial repo). Note that the tutorial is based on the Vaadin 7 version of Krail - it should still be possible to follow it, but it will not be updated until the move to Eclipse Vert.x is done (or fails!)

This core library provides:

• Site navigation, using a sitemap configured by annotation or Guice
• Authentication / Authorisation framework, including page access control
• Vaadin Server Push (with option to disable it)
• Event Bus
• Extensive I18N support
• User options
• Application configuration through ini files, database etc
• JSR 303 Validation (integrated with I18N)
• Forms support
• User notifications

The framework is highly configurable, and virtually any element of it can be replaced by using Guice bindings.

Development Focus

The current focus for development is to provide full Forms support, running on Vertx. So far, thanks to the great contribution from Marco Collovati, running on Vertx has shown no specific issues.

It is intended that the same code can be run both on Vertx and a conventional web server environment, and a bootstrapping mechanism is provided for that purpose.

The extensive Documentation, includes a Tutorial, user Guide and Developer Guide. The Tutorial is currently limited to the Vaadin 7 version, and needs rewriting to include new features.

Source Code

Originally written in Java the source is gradually being migrated to Kotlin. Tests are a mix of JUnit, Spock and Spek. The intention is to end up with an all-Kotlin solution, but porting is usually only done when code changes are required for other reasons.

Versions

Download

Gradle

repositories {
    jcenter()
}

'uk.q3c.krail:krail:0.16.12.0'

Maven

<repository>
    <id>jcenter</id>
    <url>http://jcenter.bintray.com</url>
</repository>

<dependency>
    <groupId>uk.q3c.krail</groupId>
    <artifactId>krail</artifactId>
    <version>0.16.12.0</version>
</dependency>

Direct

Limitations

Testing on Vertx has been limited, particularly on clustered Vertx. Having said that, functional tests run on Vertx have shown no issues except that Push does not correctly disable.

Status

• Vaadin 8.3.3 is integrated with:
• Guice 4.1.0
• Shiro 1.4.0,
• MBassador (Event Bus)
• Apache Commons Configuration
• Guava cache

Functional Test Application

There is a functional test application which can also be used to explore functionality - though the Tutorial may be better for that

Project Build

Gradle is used (made a lot easier thanks to the Gradle Vaadin plugin.

Acknowledgements

Thanks to:

Marco Collovati for his work on Vaadin - Vertx integration, and support for core Krail development

Dirk Lietz for his review and feedback for the Tutorial

Mike Pilone for his blog post on Vaadin Shiro integration

ej technologies for an open source licence of JProfiler

Vaadin

Guice

Apache Shiro

JUnit

Guava (cache and utilities)

MBassador Event Bus

Flag Icons

Apache Commons Configuration

Gradle

Gradle Vaadin plugin

Gradle Docker Plugin

Gradle Bintray Plugin

Bintray

Docker

Logback

slf4j

AssertJ

Mycila

Mockito

spock

Spek

FindBugs Mockk