Updated project documentation.

git-svn-id: https://joinup.ec.europa.eu/svn/mocca/trunk@730 8a26b1a7-26f0-462f-b9ef-d0e30c41f5a4

23 files changed, 179 insertions, 35 deletions

diff --git a/BKUApplet/pom.xml b/BKUApplet/pom.xml
index 1c27294e..9a2d11f3 100644
--- a/BKUApplet/pom.xml
+++ b/BKUApplet/pom.xml
@@ -9,6 +9,7 @@
   <artifactId>BKUApplet</artifactId>
   <name>BKU Applet</name>
   <version>${project.parent.version}</version>
+  <description>Java Applet used by MOCCA Online</description>
   <build>
     <plugins>
       <plugin>
diff --git a/BKUAppletExt/pom.xml b/BKUAppletExt/pom.xml
index c60864bc..770f977b 100644
--- a/BKUAppletExt/pom.xml
+++ b/BKUAppletExt/pom.xml
@@ -7,9 +7,9 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>at.gv.egiz</groupId>
     <artifactId>BKUAppletExt</artifactId>
-    <name>BKU Applet Extension</name>
+    <name>BKU Applet Ext</name>
     <version>${project.parent.version}</version>
-    <description />
+    <description >Card management extension for Java Applet used by MOCCA Online</description>
     <dependencies>
         <dependency>
             <groupId>at.gv.egiz</groupId>
diff --git a/BKUCertificates/pom.xml b/BKUCertificates/pom.xml
index 8227014f..17f0a4cf 100644
--- a/BKUCertificates/pom.xml
+++ b/BKUCertificates/pom.xml
@@ -14,6 +14,7 @@
   <version>1.2</version>
   <name>BKU Certificates</name>
 
+  <description>Trusted certificates for TLS/SSL authentication</description>
   <build>
     <plugins>
       <plugin>
diff --git a/BKUCommonGUI/pom.xml b/BKUCommonGUI/pom.xml
index ccb47235..3d3f1446 100644
--- a/BKUCommonGUI/pom.xml
+++ b/BKUCommonGUI/pom.xml
@@ -7,7 +7,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>at.gv.egiz</groupId>
     <artifactId>BKUCommonGUI</artifactId>
-    <name>BKU GUI</name>
+    <name>BKU Common GUI</name>
     <version>${project.parent.version}</version>
     <dependencies>
         <dependency>
@@ -22,7 +22,8 @@
             <scope>compile</scope>
         </dependency>
     </dependencies>
-	  <build>
+    <description>Common GUI functionality</description>
+    <build>
 	    <plugins>
 	      <plugin>
 	        <artifactId>maven-compiler-plugin</artifactId>
diff --git a/BKUFonts/pom.xml b/BKUFonts/pom.xml
index abcb8339..592c5b38 100644
--- a/BKUFonts/pom.xml
+++ b/BKUFonts/pom.xml
@@ -16,26 +16,9 @@
      |   remains (not true for provided), see BKUViewer, BKULocal and
      |   BKUOnline -->
 
-    This module is used in validator(s) and viewer and is a direct dependency of
-      - bkucommon (direct runtime dependency)
-      - BKUViewer (transitive runtime from bkucommon)
-        TextValidator depends on the fonts. (TextValidator should rather use a FontProvider)
-      - BKUOnline (transitive runtime from bkucommon/bkuviewer)
-        unpack-fonts to applet dir and include jar in WEB-INF/lib
-      - BKULocal (transitive runtime from bkucommon/bkuviewer)
-      - removed the BKUCommonGUI (runtime; propagate dependency to BKUApplet):
-          no real dependency: BKUCommonGUI contains SecureFontProvider interface only
-          (which does not state how fonts are loaded); implementations should depend no BKUFonts
-          (ResourceFontLoader in BKULocal depends on the fonts, however URLFontLoader in BKUApplet doesn't.
-          BKUOnline however depends on BKUFonts for providing the fonts as web-resource for the applet)
+    Fonts used by validators and viewers
 
 
-    at.gv.egiz.bku.text.TextValidator and xxx.LocalFontProvider load fonts from classpath,
-    resource name must be known, TODO: encapsulate resource loading (FontProvider constants?)
-
-    at.gv.egiz.bku.online.applet.URLFontLoader loads (unpacked) font files from applet codebase, 
-    resource names _must_ be known since applet has no BKUFonts dependency
-
   </description>
   <build>
     <resources>
diff --git a/BKUFonts/src/site/apt/index.apt b/BKUFonts/src/site/apt/index.apt
new file mode 100644
index 00000000..6ed73926
--- /dev/null
+++ b/BKUFonts/src/site/apt/index.apt
@@ -0,0 +1,25 @@
+	---
+	About
+	---
+	EGIZ
+	---
+	2010
+	---
+
+BKU Fonts
+
+	This module provides fonts used in validator(s) and viewer and is a direct dependency of
+	
+    * bkucommon (direct runtime dependency)
+    
+    * BKUViewer (transitive runtime from bkucommon)
+      
+    TextValidator depends on the fonts. (TextValidator should rather use a FontProvider)
+      
+    * BKUOnline (transitive runtime from bkucommon/bkuviewer)
+    
+    unpack-fonts to applet dir and include jar in WEB-INF/lib
+    
+    * BKULocal (transitive runtime from bkucommon/bkuviewer)
+    
+
diff --git a/BKUGuiExt/pom.xml b/BKUGuiExt/pom.xml
index 85f06b1e..d5d9b47b 100644
--- a/BKUGuiExt/pom.xml
+++ b/BKUGuiExt/pom.xml
@@ -8,7 +8,8 @@
   <groupId>at.gv.egiz</groupId>
   <artifactId>BKUGuiExt</artifactId>
   <version>${project.parent.version}</version>
-  <name>BKU GUI Extension</name>
+  <name>BKU GUI Ext</name>
+  <description>Common BKU GUI functionality extension for card managment</description>
   <dependencies>
     <dependency>
       <groupId>at.gv.egiz</groupId>
diff --git a/BKULocal/pom.xml b/BKULocal/pom.xml
index 19e2633a..ef1d7900 100644
--- a/BKULocal/pom.xml
+++ b/BKULocal/pom.xml
@@ -11,7 +11,8 @@
 	<name>BKU Local</name>
 	<version>${project.parent.version}</version>
 
-  <build>
+	<description>MOCCA Local</description>
+	<build>
     <plugins>
       <plugin>
         <artifactId>maven-war-plugin</artifactId>
diff --git a/BKUOnline/pom.xml b/BKUOnline/pom.xml
index 20c6ff56..315e7cba 100644
--- a/BKUOnline/pom.xml
+++ b/BKUOnline/pom.xml
@@ -9,7 +9,7 @@
   <groupId>at.gv.egiz</groupId>
   <artifactId>BKUOnline</artifactId>
   <packaging>war</packaging>
-  <name>BKU Online</name>
+  <name>MOCCA Online</name>
   <version>${parent.version}</version>
 
   <pluginRepositories>
@@ -146,6 +146,7 @@
       <scope>provided</scope>
     </dependency>
   </dependencies>
+  <description>MOCCA Online</description>
   <build>
     <plugins>
       <plugin>
diff --git a/BKUViewer/pom.xml b/BKUViewer/pom.xml
index 69367c54..203d3ca1 100644
--- a/BKUViewer/pom.xml
+++ b/BKUViewer/pom.xml
@@ -9,7 +9,7 @@
 	<artifactId>BKUViewer</artifactId>
 	<name>BKU Viewer</name>
 	<version>${project.parent.version}</version>
-	<description />
+	<description >Validator for plain text and XHTML to-be signed content</description>
 	<dependencies>
 		<dependency>
 			<groupId>at.gv.egiz</groupId>
diff --git a/STAL/pom.xml b/STAL/pom.xml
index c4851c3d..f923a073 100644
--- a/STAL/pom.xml
+++ b/STAL/pom.xml
@@ -12,7 +12,8 @@
     <version>${parent.version}</version>
     <dependencies>
     </dependencies>
-	  <build>
+    <description>Security Token Access Layer</description>
+    <build>
 	    <plugins>
 	      <plugin>
 	        <artifactId>maven-compiler-plugin</artifactId>
diff --git a/STALExt/pom.xml b/STALExt/pom.xml
index 0d4dcc4c..376ba450 100644
--- a/STALExt/pom.xml
+++ b/STALExt/pom.xml
@@ -7,9 +7,9 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>at.gv.egiz</groupId>
   <artifactId>STALExt</artifactId>
-  <name>STAL Extension</name>
+  <name>STAL Ext</name>
   <version>${project.parent.version}</version>
-  <description />
+  <description>STAL extensions for card management</description>
   <dependencies>
     <dependency>
       <groupId>at.gv.egiz</groupId>
diff --git a/STALService/pom.xml b/STALService/pom.xml
index 2f1e3ed4..c25d955f 100644
--- a/STALService/pom.xml
+++ b/STALService/pom.xml
@@ -10,7 +10,7 @@
     <artifactId>STALService</artifactId>
     <name>STAL Service</name>
     <version>${project.parent.version}</version>
-    <description />
+    <description >STAL webservice interface</description>
     <dependencies>
         <dependency>
             <groupId>at.gv.egiz</groupId>
diff --git a/STALXService/pom.xml b/STALXService/pom.xml
index d4cb3e15..c71b3f75 100644
--- a/STALXService/pom.xml
+++ b/STALXService/pom.xml
@@ -7,8 +7,9 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>at.gv.egiz</groupId>
   <artifactId>STALXService</artifactId>
-  <name>STAL-X Service</name>
+  <name>STAL Ext Service</name>
   <version>${project.parent.version}</version>
+  <description>STAL extension webservice interface</description>
   <dependencies>
     <dependency>
       <artifactId>STALService</artifactId>
diff --git a/bkucommon/pom.xml b/bkucommon/pom.xml
index 1dbc8078..467e1ca9 100644
--- a/bkucommon/pom.xml
+++ b/bkucommon/pom.xml
@@ -135,4 +135,19 @@
 			<scope>compile</scope>
 		</dependency>
 	</dependencies>
+	<reporting>
+	  <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.7</version>
+        <configuration>
+          <doctitle>${project.name} API ${project.version}</doctitle>
+          <windowtitle>${project.name} API ${project.version}</windowtitle>
+          <testDoctitle>${project.name} Test API ${project.version}</testDoctitle>
+          <testWindowtitle>${project.name} Test API ${project.version}</testWindowtitle>
+        </configuration>
+      </plugin>
+	  </plugins>
+	</reporting>
 </project>
\ No newline at end of file
diff --git a/bkucommon/src/site/apt/configuration.apt b/bkucommon/src/site/apt/configuration.apt
new file mode 100644
index 00000000..cf1d384d
--- /dev/null
+++ b/bkucommon/src/site/apt/configuration.apt
@@ -0,0 +1,87 @@
+	---
+	Configuration
+	---
+	EGIZ
+	---
+	2010
+	---
+	
+MOCCA Configuration
+
+	Since MOCCA version 1.3 {{{http://commons.apache.org/configuration/}commons-configuration}} is used for the main configuration of MOCCA.
+	
+	The configuration is build by the {{{./apidocs/at/gv/egiz/bku/spring/ConfigurationFactoryBean.html} ConfigurationFactoryBean}} class. It creates a composite configuration using a default configuration read from {{{./apidocs/constant-values.html#at.gv.egiz.bku.spring.ConfigurationFactoryBean.DEFAULT_CONFIG}ConfigurationFactoryBean.DEFAULT_CONFIG}} and an (optional) resource specified by {{{./apidocs/at/gv/egiz/bku/spring/ConfigurationFactoryBean.html#setConfigurationResource(org.springframework.core.io.Resource)}setConfigurationResource(org.springframework.core.io.Resource)}}. The later {{{http://static.springsource.org/spring/docs/2.5.5/reference/resources.html}resource}} is usually injected via a {{{http://static.springsource.org/spring/docs/2.5.5/reference/beans.html}spring application context}}. See the configuration sections of MOCCA Online / MOCCA Local on how the configuration resource is constructed in their respective application contexts and on how to provide your own configuration file.
+	
+* Common Configuration Options
+
+	A typical configuraton file looks like the following:
+	
++------------------+
+<?xml version="1.0" encoding="UTF-8"?>
+<MoccaConfiguration version="1.0">
+  <RegisterSecurityProviders>true</RegisterSecurityProviders>
+  <DataURLConnection>
+    <MaxHops>50</MaxHops>
+  </DataURLConnection>
+  <ValidateHashDataInputs>true</ValidateHashDataInputs>
+  <SSL>
+    <certDirectory>./certStore</certDirectory>
+    <caDirectory>./trustStore</caDirectory>
+  </SSL>
+</MoccaConfiguration>
++------------------+
+
+** Supported Configuration Parameters
+
+	[<<<RegisterSecurityProviders>>>] Allows to controll if MOCCA should  register the <required> Java {{{http://java.sun.com/javase/6/docs/technotes/guides/security/crypto/CryptoSpec.html#ProviderArch}Cryptographic Service Providers}}. 
+	
+	NOTE: MOCCA will only work if the required security providers are registered. If this is set to <<<false>>>, the security providers must be registered by some other means (e.g. {{{http://java.sun.com/javase/6/docs/technotes/guides/security/crypto/CryptoSpec.html#ProviderInstalling}registered staticaly}}). 
+	
+	Default: <<<true>>>
+	
+	[<<<DataURLConnection>>>]
+	
+		[<<<MaxHops>>>] Sets the number of consequtive requests allowed to be recieved from the {{{http://www.buergerkarte.at/konzept/securitylayer/spezifikation/aktuell/bindings/Bindings.en.html#http.ablauf.schritte}DataURL}} server.
+		This allows to prevent from infinite request loops caused by erroneous server implementations.
+		
+		Default: <<<50>>>
+		
+	[<<<ValidateHashDataInputs>>>] Controls if to-be signed data is validated for conformity with the {{{http://www.buergerkarte.at/konzept/securitylayer/spezifikation/aktuell/viewerformat/ViewerFormat.en.html}standardised viewer format}} auf the Austrian Citizen Card spezification.
+	
+	Default: <<<true>>>
+	
+	[<<<SSL>>>]
+		
+		The following two configuration elements must provide an URL which resolves to a directory in the filesystem. It may either be an absolute URL or a relative URL, which is resolved using the URL of the configuration file.
+		
+		[<<<certDirectory>>>] Specifies the URL of a certificate store directory. This directory must contain all certificates required to build a valid certification chain up to an anchor of trust (e.g. a certificate also contained in the trust store directory). Certificate filenames are hashed. To add new certificates to the certificate store directory create a sub-directory named <<<toBeAdded>>> and put the certificates into this directory. They will then be added to the certificate store upon startup of MOCCA.
+		
+		Default: <<<classpath:at/gv/egiz/bku/certs/certStore>>>
+		
+		[<<<caDirectory>>>] Specifies the URL of a trust store directory. This directory must contain all certificates considered as a root of trust.
+		
+		NOTE: Any certificate in the trust store directory must also be present in the certificate store directory!
+		
+		Default: <<<classpath:at/gv/egiz/bku/certs/trustStore>>>
+		
+		[<<<sslProtocol>>>] Options: <<<TLS>>> (default) or <<<SSL>>>
+		
+		[]
+		
+		NOTE: Do not enable the following two options in production environments!
+
+		[<<<disableHostnameVerification>>>] May be set to <<<true>>> disable verification of the server host name given in the server's certificate.
+		
+		Default: <<<false>>>
+		
+		[<<<disableAllChecks>>>] May be set to <<<true>>> to disable all TSL/SSL related checks.
+		
+		Default: <<<false>>>
+		
+	[<<<ProductName>>>] May be specified to set the product name given by the <<<Server>>> and <<<User-Agent>>> HTTP headers as specified by {{{http://www.buergerkarte.at/konzept/securitylayer/spezifikation/aktuell/bindings/bindings.en.html#http}HTTP binding}}.
+	
+	[<<<ProductVersion>>>] May be specified to set the product version given by the <<<Server>>> and <<<User-Agent>>> HTTP headers as specified by {{{http://www.buergerkarte.at/konzept/securitylayer/spezifikation/aktuell/bindings/bindings.en.html#http}HTTP binding}}.
+
+	[<<<SignatureLayout>>>] May be specified to set the <<<SignatureLayout>>> HTTP header.
+	
+	
\ No newline at end of file
diff --git a/bkucommon/src/site/site.xml b/bkucommon/src/site/site.xml
index 7500b6cc..a1937bc3 100644
--- a/bkucommon/src/site/site.xml
+++ b/bkucommon/src/site/site.xml
@@ -30,6 +30,10 @@ under the License.
   <body>
   
     <menu ref="parent"/>
+    
+    <menu name="${project.name}">
+      <item name="Configuration" href="configuration.html"/>
+    </menu>
   
     <menu ref="reports"/>
 
diff --git a/pom.xml b/pom.xml
index d5b8f6fe..4197a375 100644
--- a/pom.xml
+++ b/pom.xml
@@ -34,6 +34,7 @@
     <module>smccSTALExt</module>
     <module>BKUFonts</module>
   </modules>
+  <inceptionYear>2007</inceptionYear>
   <developers>
     <developer>
       <id>mcentner</id>
@@ -55,6 +56,13 @@
     <name>E-Government Innovation Center (EGIZ)</name>
     <url>http://www.egiz.gv.at</url>
   </organization>
+	<licenses>
+	  <license>
+	    <name>Apache 2</name>
+	    <url>LICENSE.txt</url>
+	    <distribution>manually</distribution>
+	  </license>
+	</licenses>
   <build>
     <pluginManagement>
       <plugins>
@@ -180,11 +188,18 @@
   			<groupId>org.apache.maven.plugins</groupId>
   			<artifactId>maven-project-info-reports-plugin</artifactId>
   			<version>2.1.2</version>
+        <configuration>
+          <dependencyDetailsEnabled>true</dependencyDetailsEnabled>
+          <dependencyLocationsEnabled>false</dependencyLocationsEnabled>
+        </configuration>
   			<reportSets>
   				<reportSet>
   				  <reports>
               <report>index</report>
               <report>summary</report>
+              <report>license</report>
+              <report>dependencies</report>
+              <report>dependency-management</report>
   				  </reports>
   				</reportSet>
   			</reportSets>
@@ -334,4 +349,5 @@
       <url>scp://egovlabs.gv.at/var/lib/gforge/chroot/home/groups/mocca/htdocs</url>
     </site>
   </distributionManagement>
+  
 </project>
\ No newline at end of file
diff --git a/smcc/pom.xml b/smcc/pom.xml
index efda2522..c0d59481 100644
--- a/smcc/pom.xml
+++ b/smcc/pom.xml
@@ -10,7 +10,8 @@
   <name>smcc</name>
   <packaging>jar</packaging>
   <version>${project.parent.version}</version>
-	<build>
+  <description>Smart card communication</description>
+  <build>
 		<plugins>
 			<plugin>
 				<artifactId>maven-compiler-plugin</artifactId>
diff --git a/smccSTAL/pom.xml b/smccSTAL/pom.xml
index 5864e122..73fd2581 100644
--- a/smccSTAL/pom.xml
+++ b/smccSTAL/pom.xml
@@ -9,7 +9,8 @@
     <artifactId>smccSTAL</artifactId>
     <name>smcc STAL</name>
     <version>${project.parent.version}</version>
-	  <build>
+    <description>STAL implementation for smart cards using smcc</description>
+    <build>
 	    <plugins>
 	      <plugin>
 	        <artifactId>maven-compiler-plugin</artifactId>
diff --git a/smccSTALExt/pom.xml b/smccSTALExt/pom.xml
index 2411ba8e..deeaeb0d 100644
--- a/smccSTALExt/pom.xml
+++ b/smccSTALExt/pom.xml
@@ -8,7 +8,8 @@
   <groupId>at.gv.egiz</groupId>
   <artifactId>smccSTALExt</artifactId>
   <version>${project.parent.version}</version>
-  <name>smcc STAL Extension</name>
+  <name>smcc STAL Ext</name>
+  <description>STAL Ext implementation for smart cards using smcc</description>
   <dependencies>
     <dependency>
       <groupId>at.gv.egiz</groupId>
diff --git a/src/site/site.xml b/src/site/site.xml
index e43bec96..4f0ea09d 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -27,6 +27,8 @@ under the License.
     <href>http://mocca.egovlabs.gv.at/</href>
   </bannerLeft>
 
+  <version position="none"/>
+
   <body>
     <links>
       <item name="Austrian Citizen Card" href="http://www.buergerkarte.at"/>
diff --git a/utils/pom.xml b/utils/pom.xml
index 69e4f6d7..68e47055 100644
--- a/utils/pom.xml
+++ b/utils/pom.xml
@@ -7,9 +7,10 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>at.gv.egiz</groupId>
 	<artifactId>utils</artifactId>
-	<name>BKU Utils</name>
+	<name>Utils</name>
 	<packaging>jar</packaging>
 	<version>${parent.version}</version>
+	<description>Utilities</description>
 	<dependencies>
 		<dependency>
 			<groupId>org.slf4j</groupId>