From bb8e27e376ff1f508f638b300f81d828cf95ab0a Mon Sep 17 00:00:00 2001 From: Simon Hirtreiter Date: Thu, 5 Sep 2024 13:51:31 +0200 Subject: [PATCH] :memo: address update README.md --- refarch-integrations/README.md | 1 + .../refarch-address-integration/README.md | 83 ++++--------------- 2 files changed, 18 insertions(+), 66 deletions(-) diff --git a/refarch-integrations/README.md b/refarch-integrations/README.md index 280a3158..e6774a9b 100644 --- a/refarch-integrations/README.md +++ b/refarch-integrations/README.md @@ -8,6 +8,7 @@ Collection of different integration which can be used as is in RefArch projects. in other integrations. - [email-integration](./refarch-email-integration/README.md): For sending text and html emails with attachments. Uses s3-integration for file handling. +- [address-integration](./refarch-email-integration/README.md): For reading, searching and validating addresses. ## Naming conventions diff --git a/refarch-integrations/refarch-address-integration/README.md b/refarch-integrations/refarch-address-integration/README.md index 0bbf7463..1e7ec66d 100644 --- a/refarch-integrations/refarch-address-integration/README.md +++ b/refarch-integrations/refarch-address-integration/README.md @@ -1,73 +1,24 @@ -# DigiWF Address Integration +# RefArch address integration -The Address Integration connects the address service of the City of Munich to the DigiWF platform, allowing information -about addresses and streets to be retrieved. +Integration for reading, searching and validating addresses via the LHM address service. -## Usage of the Spring Boot Starter +## Usage -The common description of all starters can be found in the -common [README](https://github.com/it-at-m/digiwf-core/blob/dev/digiwf-integrations/README.md#spring-boot-starter). +```xml -The Address Client is responsible for communication with the City of Munich's Address Service. The client was -implemented as a library in its own Maven module to encapsulate dependencies. The implementation of the client can also -be extended or replaced by implementing the API interfaces AddressGermanyApi, AddressMunichApi, and StreetsMunichApi. -These interfaces must also be provided as `@Bean`. + + + de.muenchen.refarch + refarch-address-integration-starter + ... + + +``` -You can find the API interfaces at the -path: [digiwf-address-integration-client/src/main/java/de/muenchen/oss/digiwf/address/integration/client/api](https://github.com/it-at-m/digiwf-core/tree/dev/digiwf-integrations/digiwf-address-integration/digiwf-address-integration-client/src/main/java/de/muenchen/oss/digiwf/address/integration/client/api) +## Configuration -You can use the following configurations for the DigiWF Address Integration: +### refarch-address-integration-starter -| Property | Description | -|----------------------------------------------|----------------------------| -| `de.muenchen.oss.digiwf.address.service.url` | Url of the address service | - -To use the streaming adapter, you need to set the properties as described in -the [DigiWF Message library](https://github.com/it-at-m/digiwf-core/blob/dev/digiwf-libs/digiwf-message/README.md#configuration). - -## Run the DigiWF Address Integration Service - -To run the service i.e. in Open Shift you can set the environment variables below or run the service locally as -described in the [Getting Started](#getting-started) section. - -### Service Configuration with environment variables - -Set following environment variables to configure the service. Those are abbreviations of the properties above to shorten -the configuration in an environment like docker. - -| Environment variable | Description | -|-----------------------------------|-------------------------------------------------------------------| -| `DIGIWF_ENV` | Environment in which the service runs | -| `ADDRESS_SERVICE_URL` | URL of the address service | -| `ADDRESS_INTEGRATION_SERVER_PORT` | Port number of this address integration service (default is 8080) | -| `KAFKA_SECURITY_PROTOCOL` | Security protocol of kafka (default is PLAINTEXT) | -| `KAFKA_BOOTSTRAP_SERVER` | Kafka server address (default is localhost) | -| `KAFKA_BOOTSTRAP_SERVER_PORT` | Kafka server port (default is 29092) | - -### Getting started - -The following steps are needed to run the integration locally. - -1. Build it with `mvn clean install` -2. Run Stack using `docker-compose` - -### Manual Test inside of München Network - -1. Start the applications in the following order: - 1. EngineServiceApplication - - Activate Spring profile `local,no-ldap,streaming` - - Add Environment values from `stack/local-docker.env` - 2. DigiWFConnectorApplication - - Activate Spring profile `local,streaming` - - Add Environment values from `stack/local-docker.env` - 3. S3IntegrationApplication - - Activate Spring profile `local,no-security` - - Add Environment values from `stack/local-docker.env` - 4. TaskListApplication - - Activate Spring profile `local,no-ldap,streaming` - - Add Environment values from `stack/local-docker.env` - 5. DigiwfEmailIntegrationApplication - - Activate Spring profile `local` - - Add Environment values from `stack/local-docker.env` -2. Test the functionality with the - process [example-email-V02](../../digiwf-engine/digiwf-engine-service/src/main/resources/prozesse/example/address-integration) +| Property | Description | +|-----------------------|----------------------------| +| `refarch.address.url` | URL of the address service |