GIPOD

Inleiding

Connectie met GIPOD (Generiek Informatieplatform Openbaar Domein) is nodig om een inname van de publieke ruimte aan te vragen.

Use cases

• Nagaan of een geplande inname van de publieke ruimte conflicteert met een reeds bestaande inname (bv. een ander evenement of werken op dezelfde locatie en periode).

• Een inname van de publieke ruimte registreren bij GIPOD naar aanleiding van een evenement, en deze na registratie bevestigen zodat ze definitief wordt.

• Een eerder geregistreerde inname terug intrekken, bijvoorbeeld wanneer een evenement niet doorgaat.

Setup

Onboarding

GIPOD is een generieke registratiedienst voor het beheer van innames van het openbaar domein, aangeboden door Athumi (Digitaal Vlaanderen). De authenticatie verloopt via het gedeelde OAuth2/JWT-client-assertion-mechanisme van Digitaal Vlaanderen ("GeoSecure").

1. Vraag een aansluiting aan bij Athumi via gipod@athumi.eu.

2. Registreer een OAuth-client via het zelfbedieningsportaal ('Beheerportaal') van Digitaal Vlaanderen. Er zijn twee gescheiden omgevingen:

   • Beheerportaal T&I: gekoppeld aan de GIPOD-beta-omgeving.

   • Beheerportaal: gekoppeld aan de GIPOD-productieomgeving.

3. Laad in het Beheerportaal een gevalideerde public key op (een JWK-certificaat), gekoppeld aan je OAuth-client.

4. Koppel en valideer eerst de connectie met de test-/beta-omgeving, en herhaal dit daarna voor productie.

Deze stappen zijn in grote lijnen dezelfde als voor aansluiting met MAGDA, en identiek qua onderliggend mechanisme aan de Fluvius-connector.

Maven dependency in pom.xml

Voeg onderstaande maven dependency toe in je pom.xml. Dit zorgt ervoor dat de connector code binnengehaald en meegenomen wordt in de build van je applicatie.

<dependency>
   <groupId>com.skryv.connectors</groupId>
   <artifactId>gipod</artifactId>
   <version>${skryv.version}</version>
</dependency>

Applicatie eigenschappen

GIPOD-specifieke applicatie eigenschappen.

Formulierdefinitie

De interface verloopt via een formulier dat je opzet binnen de context van het dossier. Hierin verzamel je de nodige inputdata.

Services en functies

Overzicht

@RequiredArgsConstructor
public class MyOwnService {
    private final GipodCamundaConnector gipodService;
}

getPublicOccupancies

Controleert bij GIPOD of er al een inname van het openbaar domein bestaat die conflicteert met de opgegeven periode en het opgegeven gebied. Zie service taak template 'Register public domain occupation'.

Workflow expression

${gipodService.getPublicOccupancies(execution.processBusinessKey, "formKey", "identiteit.kaart", "identiteit.startdatum", "identiteit.einddatum")}

Java-code

boolean heeftConflict = gipodService.getPublicOccupancies(dossierId, formName, mapPath, startDatePath, endDatePath);

Input

Output

Retourneert een boolean: true als er een conflict gevonden werd, false indien niet. In het scenario dat je de service aanspreekt vanuit de workflow, komt deze boolean als resultaatvariabele van de service taak in het proces terecht.

Error-handling

Deze functie valideert de periode vóór de aanroep naar GIPOD:

Deze exceptie wordt niet omgezet naar een BpmnError. Het veroorzaakt een Camunda-incident, maar wel met een herkenbaar bericht.

registerEvent

Registreert bij GIPOD een inname van het openbaar domein op basis van de opgegeven informatie. Zie service taak template 'Registreer evenement'.

Workflow expression

${gipodService.registerEvent(execution.processBusinessKey, "formKey", "emailPad", "beschrijvingPad", "kaartPad", "startdatumPad", "einddatumPad")}

Java-code

String gipodEventId = gipodService.registerEvent(dossierId, formName, emailPath, descriptionPath, mapPath, startDatePath, endDatePath);

Input

De functie vult zelf een aantal vaste waarden aan die niet instelbaar zijn via de workflow: het type inname staat altijd op ‘Event/andere’, en de contactrol van de opgegeven contactpersoon staat vast. De organisatie namens wie geregistreerd wordt, wordt automatisch bepaald op basis van je GeoSecure-authenticatie. Dit moet je dus niet zelf meegeven.

Output

Retourneert de GIPOD-event-id (String), die je nodig hebt om de inname later te bevestigen (confirmEvent) of te verwijderen (deleteEvent). In het geval je de functie aanspreekt vanuit de workflow, komt het gipodEventId als resultaatvariabele van de service taak in je proces terecht.

Error-handling

Deze functie heeft, in tegenstelling tot getPublicOccupancies, geen eigen foutafhandeling. Elke fout (bv. een ongeldige polygon, een GIPOD-foutrespons) resulteert in een niet-opgevangen, technische exceptie en dus een Camunda-incident zonder specifiek herkenbaar foutbericht.

confirmEvent

Bevestigt een eerder geregistreerd evenement bij GIPOD op basis van de GIPOD-event-id. De inname is hierna definitief. Zie service taak template 'Bevestig evenement'.

Workflow expression

${gipodService.confirmEvent(gipodEventId)}

Java-code

gipodService.confirmEvent(gipodEventId);

Input

Output

Geen output (void).

Error-handling

Geen eigen foutafhandeling. Een niet-opgevangen technische exceptie resulteert in een Camunda-incident.

deleteEvent

Verwijdert een eerder geregistreerd evenement bij GIPOD op basis van de GIPOD-event-id. Zie service taak template 'Verwijder evenement'.

Workflow expression

${gipodService.deleteEvent(gipodEventId)}

Java-code

gipodService.deleteEvent(gipodEventId);

Input

Output

Geen output (void).

Error-handling

Geen eigen foutafhandeling. Een niet-opgevangen technische exceptie resulteert in een Camunda-incident.