Package de.svws_nrw.api.client

Klasse APIClient

java.lang.Object
de.svws_nrw.api.client.APIClient
@Path("") public class APIClient extends Object
Die Klasse spezifiziert die Schnittstelle für den Zugriff auf den SVWS-Client.

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIClient()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    getClientFileAssetJSMAPSubdir(String name)
    Gibt eine js.map-Datei aus dem Ordner assets zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileAssetsCSSMAPSubdir(String name)
    Gibt eine css.map-Datei aus dem Ordner assets zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileAssetsICO(String name)
    Gibt eine ico-Datei zurück, welche im Ordner assets in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileAssetsJPG(String name)
    Gibt eine jpg-Datei aus dem Ordner "/assets" zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileAssetsPNG(String name)
    Gibt eine png-Datei aus dem Ordner "/assets" zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileAssetsSubdir(String name)
    Gibt eine js-Datei aus dem Ordner assets zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileAssetsSVG(String name)
    Gibt eine svg-Datei aus dem Ordner "/assets" zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileCSS(String name)
    Gibt eine css-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileCSSAssetsSubdir(String name)
    Gibt eine css-Datei aus dem Ordner assets zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileCSSMAP(String name)
    Gibt eine css.map-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileCSSMAPSubdir(String name)
    Gibt eine css.map-Datei aus dem Ordner css zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileCSSSubdir(String name)
    Gibt eine css-Datei aus dem Ordner css zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileFontsCSS(String name)
    Gibt eine css-Datei aus dem Ordner fonts zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileFontsWoff2(String name)
    Gibt eine woff2-Datei aus dem Ordner fonts zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileICO(String name)
    Gibt eine ico-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileImgIconsPNG(String name)
    Gibt eine png-Datei aus dem Ordner "/img/icons" zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientfileJS(String name)
    Gibt eine js-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileJSMAP(String name)
    Gibt eine js.map-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileJSMAPSubdir(String name)
    Gibt eine js.map-Datei aus dem Ordner js zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileJSSubdir(String name)
    Gibt eine js-Datei aus dem Ordner js zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFilePNG(String name)
    Gibt eine png-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientFileSVG(String name)
    Gibt eine svg-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientHTML(String name)
    Gibt eine html-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
    jakarta.ws.rs.core.Response
    getClientRoot()
    Gibt die "index.html"-Datei für das angegebene Schema zurück.
    jakarta.ws.rs.core.Response
    getJSONKatalog(String name)
    Gib eine JSON-Datei für die Core-Type-Daten zurück.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIClient

      public APIClient()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getClientRoot

      @GET @Produces("text/html") @Path("/") public jakarta.ws.rs.core.Response getClientRoot()
      Gibt die "index.html"-Datei für das angegebene Schema zurück.
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientHTML

      @GET @Produces("text/html") @Path("/{name}.html") public jakarta.ws.rs.core.Response getClientHTML(@PathParam("name") String name)
      Gibt eine html-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".html"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientfileJS

      @GET @Produces("text/javascript") @Path("/{name}.js") public jakarta.ws.rs.core.Response getClientfileJS(@PathParam("name") String name)
      Gibt eine js-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".js"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileJSSubdir

      @GET @Produces("text/javascript") @Path("/js/{name}.js") public jakarta.ws.rs.core.Response getClientFileJSSubdir(@PathParam("name") String name)
      Gibt eine js-Datei aus dem Ordner js zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".js"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileAssetsSubdir

      @GET @Produces("text/javascript") @Path("/assets/{name}.js") public jakarta.ws.rs.core.Response getClientFileAssetsSubdir(@PathParam("name") String name)
      Gibt eine js-Datei aus dem Ordner assets zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".js"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileJSMAP

      @GET @Produces("text/plain") @Path("/{name}.js.map") public jakarta.ws.rs.core.Response getClientFileJSMAP(@PathParam("name") String name)
      Gibt eine js.map-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".js.map"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileJSMAPSubdir

      @GET @Produces("text/plain") @Path("/js/{name}.js.map") public jakarta.ws.rs.core.Response getClientFileJSMAPSubdir(@PathParam("name") String name)
      Gibt eine js.map-Datei aus dem Ordner js zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".js.map"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileAssetJSMAPSubdir

      @GET @Produces("text/plain") @Path("/assets/{name}.js.map") public jakarta.ws.rs.core.Response getClientFileAssetJSMAPSubdir(@PathParam("name") String name)
      Gibt eine js.map-Datei aus dem Ordner assets zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".js.map"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileCSS

      @GET @Produces("text/css") @Path("/{name}.css") public jakarta.ws.rs.core.Response getClientFileCSS(@PathParam("name") String name)
      Gibt eine css-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".css"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileCSSSubdir

      @GET @Produces("text/css") @Path("/css/{name}.css") public jakarta.ws.rs.core.Response getClientFileCSSSubdir(@PathParam("name") String name)
      Gibt eine css-Datei aus dem Ordner css zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".css"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileCSSAssetsSubdir

      @GET @Produces("text/css") @Path("/assets/{name}.css") public jakarta.ws.rs.core.Response getClientFileCSSAssetsSubdir(@PathParam("name") String name)
      Gibt eine css-Datei aus dem Ordner assets zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".css"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileCSSMAP

      @GET @Produces("text/plain") @Path("/{name}.css.map") public jakarta.ws.rs.core.Response getClientFileCSSMAP(@PathParam("name") String name)
      Gibt eine css.map-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".css.map"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileCSSMAPSubdir

      @GET @Produces("text/plain") @Path("/css/{name}.css.map") public jakarta.ws.rs.core.Response getClientFileCSSMAPSubdir(@PathParam("name") String name)
      Gibt eine css.map-Datei aus dem Ordner css zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".css.map"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileAssetsCSSMAPSubdir

      @GET @Produces("text/plain") @Path("/assets/{name}.css.map") public jakarta.ws.rs.core.Response getClientFileAssetsCSSMAPSubdir(@PathParam("name") String name)
      Gibt eine css.map-Datei aus dem Ordner assets zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".css.map"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileFontsCSS

      @GET @Produces("text/css") @Path("/fonts/{name}.css") public jakarta.ws.rs.core.Response getClientFileFontsCSS(@PathParam("name") String name)
      Gibt eine css-Datei aus dem Ordner fonts zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".css"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileFontsWoff2

      @GET @Produces("font/woff2") @Path("/fonts/{name}.woff2") public jakarta.ws.rs.core.Response getClientFileFontsWoff2(@PathParam("name") String name)
      Gibt eine woff2-Datei aus dem Ordner fonts zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".woff2"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileICO

      @GET @Produces("image/x-icon") @Path("/{name}.ico") public jakarta.ws.rs.core.Response getClientFileICO(@PathParam("name") String name)
      Gibt eine ico-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".ico"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileAssetsICO

      @GET @Produces("image/x-icon") @Path("/assets/{name}.ico") public jakarta.ws.rs.core.Response getClientFileAssetsICO(@PathParam("name") String name)
      Gibt eine ico-Datei zurück, welche im Ordner assets in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".ico"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFilePNG

      @GET @Produces("image/png") @Path("/{name}.png") public jakarta.ws.rs.core.Response getClientFilePNG(@PathParam("name") String name)
      Gibt eine png-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".png"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileImgIconsPNG

      @GET @Produces("image/png") @Path("/img/icons/{name}.png") public jakarta.ws.rs.core.Response getClientFileImgIconsPNG(@PathParam("name") String name)
      Gibt eine png-Datei aus dem Ordner "/img/icons" zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".png"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileAssetsPNG

      @GET @Produces("image/png") @Path("/assets/{name}.png") public jakarta.ws.rs.core.Response getClientFileAssetsPNG(@PathParam("name") String name)
      Gibt eine png-Datei aus dem Ordner "/assets" zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".png"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileAssetsJPG

      @GET @Produces("image/jpeg") @Path("/assets/{name}.jpg") public jakarta.ws.rs.core.Response getClientFileAssetsJPG(@PathParam("name") String name)
      Gibt eine jpg-Datei aus dem Ordner "/assets" zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".jpg"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileSVG

      @GET @Produces("image/svg+xml") @Path("/{name}.svg") public jakarta.ws.rs.core.Response getClientFileSVG(@PathParam("name") String name)
      Gibt eine svg-Datei zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".svg"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getClientFileAssetsSVG

      @GET @Produces("image/svg+xml") @Path("/assets/{name}.svg") public jakarta.ws.rs.core.Response getClientFileAssetsSVG(@PathParam("name") String name)
      Gibt eine svg-Datei aus dem Ordner "/assets" zurück, welche in den Ressourcen des SVWS-Clients vorhanden ist.
      Parameter:
      name - der Name der Datei ohne ".svg"
      Gibt zurück:
      die HTTP-Response mit der Datei oder Response.Status.NOT_FOUND, falls die Datei nicht gefunden wurde

    • getJSONKatalog

      @GET @Produces("application/json") @Path("/types/{name}.json") public jakarta.ws.rs.core.Response getJSONKatalog(@PathParam("name") String name)
      Gib eine JSON-Datei für die Core-Type-Daten zurück.
      Parameter:
      name - der name des Core-Types
      Gibt zurück:
      die HTTP-Response mit dem JSON-Katalog des Core-Types