Using Maven"

From Documentation
 
(9 intermediate revisions by 5 users not shown)
Line 7: Line 7:
 
== Dependency ==
 
== Dependency ==
  
The dependency setting in your pom.xml stays the same regardless of your user status (evaluating or a premium customer).
+
Check [https://mavensync.zkoss.org/eval/org/zkoss/pivot/pivottable/ evaluation repository] or [https://maven.zkoss.org/repo/zk/ee/org/zkoss/pivot/pivottable/ premium repository] for available versions.
 
 
 
<source lang="xml">
 
<source lang="xml">
 
<dependencies>
 
<dependencies>
Line 14: Line 13:
 
<groupId>org.zkoss.pivot</groupId>
 
<groupId>org.zkoss.pivot</groupId>
 
<artifactId>pivottable</artifactId>
 
<artifactId>pivottable</artifactId>
<version>2.0.1</version>
+
<version>2.5.1</version>
 
</dependency>
 
</dependency>
 
</dependencies>
 
</dependencies>
Line 40: Line 39:
 
* <span style="color:red">'''Notice'''</span>: Need [[ZK_Pivottable_Essentials/Quick_Start/Using_Maven#Login_authentication|Login authentication]]
 
* <span style="color:red">'''Notice'''</span>: Need [[ZK_Pivottable_Essentials/Quick_Start/Using_Maven#Login_authentication|Login authentication]]
  
: If you are our customer or ZOL licensed user, please contact [mailto:info@zkoss.org info@zkoss.org] to apply for a premium maven account to use ZK Premium Maven Repository.
+
: If you are our customer, please apply for a premium maven account to use ZK Premium Maven Repository.
  
* http://maven.zkoss.org/repo/zk/ee
+
* https://maven.zkoss.org/repo/zk/ee
  
 
<source lang="xml">
 
<source lang="xml">
 
<repositories>
 
<repositories>
 
<repository>
 
<repository>
<id>ZK EE Repository</id>
+
<id>ZK EE</id>
 
<url>https://maven.zkoss.org/repo/zk/ee</url>
 
<url>https://maven.zkoss.org/repo/zk/ee</url>
 
</repository>
 
</repository>
Line 68: Line 67:
 
<servers>
 
<servers>
 
<server>
 
<server>
<id>ZK EE Repository</id><!-- Same as the repository name used in your pom.xml -->
+
<id>ZK EE</id>
<!-- Please replace the following with your premium username and password -->
+
<!-- Same as the repository name used in your pom.xml -->
 +
<!-- Please replace the following with your  
 +
premium username and password -->
 
<username>premium</username>
 
<username>premium</username>
 
<password>2k0553cr3t</password>
 
<password>2k0553cr3t</password>
Line 79: Line 80:
 
==== Sample of pom.xml for licensed ZK Pivottable Package ====
 
==== Sample of pom.xml for licensed ZK Pivottable Package ====
 
<source lang="xml">
 
<source lang="xml">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+
<project xmlns="http://maven.apache.org/POM/4.0.0"  
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
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>
 
<modelVersion>4.0.0</modelVersion>
 
<groupId>zkpvt</groupId>
 
<groupId>zkpvt</groupId>
Line 158: Line 161:
 
* 1. Add purge-local-repository plugin in pom.xml
 
* 1. Add purge-local-repository plugin in pom.xml
 
<source lang="xml">
 
<source lang="xml">
<build>
+
    <build>
<plugins>
+
        <plugins>
<plugin>
+
            <plugin>
<groupId>org.apache.maven.plugins</groupId>
+
                <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
+
                <artifactId>maven-dependency-plugin</artifactId>
<version>2.6</version>
+
                <version>2.6</version>
<executions>
+
                <executions>
<execution>
+
                    <execution>
<id>purge-local-dependencies</id>
+
                        <id>purge-local-dependencies</id>
<phase>clean</phase>
+
                        <phase>clean</phase>
<goals>
+
                        <goals>
<goal>purge-local-repository</goal>
+
                            <goal>purge-local-repository</goal>
</goals>
+
                        </goals>
<configuration>
+
                        <configuration>
<manualIncludes>
+
                            <manualIncludes>
<manualInclude>org.zkoss.pivot:pivottable</manualInclude>
+
                                <manualInclude>org.zkoss.pivot:pivottable
<manualInclude>org.zkoss.poi:zpoiex</manualInclude>
+
                                </manualInclude>
</manualIncludes>
+
                                <manualInclude>org.zkoss.poi:zpoiex
</configuration>
+
                                </manualInclude>
</execution>
+
                            </manualIncludes>
</executions>
+
                        </configuration>
</plugin>
+
                    </execution>
</plugins>
+
                </executions>
</build>
+
            </plugin>
 +
        </plugins>
 +
    </build>
 
</source>
 
</source>
  
Line 187: Line 192:
 
<source lang="xml">
 
<source lang="xml">
 
mvn clean
 
mvn clean
</source>
 
=====Self-signed Certificate=====
 
If you were a customer having a premium account and your Maven reported the following error message:
 
 
'''sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target'''
 
 
Please contact [mailto:info@zkoss.org info@zkoss.org] to request a certificate file and import the certificate using keytool:
 
<source lang="xml">
 
keytool –import –noprompt –trustcacerts –alias ALIASNAME -file FILENAME_OF_THE_INSTALLED_CERTIFICATE -keystore PATH_TO_CACERTS_FILE -storepass PASSWORD
 
</source>
 
'''Note''': The initial password of the "cacerts" keystore file is "changeit". Please refer to [http://docs.oracle.com/javase/6/docs/technotes/tools/solaris/keytool.html here] for detail.
 
 
'''Example:'''
 
 
<source lang="xml">
 
keytool -import -noprompt -trustcacerts -alias ZKOSS_root_CA -file C:\maven_test\ZKOSS_root_CA.crt -keystore "C:\Program Files\Java\jdk1.6.0_18\jre\lib\security\cacerts" -storepass changeit
 
 
</source>
 
</source>
  

Latest revision as of 07:52, 3 October 2022


This section describes the Maven settings required to use ZK Pivottable in your application. Please refer to this article for the Maven settings for ZK Framework.

Dependency

Check evaluation repository or premium repository for available versions.

<dependencies>	
	<dependency>
		<groupId>org.zkoss.pivot</groupId>
		<artifactId>pivottable</artifactId>
		<version>2.5.1</version>
	</dependency>
</dependencies>

Repository

You would refer to different repositories in your pom.xml depending on whether you are evaluating or you are a premium user.

Evaluating users (60-days free evaluation)

	<repositories>
		<repository>
			<id>ZK Evaluation Repository</id>
			<url>http://mavensync.zkoss.org/eval</url>
		</repository>
	</repositories>

Premium users only

If you are our customer, please apply for a premium maven account to use ZK Premium Maven Repository.
<repositories>
	<repository>
		<id>ZK EE</id>
		<url>https://maven.zkoss.org/repo/zk/ee</url>
	</repository>
</repositories>

Login authentication

Please refer to the official documentation of Apache Maven project for storing login authentication credential in the global settings file.

  • Location (if not already existed, you can create it manually)
    • Maven installation root: $M2_HOME/conf/settings.xml - OR -
    • User's Maven root: ${user.home}/.m2/settings.xml
<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 the repository name used in your pom.xml -->
			<!-- Please replace the following with your 
				premium username and password -->
			<username>premium</username>
			<password>2k0553cr3t</password>
		</server>
	</servers>
</settings>

Sample of pom.xml for licensed ZK Pivottable 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>zkpvt</groupId>
	<artifactId>sample</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<properties>
		<!-- please change the version accordingly -->
		<zk.version>6.5.2</zk.version>
		<commons-io>1.3.1</commons-io>
		<zkpivot.version>2.0.2</zkpivot.version>
		<zkpoi.version>3.8.1</zkpoi.version>
	</properties>
	<packaging>war</packaging>
	<name>The sample Project</name>
	<repositories>
		<repository>
			<id>ZK CE</id>
			<name>ZK CE Repository</name>
			<url>http://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>zkbind</artifactId>
			<version>${zk.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zul</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>
		
		<dependency>
			<groupId>commons-io</groupId>
			<artifactId>commons-io</artifactId>
			<version>${commons-io}</version>
		</dependency>
		
		<!-- ZK Pivottable -->
	    <dependency>
	        <groupId>org.zkoss.pivot</groupId>
	        <artifactId>pivottable</artifactId>
	        <version>${zkpivot.version}</version>
	    </dependency>
	    <!-- Optional: ZK Pivottable dependency (export to excel format) -->
		<dependency>
			<groupId>org.zkoss.poi</groupId>
			<artifactId>zpoiex</artifactId>
			<version>${zkpoi.version}</version>
		</dependency>
	    
	</dependencies>
</project>

Troubleshooting

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

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.pivot:pivottable
                                </manualInclude>
                                <manualInclude>org.zkoss.poi:zpoiex
                                </manualInclude>
                            </manualIncludes>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
  • 2. Invoke maven clean to delete local repository evaluation cache
mvn clean

Version History

Last Update : 2022/10/03


Version Date Content
2.0.0 June 2012 Add Maven information



Last Update : 2022/10/03

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.