ZK Installation Guide/Maven Setup

How to Use ZK Maven Repository

This chapter describes how to use the Maven repository hosted by ZK. (We assume you have known Maven) Here introduces you with a simple example of using ZK maven repository in your maven build environment.

Add ZK Maven repository to your pom.xml file

By default, while resolving project dependencies Maven will only look into Maven central repository [1]. In order to use ZK Maven repository add the following <repositories> element into pom.xml under the root <project> element.

 <repositories>
    <repository>
      <id>ZK CE</id>
      <name>ZK CE Repository</name>
      <url>https://mavensync.zkoss.org/maven2</url>
    </repository>
  </repositories>

Note that ZK Maven repository URL is https://mavensync.zkoss.org/maven2.

Adding ZK library dependencies

Depending upon your project requirements your project might depend on various ZK libraries. You can declare these dependencies in the pom.xml file and Maven can resolve them by automatically connecting to ZK Maven repository Here is how you can declare a dependency for the main ZK library and zul library for your project.

<dependency>
	<groupId>org.zkoss.zk</groupId>
	<artifactId>zkbind</artifactId>
	<version>8.5.0</version>
</dependency>
<dependency>
	<groupId>org.zkoss.zk</groupId>
	<artifactId>zul</artifactId>
	<version>8.5.0</version>
</dependency>
<dependency>
	<groupId>org.zkoss.zk</groupId>
	<artifactId>zkplus</artifactId>
	<version>8.5.0</version>
</dependency>
<dependency>
	<groupId>org.zkoss.zk</groupId>
	<artifactId>zhtml</artifactId>
	<version>8.5.0</version>
</dependency>

For Maven to successfully resolve these dependencies groupid and artifactid must match with those published on ZK Maven repository as they constitute what is known as Maven repository coordinates. For a complete list of all ZK library groupid and artifactid combinations please take a look at a sample pom.xml file that lists dependencies for all publically available ZK libraries on ZK Maven repository.

Sample of pom.xml

Here is a sample pom.xml for a simple Java project that uses the ZK maven repository.

<?xml version="1.0" encoding="UTF-8"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"   
xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <modelVersion>4.0.0</modelVersion>
  <groupId>zk.app</groupId>
  <artifactId>MyZKMavenApp</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <repositories>
    <repository>
      <id>ZK CE</id>
      <name>ZK CE Repository</name>
      <url>https://mavensync.zkoss.org/maven2</url>
    </repository>
    <repository>
      <id>ZK EVAL</id>
      <name>ZK Evaluation Repository</name>
      <url>https://mavensync.zkoss.org/eval</url>
    </repository>
  </repositories>
  <dependencies>
....
  </dependencies>
</project>

Required Dependencies

The following are required dependencies you need to include one of them in your pom.xml according to which ZK edition you use.

ZK CE

<dependencies>
    <dependency>
      <groupId>org.zkoss.zk</groupId>
      <artifactId>zul</artifactId>
      <version>${zk.version}</version>
    </dependency>
</dependencies>

ZK PE

<dependencies>
    <dependency>
      <groupId>org.zkoss.zk</groupId>
      <artifactId>zkex</artifactId>
      <version>${zk.version}</version>
    </dependency>
</dependencies>

ZK EE

<dependencies>
    <dependency>
      <groupId>org.zkoss.zk</groupId>
      <artifactId>zkmax</artifactId>
      <version>${zk.version}</version>
    </dependency>
</dependencies>

Optional Dependencies

The following dependencies are optional and available for all editions. You can include them according to your needs.

<dependencies>
<!-- It's available since ZK 8. If you want to use shadow component/template injection, include this -->
    <dependency>
      <groupId>org.zkoss.zk</groupId>
      <artifactId>zuti</artifactId> 
      <version>${zk.version}</version>
    </dependency>
<!-- If you want to use data binding, include this -->
    <dependency>
      <groupId>org.zkoss.zk</groupId>
      <artifactId>zkbind</artifactId>
      <version>${zk.version}</version>
    </dependency>
<!-- If you want to use zk xhtml component set, include this -->
    <dependency>
      <groupId>org.zkoss.zk</groupId>
      <artifactId>zhtml</artifactId>
      <version>${zk.version}</version>
    </dependency>
<!-- If you want to use third party framework e.g. hibernate, spring, you can include this -->
    <dependency>
      <groupId>org.zkoss.zk</groupId>
      <artifactId>zkplus</artifactId>
      <version>${zk.version}</version>
    </dependency>
</dependencies>

Check Available ZK Version

Please visit each edition's corresponding ZK Maven repository with a browser to check the available ZK versions.

Choose Right Maven Repository

ZK has three editions: CE, PE and EE. They are hosted in different Maven repository. I will guide you through how to choose the right edition and set up the right ZK Maven repository.

Steps for choosing the right edition

Here are the steps for choosing the right edition of ZK:

Decide which edition to use:

• There are three editions of ZK: CE, PE and EE
• For more information, please refer to description about ZK Editions and the following section that summarizes the jar files.

Summary of JAR files

There're something you need to know about ZK's edition and package(s).

	CE	PE	EE	Description
zk.jar	V	V	V	ZK core functions, such as ZK Loader and Update Engine.
zul.jar	V	V	V	ZK XUL components (http://www.zkoss.org/2005/zul)
zhtml.jar	V	V	V	ZK XHTML components (http://www.w3c.org/1999/xhtml)
zcommon.jar	V	V	V	The common library that ZK depends on
zcommons-el.jar	V	V	V	ZK EL expressions (renamed as zel.jar since 6.0)
zel.jar	V	V	V	ZK EL expressions (since 6.0)
zkbind.jar	V	V	V	data binding, required when developing with MVVM
zweb.jar	V	V	V	The Web library that ZK depends on
zkplus.jar	V	V	V	ZK extra utilities integrated easily with other frameworks.
zkex.jar		V	V	ZK additional components and features for PE
zkmax.jar			V	ZK additional components and features for EE
zuti.jar			V	shadow components for EE
zml.jar	V (only ZK 3)	V	V	ZK XML components for generating XML output

This will be helpful when you modify your dependencies of projects.

Add ZK Maven Repository to Your Projects

According to which ZK edition you use and add the corresponding repository to your project's pom.xml.

CE (Freely avaialable under LGPL)

• https://mavensync.zkoss.org/maven2

 <repositories>
    <repository>
      <id>ZK CE</id>
      <url>https://mavensync.zkoss.org/maven2</url>
    </repository>
  </repositories>

PE-eval / EE-eval (60-days free evaluation)

• https://mavensync.zkoss.org/eval/

 <repositories>
    <repository>
      <id>ZK PE/EE Evaluation</id>
      <url>https://mavensync.zkoss.org/eval/</url>
    </repository>
  </repositories>

• Note: Version number appending with -Eval has released since Jul. 18 2014. If you use it, please specify version to *-Eval for all of ZK dependencies. For example:

<dependency>
    <groupId>org.zkoss.zk</groupId>
    <artifactId>zk</artifactId>
    <version>8.5.0-Eval</version>
</dependency>

PE / EE (premium users only)

• Notice : Needs Login authentication

If you are our customer or ZOL licensed user you can contact info@zkoss.org to apply for a premium maven account to use ZK PE/EE (or any other licensed ZK product) maven repository.

• https://maven.zkoss.org/repo/zk/ee

 <repositories>
    <repository>
      <id>ZK EE</id>
      <url>https://maven.zkoss.org/repo/zk/ee</url>
    </repository>
  </repositories>

Login authentication

Licensed Professional and Enterprise customers will be given a set of user names and password upon your request. According to the official doc of Apache Maven, users can create global settings for maven.

• Location (if not-existed, you can create it manually)
  • The Maven install: $M2_HOME/conf/settings.xml
  • A user's install: ${user.home}/.m2/settings.xml

• Servers Element
• If you add ZK PE or ZK EE as your repository, you need to add login authentication like following example

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
 		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 		xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
 		http://maven.apache.org/xsd/settings-1.0.0.xsd">
	<servers>
		<server>
			<id>ZK EE</id><!-- Same as your repository name -->
			<!-- Your premium user name and password -->
			<username>ryanwu</username> 
			<password>2k055ecret</password> 
		</server>
	</servers>
</settings>

Sample of pom.xml for licensed Professional Package

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>zkpe</groupId>
	<artifactId>sample</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<properties>
		<!-- please check available version in the repository and specify it -->
		<zk.version>9.1.0</zk.version>
	</properties>
	<packaging>war</packaging>
	<name>The sample Project</name>
	<description>The sample Project</description>
	<repositories>
		<repository>
			<id>ZK CE</id>
			<name>ZK CE Repository</name>
			<url>https://mavensync.zkoss.org/maven2</url>
		</repository>
		<repository>
		    <id>ZK EE</id>
		    <url>https://maven.zkoss.org/repo/zk/ee</url>
		</repository>
	</repositories>
	<dependencies>
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zkex</artifactId>
			<version>${zk.version}</version>
		</dependency>
	</dependencies>
</project>

Sample of pom.xml for licensed Enterprise Package

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>zkee</groupId>
	<artifactId>sample</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<properties>
		<!-- please check available version in the repository and specify it -->
		<zk.version>9.1.0</zk.version>
		<zkspring.version>3.2.0</zkspring.version>
		<zats.version>2.0.0</zats.version>
		<zkjsp.version>2.6.0</zkjsp.version>
		<zkcalendar.version>2.1.5</zkcalendar.version>
		<zkgmap.version>3.0.4</zkgmap.version>
	</properties>
	<packaging>war</packaging>
	<name>The sample Project</name>
	<description>The sample Project</description>
	<repositories>
		<repository>
			<id>ZK CE</id>
			<name>ZK CE Repository</name>
			<url>https://mavensync.zkoss.org/maven2</url>
		</repository>
		<repository>
			<id>ZK EE</id>
			<url>https://maven.zkoss.org/repo/zk/ee</url>
		</repository>
	</repositories>
	<dependencies>
		<!-- ZK EE -->
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zkmax</artifactId>
			<version>${zk.version}</version>
		</dependency>

		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zkplus</artifactId>
			<version>${zk.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zhtml</artifactId>
			<version>${zk.version}</version>
		</dependency>
	        <!-- available since ZK 8 -->
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zuti</artifactId> 
			<version>${zk.version}</version>
		</dependency>


		<!-- ZK Spring -->
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zkspring-core</artifactId>
			<version>${zkspring.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zkspring-security</artifactId>
			<version>${zkspring.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zkspring-webflow</artifactId>
			<version>${zkspring.version}</version>
		</dependency>

		<!-- ZK JSP -->
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zuljsp</artifactId>
			<version>${zkjsp.version}</version>
		</dependency>

		<!-- ZK Calendar -->
		<dependency>
			<groupId>org.zkoss.calendar</groupId>
			<artifactId>calendar</artifactId>
			<version>${zkcalendar.version}</version>
		</dependency>

		<!-- ZK Google Maps -->
		<dependency>
			<groupId>org.zkoss.zkforge</groupId>
			<artifactId>gmapsz</artifactId>
			<version>${zkgmap.version}</version>
		</dependency>

		<!-- ZK additional Theme/s more themes -> https://maven.zkoss.org/repo/zk/ee/org/zkoss/theme/ -->
		<dependency>
			<groupId>org.zkoss.theme</groupId>
			<artifactId>breeze</artifactId>
			<version>${zk.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.theme</groupId>
			<artifactId>deepsea</artifactId>
			<version>${zk.version}</version>
		</dependency>
 
		<!-- or add the whole theme pack
		<dependency>
			<groupId>org.zkoss.theme</groupId>
			<artifactId>theme-pack</artifactId>
			<version>${zk.version}</version>
		</dependency>
		 -->
		<!-- ZATS Mimic -->
		<dependency>
			<groupId>org.zkoss.zats</groupId>
			<artifactId>zats-mimic-ext7</artifactId>
			<version>${zats.version}</version>
			<scope>test</scope>
		</dependency>
	</dependencies>
</project>

Trouble Shooting

If you have problems switching from the evaluation repository to the licensed one, please check the followings:

• 1. Remove evaluation repository, use PE / EE repository instead
• 2. Check if Login authentication is set up correctly
• 3. Delete cached local copy

Purge local repository evaluation cache

1. Add purge-local-repository plugin in pom.xml

	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-dependency-plugin</artifactId>
				<version>2.6</version>
				<executions>
					<execution>
						<id>purge-local-dependencies</id>
						<phase>clean</phase>
						<goals>
							<goal>purge-local-repository</goal>
						</goals>
						<configuration>
							<manualIncludes>
								<manualInclude>org.zkoss.zk:zkex</manualInclude>
								<manualInclude>org.zkoss.zk:zkmax</manualInclude>
							</manualIncludes>
						</configuration>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>

• line 16: ZK PE
• line 17: ZK EE

2. Invoke maven clean to delete local zkex & zkmax repository

mvn clean

Create a Maven Project with a Command Line

Before starting, you need to install maven and set up first.

• Go to your new project folder, then run the following command:

 mvn archetype:generate -DarchetypeCatalog=https://mavensync.zkoss.org/maven2/

Then just answer the questions the plugin asks you to create a project.

• The plugin will first ask you to choose the archetype from the zk catalog, please just enter the number of the archetype
• It will then ask users to enter the values for groupId, the artifactId and the version of the project to create the base package for the sources.
• It will then ask for confirmation of the configuration and perform the creation of the project.
• In the following example, webapp archetype (number 3) is selected and groupId is set to com.foo', artifactId to mywebapp, version to 0.8.0 and package to com.foo'.

NOTE: in case your maven installation uses the latest maven-archetype-plugin version 3.0.1 you'll have to use the following command (using 2.4 as a fallback - ARCHETYPE-519):

 $ mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeCatalog=https://mavensync.zkoss.org/maven2/

 $ mvn archetype:generate -DarchetypeCatalog=https://mavensync.zkoss.org/maven2/
 [INFO] Scanning for projects...
 [INFO] Searching repository for plugin with prefix: 'archetype'.
 [INFO] ------------------------------------------------------------------------
 [INFO] Building Maven Default Project
 [INFO]    task-segment: [archetype:generate] (aggregator-style)
 [INFO] ------------------------------------------------------------------------
 [INFO] Preparing archetype:generate
 [INFO] No goals needed for project - skipping
 [INFO] [archetype:generate {execution: default-cli}]
 [INFO] Generating project in Interactive mode
 [INFO] No archetype defined. Using maven-archetype-quickstart (org.apache.maven.
 archetypes:maven-archetype-quickstart:1.0)
 Choose archetype:
 1: https://mavensync.zkoss.org/maven2/ -> zk-archetype-component (An archetype 
 that generates a starter ZK component project)
 2: https://mavensync.zkoss.org/maven2/ -> zk-archetype-extension (An archetype 
 that generates a starter ZK extension project)
 3: https://mavensync.zkoss.org/maven2/ -> zk-archetype-webapp (An archetype that
 generates a starter ZK CE webapp project)
 4: https://mavensync.zkoss.org/maven2/ -> zk-ee-eval-archetype-webapp (An 
 archetype that generates a starter ZK EE-eval webapp project)
 Choose a number: : 3
 Define value for property 'groupId': : com.foo
 Define value for property 'artifactId': : mywebapp
 Define value for property 'version': 1.0-SNAPSHOT: 0.8.0
 Define value for property 'package': com.foo:
 [INFO] Using property: zk-version-since = 6.0.1
 Confirm properties configuration:
 groupId: com.foo
 artifactId: mywebapp
 version: 0.8.0
 package: com.foo
 zk-version-since: 6.0.1
 Y:
 [INFO] ------------------------------------------------------------------------
 [INFO] BUILD SUCCESSFUL
 [INFO] ------------------------------------------------------------------------
 [INFO] Total time: 29 seconds
 [INFO] Finished at: Fri Jun 22 16:55:27 CST 2012
 [INFO] Final Memory: 13M/150M
 [INFO] ------------------------------------------------------------------------

Run the Project

The project created by archetypes above should have a maven jetty plugin configured, you can just run the project with the command below:

mvn jetty:run

Import a Maven project into Eclipse

• [File] -> [Import] -> [Maven] --> [Existing Maven Projects]

  

• After this, the user should now get a new project in the Package explorer.

  

BOM

ZK provides a "bill of materials" (BOM) which can be used by your projects simplify a pom.xml. You can use it as a parent POM or import it like:

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.zkoss.zk</groupId>
				<artifactId>zk-bom</artifactId>
				<version>9.0.1-Eval</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

For a complete example, you can reference pom.xml of this project. You can also read a spring boot document to understand BOM usage.

Version History

Version	Date	Content
N/A	July 2014	Self-signed certificate related section removed as EE maven repository is certified since Feb. 2014