Java Development with NetBeans and Maven: Part 5

Overview

I hope we are well prepared for moving further to the very powerful “Maven” features, which we have known before, the “site”, especially the “report” integration to the outer world. There are many powerful “Maven Plug-in” provided by the “Maven” itself. You can see further information here. From now on, I will introduce you the “Reporting Plug-ins”.

The Report Plug-ins

Regarding the “Maven Plug-in” here, you may be noticed that there are two plug in which we used before. Guess what? The “project-info-reports”, the “mvn site” command itself and the “surefire-report”, the testing report for our previous JUnit. You already know how easy it is. The rest plug in also be same for sure. One picture can give us a thousand words. Here is my tested template "Project POM File" (pom.xml). Please feel free to modify it so that it is fit for your environment.

001  002 <project xmlns="http://maven.apache.org/POM/4.0.0"  003 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 004 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0  005 http://maven.apache.org/maven-v4_0_0.xsd"> 006     <modelVersion>4.0.0</modelVersion> 007     <groupId>com.scc.maven.java</groupId> 008     <artifactId>MavenJavaPrj01</artifactId> 009     <packaging>jar</packaging> 010     <version>1.0-SNAPSHOT</version> 011     <name>MavenJavaPrj01</name> 012     <url>The Project web site URL</url> 013     <description>The SDLC Learning</description> 014  015     <licenses> 016         <license> 017             <name>Apache 2</name> 018             <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> 019             <distribution>repo</distribution> 020             <comments>A business-friendly OSS license</comments> 021         </license> 022     </licenses> 023  024     <organization> 025         <name>The Organization Name</name> 026         <url>The Organization web site URL</url> 027     </organization> 028  029     <developers> 030         <developer> 031             <id>The developer id</id> 032             <name>The developer name</name> 033             <email>The developer email</email> 034             <url>The developer web site URL</url> 035             <organization>The developer organization</organization> 036             <organizationUrl>The organization web site url</organizationUrl> 037             <roles> 038                 <role>Role #1</role> 039                 <role>Role #2</role> 040             </roles> 041             <timezone>+7</timezone> 042             <properties> 043                 <picUrl>The developer picture URL</picUrl> 044             </properties> 045         </developer> 046     </developers> 047  048     <issueManagement> 049         <system>The issue management system, e.g. Bugzilla, TestTrack,  050         ClearQuest, etc</system> 051         <url>The issue management system web site URL</url> 052     </issueManagement> 053  054     <ciManagement> 055         <system>The CI management system, e.g. Hudson,continuum, etc</system> 056         <url>The CI web site URL</url> 057         <notifiers> 058             <notifier> 059                 <type>mail</type> 060                 <sendOnError>true</sendOnError> 061                 <sendOnFailure>true</sendOnFailure> 062                 <sendOnSuccess>false</sendOnSuccess> 063                 <sendOnWarning>false</sendOnWarning> 064                 <configuration> 065                     <address>The sender email address</address> 066                 </configuration> 067             </notifier> 068         </notifiers> 069     </ciManagement> 070  071     <scm> 072         <connection>scm:svn:Path/To/Repository</connection> 073         <developerConnection>scm:svn:Path/To/Repository</developerConnection> 074         <tag>HEAD</tag> 075         <url>The SCM web site URL</url> 076     </scm> 077  078     <prerequisites> 079         <maven>2.2.1</maven> 080     </prerequisites> 081  082     <build> 083         <plugins> 084             <plugin> 085                 <groupId>org.apache.maven.plugins</groupId> 086                 <artifactId>maven-compiler-plugin</artifactId> 087                 <version>2.0.2</version> 088                 <configuration> 089                     <source>1.6</source> 090                     <target>1.6</target> 091                     <encoding>${project.build.sourceEncoding}</encoding> 092                 </configuration> 093             </plugin> 094             <plugin> 095                 <groupId>org.apache.maven.plugins</groupId> 096                 <artifactId>maven-resources-plugin</artifactId> 097                 <version>2.2</version> 098                 <configuration> 099                     <encoding>${project.build.sourceEncoding}</encoding> 100                 </configuration> 101             </plugin> 102             <plugin> 103                 <groupId>org.apache.maven.plugins</groupId> 104                 <artifactId>maven-surefire-plugin</artifactId> 105                 <version>2.6</version> 106                 <configuration> 107                     <encoding>${project.build.sourceEncoding}</encoding> 108                     <includes> 109                         <include> 110                             **/*TestSuite*.java 111                         </include> 112                     </includes> 113                 </configuration> 114             </plugin> 115             <plugin> 116                 <groupId>org.apache.maven.plugins</groupId> 117                 <artifactId>maven-site-plugin</artifactId> 118                 <version>2.1.1</version> 119                 <configuration> 120                     <locales>en</locales> 121                 </configuration> 122             </plugin> 123         </plugins> 124         <resources> 125             <resource> 126                 <directory>${basedir}/src/main/java</directory> 127                 <includes> 128                     <include>log4j.dtd</include> 129                     <include>log4j.xml</include> 130                 </includes> 131             </resource> 132         </resources> 133     </build> 134     <reporting> 135         <plugins> 136             <plugin> 137                 <groupId>org.apache.maven.plugins</groupId> 138                 <artifactId>maven-project-info-reports-plugin</artifactId> 139                 <version>2.2</version> 140             </plugin> 141  142             <plugin> 143                 <groupId>org.apache.maven.plugins</groupId> 144                 <artifactId>maven-surefire-report-plugin</artifactId> 145                 <version>2.6</version> 146             </plugin> 147             <plugin> 148                 <groupId>org.apache.maven.plugins</groupId> 149                 <artifactId>maven-changelog-plugin</artifactId> 150                 <version>2.2</version> 151                 <configuration> 152                     <username>${svnUser}</username> 153                     <password>${svnPassword}</password> 154                 </configuration> 155             </plugin> 156             <plugin> 157                 <groupId>org.apache.maven.plugins</groupId> 158                 <artifactId>maven-checkstyle-plugin</artifactId> 159                 <version>2.6</version> 160                 <configuration> 161                     <configLocation>config/sun_checks.xml</configLocation> 162                 </configuration> 163             </plugin> 164             <plugin> 165                 <groupId>org.apache.maven.plugins</groupId> 166                 <artifactId>maven-javadoc-plugin</artifactId> 167                 <version>2.7</version> 168                 <configuration> 169                     <stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css 170                     </stylesheetfile> 171                     <show>private</show> 172                 </configuration> 173             </plugin> 174             <plugin> 175                 <groupId>org.apache.maven.plugins</groupId> 176                 <artifactId>maven-jxr-plugin</artifactId> 177                 <version>2.2</version> 178                 <configuration> 179                     <linkXref>true</linkXref> 180                     <sourceEncoding>utf-8</sourceEncoding> 181                     <minimumTokens>100</minimumTokens> 182                     <targetJdk>1.5</targetJdk> 183                     <excludes> 184                         <exclude>**/*Bean.java</exclude> 185                         <exclude>**/generated/*.java</exclude> 186                     </excludes> 187                     <excludeRoots> 188                         <excludeRoot>target/generated-sources/stubs</excludeRoot> 189                     </excludeRoots> 190                 </configuration> 191             </plugin> 192             <plugin> 193                 <groupId>org.apache.maven.plugins</groupId> 194                 <artifactId>maven-pmd-plugin</artifactId> 195                 <version>2.5</version> 196             </plugin> 197  198         </plugins> 199     </reporting> 200     <dependencies> 201         <dependency> 202             <groupId>junit</groupId> 203             <artifactId>junit</artifactId> 204             <version>4.8.2</version> 205             <scope>test</scope> 206         </dependency> 207         <dependency> 208             <groupId>log4j</groupId> 209             <artifactId>log4j</artifactId> 210             <version>1.2.16</version> 211             <scope>compile</scope> 212         </dependency> 213     </dependencies> 214     <properties> 215         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 216     </properties> 217 </project>

How the report is created.

It is simple by using the “mvn site” command, please refer to my previous post.

Are there any outer world plug in?

Yes, sure. Why not? Maven also mentioned in their plug in page as well. Please travel to the lower part of that page you will see the outer world for sure. I hope we are enjoy traveling.

Summary

We have finished preparing our development environment so that we can ensure that there should not be any surprise during the integration with the very powerful “Maven” features, the “site”, especially the “report”. As I've mentioned, This is a final article for my first series.
The well preparing will help us to reduce the defect, on the other hand, if the defect is less, the working time is less, too. That mean we will have more time to do other things in my life. For me is writing this blog. Next I will move further to the detailed “Java/JavaEE” development with “Maven” and will do my best to post for sure. Please stay tuned as always.

Java Development with NetBeans and Maven: Part 4

Overview

We have configured our environment so that we can declare our own information outside the "Project POM File" (pom.xml) such as the "Subversion" user id and password, the "Issue Tracker" user id and password. But it is only the “Maven” universe. We live in the bigger one, the integration universe. That means we need to know the other integrated system universe. Even we configure our credential / personal information with purpose to let “Maven” to use them when it connect to each sever. It is just our credential / personal information. Since “Maven” acts as a client, it should provide credential / personal information itself, too. Normally these communication is done via the “SSL”, especially via the “HTTPS”. There are some good practice to which I would like share.

The HTTPS Good Practice For The Client

Most of integration universe has been configured and deployed under the “Apache HTTP” umbrella. As I've mentioned before, the “HTTPS” is preferred. This means the “Maven” will connect to them via the “HTTPS”, too. The “Maven” acts as a client, they act as a server for sure. What is the issues? Well, It is a very well known issue.

The Certificate Management For The Client

Normally the server provides its “certificate” to the client for initiating the “SSL” connection. The client will determine if this “certificate” can be trusted. If yes, the conversation will be initiated.

If not the connection will be dropped. We may face a trouble like we cannot connect to server system shows me something about “no trusted certificate found” or other close to this.

The HTTPS Client Configuration Good Practice

I am informing you about the good practice for the client side who would like to connect to the server via “HTTPS”. If the client is a “Java” environment, the “Server Certificate” should be injected to the “truststore”.

The “Server Certificate” is not only limited to the server certificate itself, but also the “Signer Certificate”, too. Please note the “Signer Certificate” is a certificate of the trusted authority who sign the “Server Certificate”. The signer also not be limited at one level, it can be more. It is called “Certificate Chain”. During the checking & verifying If any of “Certificate” inside this “Certificate Chain” is trusted, It will be determined as trusted. This means if we have 3 levels “Certificate Chain”.

The checking step is as following: -

1. If the level 3^rd is trusted, it is determined as trusted. The checking stop here.
2. If the level 2^nd is trusted, it is determined as trusted. The checking stop here.
3. If the level 1^st is trusted, it is determined as trusted. If not the system may show us as “no trusted certificate found”.

For me, I have 2 levels which are created by the “openssl”. Anyhow it can be a 1 level as a self-signed as well.

By default the “truststore” is as following:-

Table 1: The default truststore for JRE

Default Trustsore for JRE

<JRE_HOME>/lib/security/cacerts

Example: C:/Java.Application/Sun/Java/jre1.6.0_21/lib/security/cacerts

Table 2: The default truststore for JDK

Default Trustsore for JDK

<JDK_HOME>/jre/lib/security/cacerts

Example: C:/Java.Application/Sun/Java/jdk1.6.0_21/jre/lib/security/cacerts

The injecting certificate command is as following: -

Table 3: The injecting certificate command

The injecting certificate command

keytool -importcert -trustcacerts -alias <MY_ALIAS> -file <Certificate> -keystore <Truststore>

Example: keytool -importcert -trustcacerts -alias myserver -file server.cer -keystore cacerts Please note: you may be prompted to enter the password, the default password is “changeit”.

Some of them are not default.

Some of them may have their own configuration environment instead, especially the “Subversion Client”. There are 2 types as global for whole client and per-user.

The server-wide

Unix:

/etc/subversion/servers

/etc/subversion/config

/etc/subversion/hairstyles

Windows:

%ALLUSERSPROFILE%\Application Data\Subversion\servers

%ALLUSERSPROFILE%\Application Data\Subversion\config

%ALLUSERSPROFILE%\Application Data\Subversion\hairstyles

REGISTRY:HKLM\Software\Tigris.org\Subversion\Servers

REGISTRY:HKLM\Software\Tigris.org\Subversion\Config

REGISTRY:HKLM\Software\Tigris.org\Subversion\Hairstyles

The per-user

Unix:

~/.subversion/servers

~/.subversion/config

~/.subversion/hairstyles

Windows:

%APPDATA%\Subversion\servers

%APPDATA%\Subversion\config

%APPDATA%\Subversion\hairstyles

REGISTRY:HKCU\Software\Tigris.org\Subversion\Servers

REGISTRY:HKCU\Software\Tigris.org\Subversion\Config

REGISTRY:HKCU\Software\Tigris.org\Subversion\Hairstyles

I prefer to use the per-user instead. Please note, I'm a “Windows Vista”, my configuration home for “Subversion Client” is “C:\Users\Charlee.Ch\AppData\Roaming\Subversion”. Normally the per-user configuration is created automatically by the “Subversion Client”. If the “Subversion Client” does not trust the “Server Certificate”, you may face the message like this, “Server certificate verification failed: issuer is not trusted”. It can be configured easily by using the “Subversion Client” command via a command line, for me it is a dos prompt, as the following:

Table 4: Configure subversion client to trust the server certificate

Configure subversion client to trust the server certificate

svn list https://<YOUR_DOMAIN/svn/path/to/repository

Example: svn list https://www.mydomain.com/svn/myproject/trunk

During executing this command, you will be prompted about the “Server Certificate”. Please press “p”, for accepting this certificate permanently. Anyhow the system may prompt you to provide the credential, please enter it properly. The top most certificate for the “Server Certificate Chain” will be stored at your local as the following: -

Table 5: The stored server certificate folder

The stored server certificate folder

<SVN_CLIENT_HOME>/auth/svn.ssl.server

Example: C:\Users\Charlee.Ch\AppData\Roaming\Subversion\auth\svn.ssl.server

Summary

At the moment, we understand that not only our credential / personal information should be configured, but also the “Maven” credential / personal information for itself should be configured, too. This will help us to achieve further integrating more simple and avoid the well know issues, such as the “HTTPS Client Configuration”. We are well prepared and ready for the next step, “Maven” integration with “Subversion” and “Issue Tracker”. I will post it soon, please stay tuned as always.

Java Development with NetBeans and Maven: Part 3

Overview

Since the Maven can integrate to the other system, such as "Issue Tracker", "Version Control System", especially the "Repository Manager", which we will deploy our artifact for sharing to our team. All those target system is usually protected. We must provide the "security information / credential" such as user id and password for accessing it.

Normally we can declare the "security information /credential" inside the "Project POM File" (pom.xml). Please consider, in the real world development environment, they are many people joining the same project. The "Project POM File" (pom.xml) is also shared, too. If we decide to store that security information /credential" at the "Project POM File" (pom.xml). We may face a difficult if everyone keep updating the "Project POM File" (pom.xml) over and over. It would be nice that we can link the personal information, such as the security information /credential", to the

"Project POM File" (pom.xml).

Declare Our Own Information

You may have seen it berfore, The "settings.xml". Please refer to my previous post, about the "Maven Repository Manager", the "Artifactory" which can manage the repository and artifact for us. We use the "settings.xml" to notify "Maven" that it should connect to our  "Maven Repository Manager", the "Artifactory" instead of connect to the remote repository in the internet.

Inside the <profile> tag, we can declare a <properties> tag. The element inside this tag can be named any as we need. e.g. <userId>, and we can refer it in the "Project POM File" (pom.xml) by the ${MY_VARIABLE}, e.g. ${userId}. Pleases see further information here.

The we can declare our own "security information /credential" such as <issueUserId>, <issuePassword>,<vcsUserId>, <vcsPassword> and so on, so that we achieve configure our own "security information /credential".

01 <profiles> 02     <profile> 03         .......... 04         <id>artifactory</id> 05         <properties> 06             <svnUser>user1</svnUser> 07             <svnPassword>password</svnPassword> 08             <bugzillaUser>user2</bugzillaUser> 09             <bugzillaPassword>password</bugzillaPassword> 10         </properties> 11     </profile> 12 </profiles>

Special Feature for the Maven Repository Manager

We can declare our credential for accessing the "Maven Repository Manager", please note the "Maven Repository Manager" usually anonymous downloading, but not for deploying.

01 <servers> 02     <server> 03         <id>The Reference Id</id> 04         <username>User</username> 05         <password>password</password> 06         <filePermissions>777</filePermissions> 07         <directoryPermissions>777</directoryPermissions> 08         <!-- 09         <privateKey>${user.home}/.ssh/id_dsa</privateKey> 10         <passphrase>some_passphrase</passphrase> 11         <filePermissions>664</filePermissions> 12         <directoryPermissions>775</directoryPermissions> 13         <configuration></configuration> 14         --> 15     </server> 16 </servers>

The password encryption

It can be done by following this document. I will intoduce you an overview.

Create Master Password

Create the master passowrd

mvn --encrypt-master-password <password>

Store it for future referencing

Please create a file named "settings-security.xml" at <USER_HOME>/.m2 and put the following content into it.

1 <settingsSecurity> 2   <master>Master Password</master> 3 </settingsSecurity>

Encrypt The Password

Create the master passowrd

mvn --encrypt-password <password>

Please copy the encrypted password and paste to the "settings.xml", the <server> tag.

The Artifactory

If the security is enable for the "Artifactory", we can not use the "clear password", or take it to encrypt with the master password. The "Artifactory" encrypted value is required. The step for picking that vaule is as following: -

   
1. Please log in to "Maven     Repository Manager", the "Artifactory".
   
2. Go to your profile page by     clicking the name displayed at the top-right of the screen.
   
3. Enter your current password and     press "Unlock" button.
   
4. The encrypted password will be     displayed at the "Encrypted Password"     text box.
   
5. Copy the whole displayed value,     including the {DESede} or other.
   
6. You can use this value at the     "settings.xml", the     <server> tag.
   
7. You can also "double     encrypt" by using the maven encryption, too.

Summary

At the moment we can declare our own information at the "settings.xml" and link it to the "Project POM File" (pom.xml). We also understand the special feature for the "Maven Repository Manager", the password encryption, including the specific for the "Artifactory".

Next I will make use of these to integrate with Version Control System, Issue Tracker, especially to create a report and maven site. Please stay tuned as always.

Java Development with NetBeans and Maven: Part 2

Overview

Now we will focus on the further maven configuration. There are a lot of pulgins provided by the Maven. I would like to pay more attention to the unit testing, the Maven Surefire Plugin and Maven Surefire Report Plugin. Normally the JUnit is supported by default. I also prefer the latest JUnit 4.

Not only the unit testing, but also my most favorite library, the Apache Log4J. I will add it to my project at the same time. I cannot live without Log4J.

Adding New Library To The Project

Previously, without Maven, I've faced the trouble about managing my java library. I've no idea to organize it as the following scenarios: -

1. Where is the right place to store the library? The my decided shared folder? The Java project folder? The WEB-INF/lib folder?
2. Should I set the user library inside my IDE? Which IDE should I use? How to share them across my team?
3. How to use this structure across my team?
4. How to ensure the completion when we get the source code from repository or version control?
5. Blah blah blah....

My trouble is solved by the Maven. They are stored and managed transparently by the Local Repository. There is no any stored library inside my project folder. Only the dependency configuration is required.

Let's try to add the Log4J

I will show how simple it is. Just open the Project POM file (pom.xml) and add the Log4J dependency, inside the <dependencies> tag. Again I prefer the latest version as always.

1 <dependencies> 2     …................ 3     <dependency> 4         <groupId>log4j</groupId> 5         <artifactId>log4j</artifactId> 6         <version>1.2.16</version> 7         <scope>compile</scope> 8     </dependency> 9 </dependencies>

Next we will add the Log4J configuration to our project, by default this configuration file is nice to be stored at the “Project Default Package”, by the way it would be better to be stored at the “CLASSPATH”. Anyhow, regarding to my experience, I prefer to store it at the “Project Default Package”. Please note, it is just a simply copying and pasting to that folder. Then we will configure the Project POM file (pom.xml) so that it knows our configuration by adding the <resources> tag inside the <build> tag.

1 <resources> 2     <resource> 3         <directory>${basedir}/src/main/java</directory> 4         <includes> 5             <include>YOUR_RESOURCE</include> 6             <include>YOUR_RESOURCE</include> 7         </includes> 8     </resource> 9 </resources>

Please note, you can add more resources as you need.

Writing The Code

I will modify my previous class, the “HelloWorld” application so that it print out the message before returning.

01 package com.scc.maven.java.prj01; 02  03 import org.apache.log4j.Logger; 04  05 /** 06  * Hello world! 07  * 08  */ 09 public class App{ 10     private static final Logger logger = Logger.getLogger(App.class); 11     public String says(String name){ 12         String message = "Hello " + name; 13         logger.info("The saying message is: " + message); 14         return message; 15     } 16 }

Create TestSuite

At the moment I will be back the unit testing by adding the “TestSuite” to my project. Normally I name it by add the wording “TestSuite” at the end of the class name. You will see the reason why I do like this.

01 /* 02  * To change this template, choose Tools | Templates 03  * and open the template in the editor. 04  */ 05  06 package com.mycompany.locallib; 07  08 import org.junit.After; 09 import org.junit.AfterClass; 10 import org.junit.Before; 11 import org.junit.BeforeClass; 12 import org.junit.runner.RunWith; 13 import org.junit.runners.Suite; 14  15 /** 16  * 17  * @author Charlee.Ch 18  */ 19 @RunWith(Suite.class) 20 @Suite.SuiteClasses({com.mycompany.locallib.AppTest.class}) 21 public class NewTestSuite { 22  23     @BeforeClass 24     public static void setUpClass() throws Exception { 25     } 26  27     @AfterClass 28     public static void tearDownClass() throws Exception { 29     } 30  31     @Before 32     public void setUp() throws Exception { 33     } 34  35     @After 36     public void tearDown() throws Exception { 37     } 38  39 }

It has not been finished yet, The Project POM file (pom.xml) need to be modified by mention the “Maven Surefire Plugin” at the <plugins> tag and configure it so that it accept my test suite class.

The key is “**/*TestSuite*.java” and it is a reason why I name it as it is.

01 <plugin> 02     <groupId>org.apache.maven.plugins</groupId> 03     <artifactId>maven-surefire-plugin</artifactId> 04     <version>2.6</version> 05     <configuration> 06         <includes> 07             <include> 08                 **/*TestSuite*.java 09             </include> 10         </includes> 11     </configuration> 12 </plugin>

Building & Testing

As I've mentioned before, during the “Build” or “Clean and Build” is executed, the unit testing will be executed automatically. If you would like to explicitly execute, just right clicking at your test class and choose “Test File”.

Configure The Unit Testing Report

I would like to create a summary report for my unit testing by using the “Maven Surefire Report Plugin”. Please note, the report will be created automatically when the maven site is created, anyhow you can explicitly execute. At the moment I prefer running explicitly.

Configure the Maven Surefire Report Plugin”

Firstly we will modify the Project POM file (pom.xml) by adding the <reporting> tag and “Maven Surefire Report Plugin” configuration at the same level of the <build> tag.

1 <reporting> 2     <plugins> 3         <plugin> 4             <groupId>org.apache.maven.plugins</groupId> 5             <artifactId>maven-surefire-report-plugin</artifactId> 6             <version>2.6</version> 7         </plugin> 8     </plugins> 9 </reporting>

Add Custom Maven Command

Second I will add the “Custom Maven Command” to the NetBeans Java Project so that the unit testing report can be generated. It is simply action as the following step: -

1. Go to project properties.
2. Inside the “Project Properties” windows, under the “Categories”, choose “Actions”.
3. On the right hand panel, Click “Add Custom..” button.
4. Enter the “Action Name” as “My.Surefire.Report”.
5. Enter the “Execure Goal” as “surefire-report:report ”.

Execute The Custom Maven Command

Right click at your project and choose “Custom” --> “My.Surefire.Report”, It will display my previous created “Custom Maven Command”. Please note, the missing resources which are not in your “Local Repository” will be downloaded automatically as usual. The generated report is stored at <Project Folder>/target/site/surefire-report.html. Please look around it.

Summary

Now we are understand about the further Maven configuration, including with adding new resources, configuring the test suite and especially the unit testing report, plus create a custom maven command inside the NetBeans.

Next I will introduce more Maven Configuration, e.g. creating a site, configuring the version control, configuring the issues tracker, make use of them as a release note, and so on. Please stay tuned as always.