de.svws_nrw.davapi.api.ReportAddressbookDispatcher Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of svws-module-dav-api Show documentation
Show all versions of svws-module-dav-api Show documentation
Diese Bibliothek enthält die Java-Server-Definition der CalDAV und CardDAV-Schnittstelle für die Schulverwaltungssoftware in NRW
The newest version!
package de.svws_nrw.davapi.api;
import de.svws_nrw.core.data.adressbuch.Adressbuch;
import de.svws_nrw.core.data.adressbuch.AdressbuchEintrag;
import de.svws_nrw.davapi.data.CollectionRessourceQueryParameters;
import de.svws_nrw.davapi.data.IAdressbuchRepository;
import de.svws_nrw.davapi.model.dav.Getetag;
import de.svws_nrw.davapi.model.dav.Multistatus;
import de.svws_nrw.davapi.model.dav.Prop;
import de.svws_nrw.davapi.model.dav.Response;
import de.svws_nrw.davapi.model.dav.SyncCollection;
import de.svws_nrw.davapi.model.dav.card.AddressbookMultiget;
import de.svws_nrw.davapi.model.dav.card.CardAddressData;
import de.svws_nrw.davapi.util.XmlUnmarshallingUtil;
import de.svws_nrw.davapi.util.vcard.VCard;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import jakarta.validation.constraints.NotNull;
/**
* Dispatcher-Klasse für die Verarbeitung von Requests auf das DAV-API mittels
* der HTTP-Methode REPORT auf die Ressource Adressbuch.
*/
public class ReportAddressbookDispatcher extends DavDispatcher {
/** Repository-Klasse zur Abfrage von Adressbüchern aus der SVWS-Datenbank */
private final IAdressbuchRepository repository;
/** URI-Parameter für die Erzeugung von URIs des Ergebnisobjekts */
private final DavUriParameter uriParameter;
/**
* Erstellt einen neuen Dispatcher mit den angegebenen Repositorys und
* URI-Parametern
*
* @param adressbuchRepository das Repository für Adressbuecher
* @param uriParameter die URI-Parameter für im Response verwendete URIs
*/
public ReportAddressbookDispatcher(final IAdressbuchRepository adressbuchRepository,
final DavUriParameter uriParameter) {
this.repository = adressbuchRepository;
this.uriParameter = uriParameter;
}
/**
* Verarbeitet einen InputStream mit XMl-Request für die gegebene Ressourcen-ID
* des Adressbuchs
*
* @param inputStream der InputStream mit dem enthaltenen XML-Request
* @param ressourceId die ID des Adressbuchs
* @return die entsprechend des Requests verarbeitete Datenstruktur, welche das
* Antwort-XML repräsentiert.
* @throws IOException bei der Verarbeitung des InputStreams/XML-Unmarshalling
*/
public Object dispatch(final InputStream inputStream, final String ressourceId) throws IOException {
final CollectionRessourceQueryParameters queryParameters = CollectionRessourceQueryParameters.INCLUDE_RESSOURCES_INCLUDE_PAYLOAD;
final Optional adressbuch = this.repository.getAdressbuchById(ressourceId, queryParameters);
if (adressbuch.isEmpty()) {
return this.createResourceNotFoundError("Adressbuch mit der angegebenen Id wurde nicht gefunden!");
}
/*
* Ein REPORT-Request auf die Adressbuch-Resource kann als AddessbookMultiget-
* und SyncCollection-Objekt formuliert werden. Der InputStream kann nur einmal
* gelesen werden. Daher erfolgt die Typ-Ermittlung nach dem try..error-Prinzip.
* Dazu wird zunächst ein Klon des InputStreams erstellt
*/
try (ByteArrayOutputStream inputStreamAsByteArray = new ByteArrayOutputStream()) {
inputStream.transferTo(inputStreamAsByteArray);
try (InputStream inputStreamClone1 = new ByteArrayInputStream(inputStreamAsByteArray.toByteArray())) {
final AddressbookMultiget multiget = XmlUnmarshallingUtil.unmarshal(inputStreamClone1,
AddressbookMultiget.class);
return this.handleAdressbookMultigetRequest(adressbuch.get(), multiget);
} catch (final IOException e) {
try (InputStream inputStreamClone2 = new ByteArrayInputStream(inputStreamAsByteArray.toByteArray())) {
final SyncCollection syncCollection = XmlUnmarshallingUtil.unmarshal(inputStreamClone2,
SyncCollection.class);
return this.handleSyncCollectionRequest(adressbuch.get(), syncCollection);
} catch (final IOException e2) {
throw new UnsupportedOperationException(
"Error beim Unmarshalling des Inputstreams (Weder Multiget noch Sync-Collection bei REPORT Addressbook): " + e2.getMessage(), e2);
}
}
}
// Input muss entweder ein Adressbook-Multiget oder ein Sync-Collection Request
// sein
}
/**
* Ermittelt das Ergebnisobjekt für den Fall, dass ein
* "addressbook-multiget"-Request gestellt wurde.
*
* @param adressbuch Adressbuch, zu dem die Informationen abgerufen werden
* sollen
* @param multiget Parameter des Requests. Diese steuern, welche Informationen
* im Einzelnen zu der Ressource zurückgeliefert werden
* sollen.
* @return Multistatus-Objekt
*/
private Multistatus handleAdressbookMultigetRequest(final Adressbuch adressbuch, final AddressbookMultiget multiget) {
final Multistatus ms = new Multistatus();
final List eintraegeByHrefs = this.getEintraegeByHrefs(adressbuch, multiget.getHref());
uriParameter.setResourceCollectionId(adressbuch.id);
for (final AdressbuchEintrag eintrag : eintraegeByHrefs) {
ms.getResponse().add(this.generateResponseContactLevel(eintrag, multiget.getProp()));
}
return ms;
}
/**
* Ermittelt das Ergebnisobjekt für den Fall, dass ein "sync-collection"-Request
* gestellt wurde.
*
* @param adressbuch Adressbuch, zu dem die Informationen abgerufen werden
* sollen
* @param syncCollection Parameter des Requests. Diese steuern, welche
* Informationen im Einzelnen zu der Ressource
* zurückgeliefert werden sollen.
* @return Multistatus-Objekt
*/
private Multistatus handleSyncCollectionRequest(final Adressbuch adressbuch, final SyncCollection syncCollection) {
final Multistatus ms = new Multistatus();
uriParameter.setResourceCollectionId(adressbuch.id);
for (final AdressbuchEintrag eintrag : this.getEintraegeBySyncToken(adressbuch.id, syncCollection.getSyncToken())) {
ms.getResponse().add(this.generateResponseContactLevel(eintrag, syncCollection.getProp()));
}
ms.setSyncToken(Integer.toString(adressbuch.synctoken));
return ms;
}
/**
* Ermittelt eine Liste von angefragten AdressbuchEintraegen zu einem
* Adressbuch. Welche Eintraege im Einzelnen zurückgegeben werden sollen, wird
* im Request über die Angabe von URIs der Eintrag-Ressourcen gesteuert.
*
* @param adressbuch Adressbuch, aus dem AdressbuchEintraege ermittelt werden
* sollen.
* @param eintragHrefs List von URIs zu den angefragen Eintrag-Ressourcen im
* Adressbuch.
* @return Liste von Eintraegen.
*/
private List getEintraegeByHrefs(final @NotNull Adressbuch adressbuch, final List eintragHrefs) {
uriParameter.setResourceCollectionId(adressbuch.id);
adressbuch.adressbuchEintraege.forEach(this::modifyEintragUri);
return adressbuch.adressbuchEintraege.stream().filter(k -> eintragHrefs.contains(k.uri)).toList();
}
/**
* Ermittelt eine Liste von geänderten Eintraegen zu einem Adressbuch ab einem
* bestimmten "Aufsetzpunkt" (Differenzdaten). Diese Funktion dient der
* Synchronisation von Adressbüchern mit dem aufrufenden Client. Die Methode
* liefert alle Eintraege eines Adressbuchs zurück, die sich nach dem
* angegebenen des Sync-Tokens serverseitig geändert haben oder neu
* hinzugekommen sind.
*
* @param adressbuchId Id des Adressbuchs, aus dem Eintraege ermittelt werden
* sollen.
* @param syncToken Sync-Token bzw. Aufsetzpunkt zur Abfrage von
* Differenzdaten.
* @return Liste von Eintraegen.
*/
private List getEintraegeBySyncToken(final String adressbuchId, final String syncToken) {
// TODO: Filterung über Sync-Token ergänzen
final Optional adressbuchById = this.repository.getAdressbuchById(adressbuchId,
CollectionRessourceQueryParameters.INCLUDE_RESSOURCES_INCLUDE_PAYLOAD);
if (adressbuchById.isEmpty()) {
return Collections.emptyList();
}
return adressbuchById.get().adressbuchEintraege.stream().toList();
}
/**
* Generiert/Ergänzt die URI des DAV-APIs zu einer angegebenen Eintrag-Ressource
*
* @param eintrag Eintrag (ohne URI)
* @return eintrag Eintrag mit URI
*/
private AdressbuchEintrag modifyEintragUri(final AdressbuchEintrag eintrag) {
uriParameter.setResourceId(eintrag.id);
eintrag.uri = (DavUriBuilder.getAddressEntryUri(uriParameter));
return eintrag;
}
/**
* Generiert ein Response-Objekt für einen angegebenen Eintrag.
*
* @param eintrag Eintrag, zu dem Informationen zurückgeliefert werden
* sollen
* @param propRequested Prop aus dem Request. Definiert, welche Informationen
* zur Ressource zurückgeliefert werden sollen.
* @return Response-Objekt zum angegebenen AdressbuchEintrag
*/
private Response generateResponseContactLevel(final AdressbuchEintrag eintrag, final Prop propRequested) {
final DynamicPropUtil dynamicPropUtil = new DynamicPropUtil(propRequested);
uriParameter.setResourceId(eintrag.id);
final Prop prop200 = new Prop();
if (dynamicPropUtil.getIsFieldRequested(CardAddressData.class)) {
final CardAddressData addressData = new CardAddressData();
final VCard vCard = VCard.createVCard(eintrag);
addressData.getContent().add(vCard.serialize());
prop200.setAddressData(addressData);
}
if (dynamicPropUtil.getIsFieldRequested(Getetag.class)) {
final Getetag getetag = new Getetag();
getetag.getContent().add(eintrag.version);
prop200.setGetetag(getetag);
}
final Response response = createResponse(propRequested, prop200);
response.getHref().add(DavUriBuilder.getAddressEntryUri(uriParameter));
return response;
}
}