Klasse DatenpaketController

java.lang.Object
gdv.xport.srv.web.DatenpaketController

@RestController @RequestMapping("/api") public final class DatenpaketController extends Object
Dieser Controller repraesentiert das REST-Interface zur Datenpaket-Klasse.
Autor:
oliver
  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
     
  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    handleException(jakarta.servlet.http.HttpServletRequest request, Exception ex)
    Falsche URI wurde als Parameter angegeben - bad request.
    org.springframework.http.ResponseEntity<Datenpaket>
    importDatenpaket(String format, jakarta.servlet.http.HttpServletRequest request)
    Die Umwandlung eines Datenpakets in das gewuenschte Datenformat wird anhand des Accept-Headers (Content Negotiation) oder anhand des Suffixes durchgefuehrt.
    org.springframework.http.ResponseEntity<Datenpaket>
    importDatenpaket(URI uri, String format, jakarta.servlet.http.HttpServletRequest request)
    Formattiert das Datenpaket, das von der uebergebenen URI abgeholt wird, in das gewuenscht Format wie HTML, XML, JSON oder CSV.
    org.springframework.http.ResponseEntity<Datenpaket>
    importDatenpaketForm(org.springframework.util.MultiValueMap body, jakarta.servlet.http.HttpServletRequest request)
    Die Umwandlung eines Datenpakets in das gewuenschte Datenformat wird anhand des Accept-Headers (Content Negotiation) oder anhand des Suffixes durchgefuehrt.
    org.springframework.http.ResponseEntity<Datenpaket>
    importDatenpaketV2(jakarta.servlet.http.HttpServletRequest request)
     
     
    uploadDatenpaket(org.springframework.web.multipart.MultipartFile file)
    Laedt die gewuenschte Datei und formattiert die darin enthaltenen Datenpakete.
    List<org.springframework.ui.Model>
    validate(String text, jakarta.servlet.http.HttpServletRequest request)
    Validiert die eingelesenen Datenpakete und gibt die gefundenen Abweichungen bzw.
    List<org.springframework.ui.Model>
    Validiert die uebergebene URI.
    List<org.springframework.ui.Model>
    validate(org.springframework.util.MultiValueMap map)
    Validiert das eingegebene Formular und gibt die gefundenen Abweichungen bzw.
    List<org.springframework.ui.Model>
    validate(org.springframework.web.multipart.MultipartFile file)
    Laedt die gewuenschte Datei und validiert die darin enthaltenen Datenpakete.

    Von Klasse geerbte Methoden java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Konstruktordetails

    • DatenpaketController

      public DatenpaketController()
  • Methodendetails

    • validate

      @GetMapping("/v1/Abweichungen") @ResponseBody public List<org.springframework.ui.Model> validate(@RequestParam("uri") URI uri)
      Validiert die uebergebene URI.
      Parameter:
      uri - z.B. http://www.gdv-online.de/vuvm/musterdatei_bestand/musterdatei_041222.txt
      Gibt zurück:
      gefundene Abweichungen bzw. Validierungs-Fehler
    • validate

      @PostMapping("/v1/Abweichungen") @ResponseBody public List<org.springframework.ui.Model> validate(@RequestParam(value="text",required=false) String text, jakarta.servlet.http.HttpServletRequest request) throws IOException
      Validiert die eingelesenen Datenpakete und gibt die gefundenen Abweichungen bzw. Verletzungen als Liste zurueck.
      Parameter:
      text - alternativ kann der Text auch als Parameter reinkommen
      Gibt zurück:
      gefundene Abweichungen bzw. Validierungs-Fehler
      Löst aus:
      IOException - bei Lesefehlern
    • validate

      @PostMapping("/v1/Abweichungen/form") public List<org.springframework.ui.Model> validate(@RequestParam("map") org.springframework.util.MultiValueMap map)
      Validiert das eingegebene Formular und gibt die gefundenen Abweichungen bzw. Verletzungen als Liste zurueck.
      Parameter:
      map - Eingabe-Formular mit "text"-Eintrag
      Gibt zurück:
      gefundene Abweichungen bzw. Validierungs-Fehler
      Seit:
      6.5 (30.01.23)
    • validate

      @PostMapping("/v1/Abweichungen/uploaded") @ResponseBody public List<org.springframework.ui.Model> validate(@RequestParam("file") org.springframework.web.multipart.MultipartFile file)
      Laedt die gewuenschte Datei und validiert die darin enthaltenen Datenpakete. Da hierueber der Inhalt der Datei mit uebertragen wird, wird dieser Service ueber POST angesprochen.
      Parameter:
      file - gewuenschte Datei
      Gibt zurück:
      gefundene Abweichungen bzw. Validierungs-Fehler
    • importDatenpaket

      @GetMapping(path="/v1/Datenpaket*") @ResponseBody public org.springframework.http.ResponseEntity<Datenpaket> importDatenpaket(@RequestParam("uri") URI uri, @RequestParam(value="format",required=false) String format, jakarta.servlet.http.HttpServletRequest request) throws IOException
      Formattiert das Datenpaket, das von der uebergebenen URI abgeholt wird, in das gewuenscht Format wie HTML, XML, JSON oder CSV. Das Format der gewuenschten Rueckgabe wird dabei ueber Content Negotiation bestimmt, d.h. anhand des Accept-Headers, der Endung oder des format-Parameters.
      Parameter:
      uri - z.B. http://www.gdv-online.de/vuvm/musterdatei_bestand/musterdatei_041222.txt
      format - statt per Content Negotiation kann auch der format-Parameter belegt werden
      request - der HTTP-Request
      Gibt zurück:
      Datenpaket, das in das angeforderte Format transformiert wird
      Löst aus:
      IOException - the io exception
    • importDatenpaketV2

      @GetMapping(path="/v2/Datenpaket*", produces={"text/html","text/xml","application/xml","application/json","text/comma-separated-values","text/plain"}) @ResponseBody public Datenpaket importDatenpaketV2(@RequestParam("uri") URI uri) throws IOException
      Löst aus:
      IOException
    • importDatenpaketV2

      @PostMapping(path="/v2/Datenpaket*", produces={"text/html","text/xml","application/xml","application/json","text/plain","text/comma-separated-values"}) @ResponseBody public org.springframework.http.ResponseEntity<Datenpaket> importDatenpaketV2(jakarta.servlet.http.HttpServletRequest request) throws IOException
      Löst aus:
      IOException
    • importDatenpaket

      @PostMapping(path="/v1/Datenpaket*", produces={"text/html","text/xml","application/xml","application/json","text/plain","text/comma-separated-values"}) @ResponseBody public org.springframework.http.ResponseEntity<Datenpaket> importDatenpaket(@RequestParam(required=false) String format, jakarta.servlet.http.HttpServletRequest request) throws IOException
      Die Umwandlung eines Datenpakets in das gewuenschte Datenformat wird anhand des Accept-Headers (Content Negotiation) oder anhand des Suffixes durchgefuehrt. Das Datenpaket kommt dabei als Text im GDV-Format rein.
      Parameter:
      format - statt per Content Negotiation kann auch der format-Parameter belegt werden
      request - der HTTP-Request mit Datenpaket im Body
      Gibt zurück:
      Datenpaket string
      Löst aus:
      IOException
    • importDatenpaketForm

      @PostMapping(path="/v1/Datenpaket/form", produces={"text/html","text/xml","application/xml","application/json","text/plain","text/comma-separated-values"}) @ResponseBody public org.springframework.http.ResponseEntity<Datenpaket> importDatenpaketForm(@RequestParam org.springframework.util.MultiValueMap body, jakarta.servlet.http.HttpServletRequest request)
      Die Umwandlung eines Datenpakets in das gewuenschte Datenformat wird anhand des Accept-Headers (Content Negotiation) oder anhand des Suffixes durchgefuehrt. Das Datenpaket kommt dabei als Text im GDV-Format rein.
      Parameter:
      body - Eingabe-Formular mit "text"- und "format"-Eintrag
      request - der HTTP-Request
      Gibt zurück:
      Datenpaket Datenpaket
    • uploadDatenpaket

      @PostMapping("/v1/Datenpaket/uploaded") @ResponseBody public Datenpaket uploadDatenpaket(@RequestParam org.springframework.web.multipart.MultipartFile file) throws IOException
      Laedt die gewuenschte Datei und formattiert die darin enthaltenen Datenpakete. Da hierueber der Inhalt der Datei mit uebertragen wird, wird dieser Service ueber POST angesprochen.
      Parameter:
      file - gewuenschte Datei
      Gibt zurück:
      erzeugtes Format als Text
      Löst aus:
      IOException - the io exception
    • handleException

      @ResponseStatus(BAD_REQUEST) @ExceptionHandler({MalformedURLException.class,IllegalArgumentException.class}) public ErrorDetail handleException(jakarta.servlet.http.HttpServletRequest request, Exception ex)
      Falsche URI wurde als Parameter angegeben - bad request.
      Parameter:
      request - Anfrage-Request
      ex - Ursache
      Gibt zurück:
      ErrorDetail