Package de.svws_nrw.api

Klasse ResourceFileManager

java.lang.Object
de.svws_nrw.api.ResourceFileManager
public final class ResourceFileManager extends Object
Diese Klasse dient als Cache für Datei-Ressourcen, wie dem SVWS-Client, die über die OpenAPI-Schnisstelle zur Verfügung gestellt werden.

  • Methodendetails

    • client

      public static ResourceFileManager client()
      Gibt die Ressourcen des Web-Clients zurück.
      Gibt zurück:
      die Ressourcen des Web-Clients

    • admin

      public static ResourceFileManager admin()
      Gibt die Ressourcen des Admin-Web-Clients zurück.
      Gibt zurück:
      die Ressourcen des Admin-Web-Clients

    • clearAll

      public void clearAll()
      Entfernt alle registrierten Datei-Ressourcen.

    • handleResponse

      public boolean handleResponse(String path, jakarta.servlet.http.HttpServletResponse response) throws ApiOperationException
      Prüft zunächst, ob eine Datei-Ressource unter dem angegebenen Pfad registriert ist. Ist dies der Fall, so wird das HttpServletResponse-Objekt mit den Daten der Datei-Ressource beschrieben und es wird true zurückgegeben. Tritt beim ein Fehler auf oder ist keine Datei-Ressource unter dem Pfad registriert, so wird false zurückgegeben.
      Parameter:
      path - der Pfad der Datei-Ressource
      response - das HttpServletResponse-Objekt für die Daten der Ressource
      Gibt zurück:
      true, falls die Response gültige Daten beinhaltet, ansonsten false
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getData

      public byte[] getData(String path) throws ApiOperationException
      Prüft zunächst, ob eine Datei-Ressource unter dem angegebenen Pfad registriert ist. Ist die nicht der Fall, so wird null zurückgegeben. Ansonsten werden die Daten der registrierten Datei-Ressource zurückgeben (siehe auch ResourceFile.getData()).
      Parameter:
      path - der Pfad der Datei-Ressource
      Gibt zurück:
      die Daten der Datei-Ressource oder null im Fehlerfall
      Löst aus:
      ApiOperationException - im Fehlerfall