Package gdv.xport.srv.web
Class DatenpaketController
java.lang.Object
gdv.xport.srv.web.DatenpaketController
Dieser Controller repraesentiert das REST-Interface zur Datenpaket-Klasse.
- Author:
- oliver
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionhandleException
(javax.servlet.http.HttpServletRequest request, Exception ex) Falsche URI wurde als Parameter angegeben - bad request.org.springframework.http.ResponseEntity<Datenpaket>
importDatenpaket
(String format, javax.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, javax.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, javax.servlet.http.HttpServletRequest request) Die Umwandlung eines Datenpakets in das gewuenschte Datenformat wird anhand des Accept-Headers (Content Negotiation) oder anhand des Suffixes durchgefuehrt.importDatenpaketV2
(URI uri) uploadDatenpaket
(org.springframework.web.multipart.MultipartFile file) Laedt die gewuenschte Datei und formattiert die darin enthaltenen Datenpakete.List<org.springframework.ui.Model>
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.
-
Constructor Details
-
DatenpaketController
public DatenpaketController()
-
-
Method Details
-
validate
@GetMapping("/v1/Abweichungen") @ResponseBody public List<org.springframework.ui.Model> validate(@RequestParam("uri") URI uri) Validiert die uebergebene URI.- Parameters:
uri
- z.B. http://www.gdv-online.de/vuvm/musterdatei_bestand/musterdatei_041222.txt- Returns:
- gefundene Abweichungen bzw. Validierungs-Fehler
-
validate
@PostMapping("/v1/Abweichungen") @ResponseBody public List<org.springframework.ui.Model> validate(@RequestParam(required=false) String text, javax.servlet.http.HttpServletRequest request) throws IOException Validiert die eingelesenen Datenpakete und gibt die gefundenen Abweichungen bzw. Verletzungen als Liste zurueck.- Parameters:
text
- alternativ kann der Text auch als Parameter reinkommen- Returns:
- gefundene Abweichungen bzw. Validierungs-Fehler
- Throws:
IOException
- bei Lesefehlern
-
validate
@PostMapping("/v1/Abweichungen/form") public List<org.springframework.ui.Model> validate(@RequestParam org.springframework.util.MultiValueMap map) Validiert das eingegebene Formular und gibt die gefundenen Abweichungen bzw. Verletzungen als Liste zurueck.- Parameters:
map
- Eingabe-Formular mit "text"-Eintrag- Returns:
- gefundene Abweichungen bzw. Validierungs-Fehler
- Since:
- 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.- Parameters:
file
- gewuenschte Datei- Returns:
- gefundene Abweichungen bzw. Validierungs-Fehler
-
importDatenpaket
@GetMapping(path="/v1/Datenpaket*") @ResponseBody public org.springframework.http.ResponseEntity<Datenpaket> importDatenpaket(@RequestParam("uri") URI uri, @RequestParam(required=false) String format, javax.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.- Parameters:
uri
- z.B. http://www.gdv-online.de/vuvm/musterdatei_bestand/musterdatei_041222.txtformat
- statt per Content Negotiation kann auch der format-Parameter belegt werdenrequest
- der HTTP-Request- Returns:
- Datenpaket, das in das angeforderte Format transformiert wird
- Throws:
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 - Throws:
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, javax.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.- Parameters:
format
- statt per Content Negotiation kann auch der format-Parameter belegt werdenrequest
- der HTTP-Request mit Datenpaket im Body- Returns:
- Datenpaket string
- Throws:
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, javax.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.- Parameters:
body
- Eingabe-Formular mit "text"- und "format"-Eintragrequest
- der HTTP-Request- Returns:
- Datenpaket Datenpaket
-
uploadDatenpaket
@PostMapping("/v1/Datenpaket/uploaded") @ResponseBody public Datenpaket uploadDatenpaket(@RequestParam("file") 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.- Parameters:
file
- gewuenschte Datei- Returns:
- erzeugtes Format als Text
- Throws:
IOException
- the io exception
-
handleException
@ResponseStatus(BAD_REQUEST) @ExceptionHandler({java.net.MalformedURLException.class,java.lang.IllegalArgumentException.class}) public ErrorDetail handleException(javax.servlet.http.HttpServletRequest request, Exception ex) Falsche URI wurde als Parameter angegeben - bad request.- Parameters:
request
- Anfrage-Requestex
- Ursache- Returns:
- ErrorDetail
-