From 7216787ab4d7f5af05d499c5878d1e14a9c7d475 Mon Sep 17 00:00:00 2001
From: Nils Christian Ehmke <nie@informatik.uni-kiel.de>
Date: Mon, 20 May 2013 16:52:14 +0200
Subject: [PATCH] Added some additional infos to the pom and refactored it a
 little bit.

---
 Kieker.WebGUI/pom.xml | 79 ++++++++++++++++++++++++++++---------------
 1 file changed, 51 insertions(+), 28 deletions(-)

diff --git a/Kieker.WebGUI/pom.xml b/Kieker.WebGUI/pom.xml
index 44d9814e..07a17f9b 100644
--- a/Kieker.WebGUI/pom.xml
+++ b/Kieker.WebGUI/pom.xml
@@ -1,19 +1,29 @@
-
-<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" 
+         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>
 
+    <!-- Some information about the Kieker.WebGUI project. -->
+    <name>Kieker.WebGUI</name>
+    <url>http://kieker-monitoring.net/</url>
     <groupId>net.kieker-monitoring</groupId>
     <artifactId>Kieker.WebGUI</artifactId>
     <version>1.8-SNAPSHOT</version>
     <packaging>war</packaging>
-    <name>Kieker.WebGUI</name>
+    
+    <issueManagement>
+        <system>Trac</system>
+        <url>http://kieker.uni-kiel.de/trac/</url>
+    </issueManagement>
+
     <licenses>
         <license>
             <name>The Apache Software License, Version 2.0</name>
             <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
         </license>
     </licenses>
+    
     <developers>
         <developer>
             <id>nie</id>
@@ -22,25 +32,28 @@
         </developer>
     </developers>
 
+    <!-- Global properties for the build file. Some of the properties are used within other files (during the filter process in the package phase) -->
     <properties>
         <endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <kieker.jar>kieker-1.7_emf.jar</kieker.jar>
+        <java.version>1.6</java.version>
+        
         <klay.jar>klay_0.2.0.jar</klay.jar>
+        
+        <kieker.version>1.8-SNAPSHOT</kieker.version>
         <spring.version>3.1.2.RELEASE</spring.version>
-        <slf4j.version>1.7.2</slf4j.version>
+        
         <display_version>${project.version}</display_version>
     </properties>
-
+    
+    <!-- Repositories and dependencies. -->
     <repositories>
         <repository>
-            <id>prime-repo</id>
-            <name>PrimeFaces Maven Repository</name>
+            <id>Primefaces Repository</id>
             <url>http://repository.primefaces.org</url>
-            <layout>default</layout>
         </repository>
         <repository>
-            <id>sonatype.oss.snapshots</id>
+            <id>Sonatype Repository</id>
             <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
         </repository>
     </repositories>
@@ -105,17 +118,17 @@
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>jcl-over-slf4j</artifactId>
-            <version>${slf4j.version}</version>
+            <version>1.7.2</version>
         </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>
-            <version>${slf4j.version}</version>
+            <version>1.7.2</version>
         </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-log4j12</artifactId>
-            <version>${slf4j.version}</version>
+            <version>1.7.2</version>
         </dependency>
         <dependency>
             <groupId>com.ocpsoft</groupId>
@@ -191,16 +204,9 @@
         <dependency>
             <groupId>net.kieker-monitoring</groupId>
             <artifactId>kieker</artifactId>
-            <version>1.8-SNAPSHOT</version>
+            <version>${kieker.version}</version>
             <classifier>emf</classifier>
         </dependency>
-        <dependency> 
-            <groupId>kieler</groupId>
-            <artifactId>kieler</artifactId>
-            <version>0.2.0</version>
-            <scope>system</scope>
-            <systemPath>${project.basedir}/lib/${klay.jar}</systemPath>
-        </dependency>
         <dependency>
             <groupId>commons-io</groupId>
             <artifactId>commons-io</artifactId>
@@ -211,10 +217,19 @@
             <artifactId>commons-fileupload</artifactId>
             <version>1.3</version>
         </dependency>
+        <dependency> 
+            <groupId>kieler</groupId>
+            <artifactId>kieler</artifactId>
+            <version>0.2.0</version>
+            <scope>system</scope>
+            <systemPath>${project.basedir}/lib/${klay.jar}</systemPath>
+        </dependency>
     </dependencies>
 
+    <!-- The following are plugins which are used during the different phases. -->
     <build>
         <plugins>
+            <!-- Checkstyle -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-checkstyle-plugin</artifactId>
@@ -231,6 +246,7 @@
                     </execution>
                 </executions>
             </plugin>
+            <!-- Findbugs -->
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>findbugs-maven-plugin</artifactId>
@@ -249,6 +265,7 @@
                     </execution>
                 </executions>
             </plugin>
+            <!-- PMD -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-pmd-plugin</artifactId>
@@ -268,6 +285,7 @@
                     </execution>
                 </executions>
             </plugin>
+            <!-- Jetty Runner (to start the web application with the command "mvn jetty:run". This is used mostly for test purposes. -->
             <plugin>
                 <groupId>org.mortbay.jetty</groupId>
                 <artifactId>jetty-maven-plugin</artifactId>
@@ -280,27 +298,27 @@
                     <connectors>
                         <connector implementation="org.eclipse.jetty.server.nio.SelectChannelConnector">
                             <port>8080</port>
-                            <maxIdleTime>600000</maxIdleTime> <!-- 10 minutes in milliseconds! -->
+                            <maxIdleTime>600000</maxIdleTime>
                             <lowResourcesMaxIdleTime>600000</lowResourcesMaxIdleTime>
                         </connector>
                     </connectors>
                 </configuration>
             </plugin>
+            <!-- The compiler plugin makes sure that the correct compiler version is used. -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.0</version>
                 <configuration>
-                    <source>1.6</source>
-                    <target>1.6</target>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
                     <compilerArguments>
                         <endorseddirs>${endorsed.dir}</endorseddirs>
                     </compilerArguments>
                 </configuration>
             </plugin>
-            <!-- This is some kind of a hack, as maven doesn't want to include system jars into the war-file. We use ant instead. -->
-            <plugin>
-      
+            <!-- This plugin makes sure that a copy of the current kieker jar is copied into the correct directory during compiling. The name of the copied file should not be changed! --> 
+            <plugin> 
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-dependency-plugin</artifactId>
                 <version>2.8</version>
@@ -316,7 +334,7 @@
                                 <artifactItem>
                                     <groupId>net.kieker-monitoring</groupId>
                                     <artifactId>kieker</artifactId>
-                                    <version>1.8-SNAPSHOT</version>
+                                    <version>${kieker.version}</version>
                                     <classifier>emf</classifier>
                                     <type>jar</type>
                                     <overWrite>true</overWrite>
@@ -331,6 +349,8 @@
                     </execution>
                 </executions>
             </plugin>
+            
+            <!-- This is some kind of a hack, as maven doesn't want to include system jars into the war-file. We use ant instead. -->
             <plugin>
                 <artifactId>maven-antrun-plugin</artifactId>
                 <executions>
@@ -353,6 +373,7 @@
                     </execution>
                 </executions>
             </plugin>
+            <!-- The following plugin packs our files into a war file. It is also configured to filter some specific files from the web part (to replace place holders with actual values). -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-war-plugin</artifactId>
@@ -374,6 +395,7 @@
                     <failOnMissingWebXml>false</failOnMissingWebXml>
                 </configuration>
             </plugin>
+            <!-- JavaDoc -->
             <plugin>
                 <artifactId>maven-javadoc-plugin</artifactId> 
                 <version>2.9</version>
@@ -386,6 +408,7 @@
                     </execution>
                 </executions>
             </plugin>
+            <!-- This plugin packs all our files into the binary and source archives during the package phase. -->
             <plugin>
                 <artifactId>maven-assembly-plugin</artifactId>
                 <version>2.4</version>
-- 
GitLab