Merge pull request #2 from it-at-m/maint/cp-matching-service

Maint/cp matching service

.github/workflows/maven-node-build.yaml

@@ -0,0 +1,35 @@
+name: build all
+
+on: [ push ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      TZ: Europe/Berlin
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - app-path: matching-service
+    steps:
+      - uses: actions/checkout@v4
+      - if: ${{ hashFiles(format('./{0}/package.json', matrix.app-path)) != null }}
+        id: node
+        uses: it-at-m/.github/.github/actions/action-npm-build@main
+        with:
+          app-path: "${{ matrix.app-path }}"
+      - if: ${{ hashFiles(format('./{0}/pom.xml', matrix.app-path)) != null }}
+        id: maven
+        uses: it-at-m/.github/.github/actions/action-maven-build@main
+        with:
+          app-path: "${{ matrix.app-path }}"
+      - if: github.ref == 'refs/heads/main'
+        uses: it-at-m/.github/.github/actions/action-build-image@main
+        with:
+          path: "${{ matrix.app-path }}"
+          image-name: "${{ matrix.app-path }}"
+          artifact-name: ${{ join(steps.*.outputs.artifact-name) }}
+          registry-password: ${{ secrets.GITHUB_TOKEN }}
+          registry-username: ${{ github.actor }}
+          image-tags: |
+            type=raw,value=dev

.run/SwimMatchingServiceApplication.run.xml

@@ -0,0 +1,21 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="SwimMatchingServiceApplication" type="SpringBootApplicationConfigurationType" factoryName="Spring Boot">
+    <option name="ACTIVE_PROFILES" value="local" />
+    <module name="matching-service" />
+    <option name="SPRING_BOOT_MAIN_CLASS" value="de.muenchen.oss.swim.matching.SwimMatchingServiceApplication" />
+    <option name="VM_PARAMETERS" value="-Djava.rmi.server.hostname=localhost" />
+    <extension name="net.ashald.envfile">
+      <option name="IS_ENABLED" value="false" />
+      <option name="IS_SUBST" value="false" />
+      <option name="IS_PATH_MACRO_SUPPORTED" value="false" />
+      <option name="IS_IGNORE_MISSING_FILES" value="false" />
+      <option name="IS_ENABLE_EXPERIMENTAL_INTEGRATIONS" value="false" />
+      <ENTRIES>
+        <ENTRY IS_ENABLED="true" PARSER="runconfig" IS_EXECUTABLE="false" />
+      </ENTRIES>
+    </extension>
+    <method v="2">
+      <option name="Make" enabled="true" />
+    </method>
+  </configuration>
+</component>

README.md

@@ -12,7 +12,7 @@ The different components are built with [Spring](https://spring.io/).
 
 Following a list and short description of the different components:
 
-- TODO
+- [matching-service](./matching-service): Service for managing recipient matching data for the SWIM
 
 ## Contributing
 

matching-service/Dockerfile

@@ -0,0 +1,5 @@
+# For documentation see https://jboss-container-images.github.io/openjdk/
+FROM registry.access.redhat.com/ubi9/openjdk-21-runtime
+
+# Copy runnable jar to deployments
+COPY target/*.jar /deployments/application.jar

matching-service/README.md

@@ -0,0 +1,34 @@
+# SWIM matching service
+
+Service for managing recipient matching data for the SWIM (stadtweites Inputmanagement).
+
+## Data
+
+Following data is collected and provided:
+- DMS user inboxes which are enriched with the correlated user ldap data and put into the SWIM database
+- DMS group inboxes which are directly put into the SWIM database
+
+## Architecture
+
+```mermaid
+flowchart LR
+    dms[DMS]
+    u([User])
+    s[SWIM matching service]
+    l[LDAP]
+    db[(SWIM db)]
+    dms --- u
+    u --> s
+    s --> l
+    s --> db
+```
+
+## Development
+
+- The swim-matching-service is built with JDK21
+- For local development and testing a dev docker-compose stack is provided in `./stack`
+  - Can be started with `docker compose up -d`
+- The Spring profile `local` is preconfigured for using the stack
+  - Activate it either manually or by using the provided run configuration
+- After starting the application the import can be triggered via the [Swagger-UI](http://localhost:39146/swagger-ui/index.html)
+  - The default login is `user` with password `user`