Merge branch 'java17-upgrade'

# Conflicts: # .travis.yml # README.md # pom.xml # rsu-b2b-sample-client-gui/pom.xml # rsu-b2b-sample-client-gui/src/main/java/dk/skat/rsu/b2b/sample/mvc/ServiceTestAction.java # rsu-b2b-sample-client-gui/src/main/java/dk/skat/rsu/b2b/sample/mvc/ServiceTestForm.java # rsu-b2b-sample-client-gui/src/main/webapp/WEB-INF/web.xml # rsu-b2b-sample-client/pom.xml
skat · Apr 15, 2024 · 1f4016a · 1f4016a
2 parents 9214542 + 36bbf6a
commit 1f4016a
Show file tree

Hide file tree

Showing 45 changed files with 1,404 additions and 892 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,5 @@
 sudo: false
-dist: trusty
+dist: focal
 group: deprecated
 
 language: java
@@ -8,15 +8,16 @@ notifications:
   email: false
 
 jdk:
-  - oraclejdk8
+  - oraclejdk17
 
 before_install:
-  - wget --no-check-certificate https://archive.apache.org/dist/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.tar.gz
-  - sha512sum -c apache-maven-3.6.3-bin.tar.gz.sha512
-  - tar xzvf apache-maven-3.6.3-bin.tar.gz
-  - export PATH=`pwd`/apache-maven-3.6.3/bin:$PATH
+  - wget https://archive.apache.org/dist/maven/maven-3/3.9.5/binaries/apache-maven-3.9.5-bin.tar.gz
+  - sha512sum -c apache-maven-3.9.5-bin.tar.gz.sha512
+  - tar xzvf apache-maven-3.9.5-bin.tar.gz
+  - export PATH=`pwd`/apache-maven-3.9.5/bin:$PATH
   - mvn -v
 
 script:
   - mvn --version
+  # Skip unit test in CI
   - mvn clean install
diff --git a/README.md b/README.md
@@ -1,9 +1,6 @@
 # RSU B2B Sample Web Service Client written in Java
 
-[![Build Status](https://travis-ci.com/skat/rsu-b2b-sample-client-java.svg?token=pXpLRS1qCgHe3KVdbFyA&branch=master)](https://travis-ci.com/skat/rsu-b2b-sample-client-java)
-
-> **ModtagMomsangivelseForeloebig** is as of 2024 able to accept corrections to previous VAT returns going three (3) years back (as of current date). The service will return a notification code in the response telling if the submitted draft was (A) handled as the first VAT returns draft *OR* (B) if it was handled as a draft with the purpose of correcting a previously approved VAT returns. If your submitted draft is handled as a correction you will get code `5002` in `<ns:AdvisIdentifikator>5002</ns:AdvisIdentifikator>`. See the section [Notification codes related to transactions](#notification-codes-related-to-transactions) for futher details on these notification codes.
-
+[![Build Status](https://travis-ci.com/skat/rsu-b2b-sample-client-java.svg?token=pXpLRS1qCgHe3KVdbFyA&branch=master)](https://travis-ci.com/skat/rsu-b2b-sample-client-java) ![Java17](https://img.shields.io/badge/Java-17-green.svg)
 
 This GitHub contains documentation and a sample client for the RSU B2B Web Service Gateway, that provides APIs (SOAP Web Services) to submit **VAT returns**. The [sample client](#about-the-client) is developed in Java and using open source libraries demonstrating how the APIs works.
 
@@ -44,7 +41,6 @@ This GitHub contains documentation and a sample client for the RSU B2B Web Servi
    * [Run clients](#run-clients)
       * [Prerequisites](#prerequisites)
       * [Build and Run](#build-and-run)
-      * [Run on Tomcat](#run-on-tomcat)
       * [Change endpoints](#change-endpoints)
       * [Add new environment and endpoints](#add-new-environment-and-endpoints)
       * [Add another OCES3 certificate](#add-another-oces3-certificate)
@@ -68,11 +64,7 @@ The following diagram shows how the Web Services works.
 
 The first web service to use is **VirksomhedKalenderHent**. This Web Service returns dates for which the legal entity has to submit VAT Returns by. These dates are required, when submitting VAT Returns.
 
-The second web service is **ModtagMomsangivelseForeloebig**. This Web Services submits a draft of the VAT Returns to skat.dk with all the fields you need to fill in. The Web Service returns a deep link to skat.dk, where the legal entity can access the submitted VAT Returns and approve it. 
-
- **ModtagMomsangivelseForeloebig** is as of 2024 able to accept corrections to previous VAT returns going three (3) years back (as of current date). The service will return a notification code in the response telling if the submitted draft was (A) handled as the first VAT returns draft *OR* (B) if it was handled as a draft with the purpose of correcting a previously approved VAT returns. If your submitted draft is handled as a correction you will get code `5002` in `<ns:AdvisIdentifikator>5002</ns:AdvisIdentifikator>`.
-
-See the section [Notification codes related to transactions](#notification-codes-related-to-transactions) for futher details on these notification codes. This feature will enable RSU systems and their users to submit draft corrections to a VAT returns approved previously. The company still has to login on skat.dk and approve the submitted draft with corrections.
+The second web service is **ModtagMomsangivelseForeloebig**. This Web Services submits a draft of the VAT Returns to skat.dk with all the fields you need to fill in. The Web Service returns a deep link to skat.dk, where the legal entity can access the submitted VAT Returns and approve it.
 
 The last web service is **MomsangivelseKvitteringHent**. This Web Service provide a receipt for the VAT Returns given that the legal entity has approved it. This service also includes payment information on how to pay any outstanding balance.
 
@@ -94,23 +86,26 @@ The web services are implemented as SOAP Web Services. This GitHub contains WSDL
 
 ### Security
 
-The Web Services are protected using both TLS over HTTPS and by WS-Security using a certificate to both encrypt and sign the requests.
+The Web Services are protected using both TLS over HTTPS and by WS-Security (using a certificate for signing the request and
+response).
 
 **Transport Layer Security (TLS)**
 
-To be able to use the services, you need to add the server certificate to your trust store. You can find the certificates for both test and production in [pem/README.md](/pem/README.md).
+To be able to use the services, you need to add the server certificate to your trust store. You can find the certificates for both test and production here [https://github.com/skat/emcs-b2b-ws/tree/master/crt](https://github.com/skat/emcs-b2b-ws/tree/master/crt)
 
-The sample client in this GitHub already has the server certificate for the test environment in the trust store.
+The sample client in this GitHub repository comes prepared with server certificate for the test environment in the trust store.
 
 **WS-Security Protocol**
 
 To be able to use the Web Services you also need a company certificate (VOCES3) from MitID Erhverv (OCES3).
 A company certificate for the test environment is provided by contacting Skattestyrelsen. 
-To be able to use the services in production, you need to get an official company certificate. Information on how to get this is attached when you get access to the test environment.
+To be able to use the services in production, you need to get an official company certificate. 
+Information on how to get this is attached when you get access to the test environment. See more on the security & certificates here: 
+[https://github.com/skat/emcs-b2b-ws#security](https://github.com/skat/emcs-b2b-ws#security)
 
-The company certificate is used to sign (seal) the soap:body of the request and other additional security headers such a timestamp. The certificate is also used to validate the response. 
+The company certificate is used to sign the payload. The certificate is also used to validate and decrypt the response. 
 
-An example of a signed request can be found here: [rsu-b2b-sample-client/src/test/resources/VirksomhedKalenderHent_I_Document_Complete_With_SOAPENV.xml](rsu-b2b-sample-client/src/test/resources/VirksomhedKalenderHent_I_Document_Complete_With_SOAPENV.xml)
+An example of a signed payload  can be found here: [rsu-b2b-sample-client/src/test/resources/VirksomhedKalenderHent_I_Document_Complete_With_SOAPENV.xml](/rsu-b2b-sample-client/src/test/resources/VirksomhedKalenderHent_I_Document_Complete_With_SOAPENV.xml)
 
 ### Legal Entity Identification
 
@@ -342,8 +337,6 @@ The RSU B2B Gateway generates two types of error code.
 
 Error code | Error Description (EN) | Error Description (DA)
 ------------ | ------------- | -----------------------
- 471 | There are no VAT returns for the company | Der findes ingen angivelser for virksomheden
- 475 | There are no VAT returns for the requested periods in which the company has reported | Der findes ingen angivelser for de ønskede perioder hvor virksomheden har indberettet
 4801 | RSU is not delegated by the legal entity (See [Onboard Legal Entities](#onboard-legal-entities)) | RSU er ikke delegeret af virksomheden
 4802 | The VAT period is not open | Ikke åben periode 
 4803 | The VAT period has not ended | Periode ikke afsluttet
@@ -356,43 +349,11 @@ Error code | Error Description (EN) | Error Description (DA)
 4817 | The search start date is later than the search end date | Søgedato start er efter søgedatoslut
 
 
-### Notification codes related to transactions
-
-The service **ModtagMomsangivelseForeloebig** will for every successful submition of a VAT declaration return a formal notice related to the transaction in the **Advis** section of the **HovedOplysningerSvar/SvarStruktur** structure. Example:
-
-```xml
-<ns:HovedOplysningerSvar>
-        <ns:TransaktionIdentifikator>...</ns:TransaktionIdentifikator>
-        <ns:ServiceIdentifikator>...</ns:ServiceIdentifikator>
-        <ns:TransaktionTid>...</ns:TransaktionTid>
-        <ns:SvarStruktur>
-            <ns:AdvisStruktur>
-                <ns:AdvisIdentifikator>5001</ns:AdvisIdentifikator>
-                <ns:AdvisTekst>Dette er en foreløbig ordinær angivelse</ns:AdvisTekst>
-            </ns:AdvisStruktur>
-        </ns:SvarStruktur>
-</ns:HovedOplysningerSvar>
-``` 
-
-Please observe that notification codes are NOT the same as error codes
-
-The service will return either one of the two codes:
-
-Error code | Error Description (EN) | Error Description (DA)
------------- | ------------- | -----------------------
-5001 | This is a preliminary ordinary declaration pending user approval | Dette er en foreløbig ordinær angivelse
-5002 | This is a preliminary post declaration pending user approval | Dette er en foreløbig efterangivelse  
-
-The service **MomsangivelseKvitteringHent** will - similar to **ModtagMomsangivelseForeloebig** - return the following notice codes once the user has approved the declaration submitted via **ModtagMomsangivelseForeloebig** via skat.dk:
-
-Error code | Error Description (EN) | Error Description (DA)
------------- | ------------- | -----------------------
-5003 | The post declaration has now been approved, a receipt is available on skat.dk | Din efterangivelse er nu godkendt, en kvittering er tilgængelig på skat.dk 
-5004 | The ordinary declaration has now been approved, a receipt is available on skat.dk | Din ordinær angivelse er nu godkendt, en kvittering er tilgængelig på skat.dk
-
 ## About the client
 
-The following is documentation of a sample client for the RSU B2B Web Service Gateway. The sample client is implemented based on the [Apache CXF](http://cxf.apache.org/) framework, the Spring Framework, and Java 8. See `pom.xml` file in this repo for details regarding the current versions of the mentioned frameworks in use. 
+The following is documentation of a sample client for the RSU B2B Web Service Gateway. The sample client is implemented based on the [Apache CXF](http://cxf.apache.org/) framework, the Spring Framework, and Java 17. See `pom.xml` file in this repo for details regarding the current versions of the mentioned frameworks in use. 
+
+For a **Java 8** based client please take a look at release [v1.3](https://github.com/skat/rsu-b2b-sample-client-java/releases/tag/v1.3)
 
 > **Looking for a .NET Core sample?** Skatteforvaltningen provides a sample Web Service Client written in .NET Core
 > [here](https://github.com/skat/rsu-b2b-sample-client-dotnet).
@@ -484,17 +445,14 @@ call the test environment of RSU B2B Web Service Gateway.
 
 The parameters (provided as a file named `app.conf`) can be obtained by contacting Skattestyrelsen.
 
-In the following sections we describe two methods for running the sample:
-
-* **Build and Run** - Clone repo, build repo, and run locally.
-* **Run on Tomcat** - Clone repo, build repo, and run on a Tomcat server.
+In the following sections we describe a simple method for running the sample.
 
 ### Prerequisites
 
-For both methods the following tools are required:
+The following tools are required:
 
-* JDK 1.8
-* Maven 3.3 (or above)
+* JDK 17
+* Maven 3.9.5
 
 ### Build and Run
 
@@ -519,47 +477,6 @@ Once Jetty is running open URL:
 http://localhost:8080/rsu-b2b-sample-client-gui
 ```
 
-### Run on Tomcat
-
-Clone this repository. Then execute:
-
-```sh
-$ mvn clean install
-```
-
-On your **server** create a directory named `rsu-b2b-sample-client-gui`.
-
-Copy these files to the directory `rsu-b2b-sample-client-gui`:
-
-```
-rsu-b2b-sample-client-gui/target/rsu-b2b-sample-client-gui-<VERSION>-war-exec.jar
-rsu-b2b-sample-client/src/main/resources/keystore/client-keystore.jks
-rsu-b2b-sample-client/src/main/resources/keystore/server-keystore.jks
-```
-
-Organize the files as follows: 
-
-```
-rsu-b2b-sample-client-gui/
-  rsu-b2b-sample-client-gui-<VERSION>-war-exec.jar
-  keystore/
-    client-keystore.jks
-    server-keystore.jks
-  app.conf
-```
-
-Then inside `rsu-b2b-sample-client-gui` run:
-
-```sh
-$ java -jar rsu-b2b-sample-client-gui-<VERSION>-war-exec.jar
-```
-
-Once Tomcat is running open URL:
-
-```
-http://localhost:8080/rsu-b2b-sample-client-gui
-```
-
 ### Change endpoints
 
 If you want to have the test client call the built-in Log Servlet modify `app.conf` and 
@@ -669,10 +586,10 @@ $ keytool -delete -alias skatserver -keystore client-truststore.jks -storepass s
 Then you can add the new certificate to the trust store.
 
 ```sh
-$ keytool -import -alias skatserver -file newcert.crt -keystore client-truststore.jks -storepass storepassword
+$ keytool -import -alias skatserver -file emcs-b2b-server-prod-as-of-20171026.crt -keystore client-truststore.jks -storepass storepassword
 ```
 
 ## References
 
 * [Apache CXF](http://cxf.apache.org/)
-* [Apache CXF Samples](https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples)
+* [Apache CXF Samples](https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples)
diff --git a/apache-maven-3.9.5-bin.tar.gz.sha512 b/apache-maven-3.9.5-bin.tar.gz.sha512
@@ -0,0 +1 @@
+4810523ba025104106567d8a15a8aa19db35068c8c8be19e30b219a1d7e83bcab96124bf86dc424b1cd3c5edba25d69ec0b31751c136f88975d15406cab3842b  apache-maven-3.9.5-bin.tar.gz
diff --git a/assets/rsu_sample_gui_snapshot.png b/assets/rsu_sample_gui_snapshot.png
diff --git a/build-tomcat-package.sh b/build-tomcat-package.sh
diff --git a/jetty-run.sh b/jetty-run.sh
@@ -1,8 +1,8 @@
 #!/bin/sh
 
 # remove symbolic link
-rm -f keystore
+# rm -f keystore
 # create symbolic link
-ln -s rsu-b2b-sample-client/src/main/resources/keystore keystore
+# ln -s rsu-b2b-sample-client/src/main/resources/keystore keystore
 
 mvn jetty:run -f rsu-b2b-sample-client-gui/pom.xml
diff --git a/pom.xml b/pom.xml
@@ -1,31 +1,41 @@
-<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/maven-v4_0_0.xsd">
-    <modelVersion>4.0.0</modelVersion>
-    <groupId>dk.skat.rsu.b2b.sample</groupId>
-    <artifactId>rsu-b2b-sample-client-java</artifactId>
-    <packaging>pom</packaging>
-    <version>1.3</version>
-    <name>rsu-b2b-sample-client-java</name>
-    <url>http://www.skat.dk</url>
-    <modules>
-        <module>rsu-b2b-sample-client</module>
-        <module>rsu-b2b-sample-client-gui</module>
-    </modules>
-    <properties>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-    </properties>
-    <build>
-        <plugins>
-        </plugins>
-    </build>
-    <dependencyManagement>
-        <dependencies>
-            <dependency>
-                <groupId>com.typesafe</groupId>
-                <artifactId>config</artifactId>
-                <version>1.3.0</version>
-            </dependency>
-        </dependencies>
-    </dependencyManagement>
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>dk.skat.rsu.b2b.sample</groupId>
+  <artifactId>rsu-b2b-sample-client-java</artifactId>
+  <packaging>pom</packaging>
+  <version>1.4</version>
+  <name>rsu-b2b-sample-client-java</name>
+  <url>http://www.skat.dk</url>
+  <modules>
+    <module>rsu-b2b-sample-client</module>
+    <module>rsu-b2b-sample-client-gui</module>
+  </modules>
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+  </properties>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>3.10.1</version>
+        <configuration>
+          <source>17</source>
+          <target>17</target>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>com.typesafe</groupId>
+        <artifactId>config</artifactId>
+        <version>1.4.2</version>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
 </project>
diff --git a/prep-local-tomcat.sh b/prep-local-tomcat.sh
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		4810523ba025104106567d8a15a8aa19db35068c8c8be19e30b219a1d7e83bcab96124bf86dc424b1cd3c5edba25d69ec0b31751c136f88975d15406cab3842b apache-maven-3.9.5-bin.tar.gz