ZK Example Application with: Maven, Spring, Hibernate, Acegi

I've been working with ZK for a while now, and like its ease of use and low learning curve. However, I had a pretty hard time using it with some of my other favourite frameworks, specifically: Maven, Spring, and Acegi. Also, I found some of the issues around navigation and the initial setup a bit confusing.

Something that would have helped me a lot would have been an example that includes a full Spring / Acegi setup, packaged with Maven so it works 'out of the box', including a couple of screens that actually does your regular search / crud operations. So, I've decided to extract such an example from a project I've been working on. This is just my tiny contribution to the ZK community.

This example app includes all of the above, as well as using Hibernate for persistence, though that is all wrapped in Spring and accessed via services. It's far from perfect, but I think it's a good start. I would greatly appreciate any feedback or suggestions if anyone uses this.

Download:
Download the project as a ZIP file from here.

Usage:
When you launch, you will be presented with a login screen. The Acegi setup is such that a hard-coded user 'admin' with password 'password' can log in only until an actual user exists in the database. The system has screens for administering users, roles and privileges.

Initial setup:
Firstly, you will need Maven, Java, and a database. The example application uses PostgreSQL. To use a different DB setup, edit the following files:

1. zkskeleton-persistence/pom.xml (The driver from Maven)
   
2. zkskeleton-datasource-context.xml (Connection when deployed)
   
3. zkskeleton-domain-test-context.xml (Connection for integration tests)
   

The example includes integration tests so a DB is required to run test cases. To get it going, create a database, user and schema called 'zkskeleton'. The user's password must also be 'zkskeleton'. In postgresql the following should work:

CREATE USER zkskeleton WITH PASSWORD 'zkskeleton' createdb nosuperuser;
CREATE DATABASE zkskeleton WITH OWNER = zkskeleton;
\c zkskeleton
CREATE SCHEMA zkskeleton AUTHORIZATION zkskeleton

To get it running:

1. Unpack it somewhere
2. mvn clean install
3. Deploy the WAR from zkskeleton-web/target/zkskeleton.war
   

To set it up in your IDE:
I use idea, but eclipse is pretty similiar

1. mvn idea:clean idea:idea -DdownloadSources=true
2. Open the project file

Customizing:
The first thing you'll probably want to change is the name, to do this refactor all the packages from 'zkskeleton' to something appropriate. You will also need to change the project directories and xml file names. Then do a global search and replace from 'zkskeleton' to your application name. You will probably also want to change the DB setup, this can be done as explained above.

Architecture:
Of course there are lots of clever ways to do this, but my architecture looks something like this:

1. Domain layer depending on nothing, containing the domain entities
2. Persistence layer depending on Domain, containing Hibernate crud stuff
3. Service Shared layer depending on Domain (bad thing, but I can live with it for purely web based) containing service interfaces and DTO's
4. Service depending on Service Shared containing service implementations
5. UI layer depending on Service Shared containing ZK classes, controllers and extensions
6. Web layer depending on Service and UI, containing the ZK markup files, webapp setup, and Acegi and service wiring.

Each of the above layers exist in its own Maven project, which is in turn wrapped in one top-level project.

PS: The idea behind the navigation is borrowed from the ZK demo app, I hope they don't mind. Since that source is freely available it's probably fine, just giving credit where it's due though.