From d53d195b013b31445361a1ec53318a044b5fae5b Mon Sep 17 00:00:00 2001
From: Christof Rabensteiner <christof.rabensteiner@iaik.tugraz.at>
Date: Mon, 19 Aug 2019 16:15:42 +0200
Subject: Update Version of EAAF Components Dependency

- Also: Replace local repository with apps.egiz.gv.at/maven
- Update Readme and remove cumbersome "build via local repo" guide.
---
 readme.md | 61 +++++++++++++------------------------------------------------
 1 file changed, 13 insertions(+), 48 deletions(-)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index 9b7c04d..ff9c5e3 100644
--- a/readme.md
+++ b/readme.md
@@ -1,51 +1,12 @@
 # MOA ZS
 
-## Prepare for Compilation
+## Compile, Test and Package
 
-For compiling MOAZS, do the following:
-
-1. Checkout MoaZS repository (directory name `moazs.git`)
-1. Install `at.gv.egiz.eaaf.{eaaf_module_moa-sig, core}` to local repository.
-1. Make `eaaf_module_moa-sig`'s transitive dependencies available by copying or symlinking `eaaf_module_moa-sig`'s repository into MOAZS repository.
-
-Certain artifacts are not in the mvn central repo. You need to
-install those articats to your local maven repository.
-
-### How to Install `at.gv.egiz.eaaf` Artifacts
-
-Requirements: JDK 1.8
-
-```
-export EAAF_COMPONENTS_VERSION=1.0.7
-cd /path/to/working/dir
-git clone https://gitlab.iaik.tugraz.at/egiz/eaaf_components/
-cd eaaf_components
-git checkout $EAAF_COMPONENTS_VERSION
-mvn clean package source:jar install
-```
-
-### Workaround: Make eaaf_module_moa-sig's Transitive Dependencies Available
-
-`eaaf_module_moa-sig` depends on artifacts that are also not in mvn's
-central repo. You can make them available by copying or symlinking to
-the repository directory in
-https://gitlab.iaik.tugraz.at/egiz/eaaf_components/tree/master/eaaf_modules/eaaf_module_moa-sig/repository
-
-```
-cd moazs.git
-# symlink to moa sig's artifacts
-ln -s <path-to-local-eaaf-components-git-repo>/eaaf_modules/eaaf_module_moa-sig/repository
-# copy repository
-cp <path-to-local-eaaf-components-git-repo>/eaaf_modules/eaaf_module_moa-sig/repository .
-```
-
-## Compile & Test
+Compilation and Runtime Requirements:
+- openJDK 12 (OpenJDK 11 has an unfixed bug [1] that prevents the completion of TLS handshakes.)
 
 ### Run Unit Tests
 
-Requirements:
-- openJDK 12 (OpenJDK 11 has an unfixed bug [1] that prevents the completion of TLS handshakes.)
-
 Command:
 ```
 mvn test
@@ -53,18 +14,14 @@ mvn test
 
 ### Run Integration Tests
 
-Integration tests start with the prefix `IT`.
-
-Requirements:
-- OpenJDK 12
-- Some integration tests have additional requirements (e.g. ITMsgClientTest also tests the TLS connection and Client Authentication). Ensure that these requirements are met as well.
+Integration tests start with the prefix `IT`. Note that some integration tests have additional requirements (e.g. ITMsgClientTest also tests the TLS connection and Client Authentication). Ensure that these requirements are met as well.
 
 Command:
 ```
 mvn test -P integration-test
 ```
 
-### Quick Guide: Set Up SSL in Apache 2.
+#### Quick Guide: Set Up SSL (inc. Client Authentication) in Apache 2.
 
 Some tests in ITMsgClientTest require SSL protection of the service endpoint with SSL Client Authentication. Here's a quick guide how to set up an Apache 2 service on localhost as a SSL terminating reverse proxy to the zusemsg endpoint that runs on http://localhost:8081/ :
 
@@ -91,6 +48,14 @@ SSLCertificateChainFile <path/to/repo/ssl/server>/ca-chain.cert.pem
 SSLCACertificateFile <path/to/repo/ssl>/trusted-cas-bundle.pem
 ```
 
+## Package to .war
+
+```
+mvn clean package
+```
+
+Find the war file in the `target/` folder.
+
 # Footnotes
 
 [1] https://bugs.openjdk.java.net/browse/JDK-8214098
-- 
cgit v1.2.3