Package de.svws_nrw.api.server

Klasse APIClientConfig

java.lang.Object
de.svws_nrw.api.server.APIClientConfig
@Path("/db/{schema}/client") @Produces("application/json") @Consumes("application/json") public class APIClientConfig extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf Client-spezifische Informationen. Ein Zugriff erfolgt über den Pfad https://{Hostname}/db/{schema}/client/...

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIClientConfig()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    getClientConfig(String schema, String app, jakarta.servlet.http.HttpServletRequest request)
    Gibt die Konfigurationseinträge der angegebenen Anwendung zurück.
    jakarta.ws.rs.core.Response
    getClientConfigUserKey(String schema, String app, String key, jakarta.servlet.http.HttpServletRequest request)
    Gibt den Konfigurationseintrag der angegebenen Anwendung für den angebenen Schlüsselwert zurück.
    jakarta.ws.rs.core.Response
    setClientConfigGlobalKey(String schema, String app, String key, InputStream data, jakarta.servlet.http.HttpServletRequest request)
    Schreibt den Konfigurationseintrag der angegebenen Anwendung für den angebenen Schlüsselwert in die globale Konfiguration.
    jakarta.ws.rs.core.Response
    setClientConfigUserKey(String schema, String app, String key, InputStream data, jakarta.servlet.http.HttpServletRequest request)
    Schreibt den Konfigurationseintrag der angegebenen Anwendung für den angebenen Schlüsselwert in die benutzerspezifische Konfiguration.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIClientConfig

      public APIClientConfig()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getClientConfig

      @GET @Path("/config/{app}") public jakarta.ws.rs.core.Response getClientConfig(@PathParam("schema") String schema, @PathParam("app") String app, @Context jakarta.servlet.http.HttpServletRequest request)
      Gibt die Konfigurationseinträge der angegebenen Anwendung zurück.
      Parameter:
      schema - das Schema aus der Konfiguration
      app - die Applikation in der Konfiguration
      request - der HTTP-request
      Gibt zurück:
      die Key-Value-Paare der Konfigurationserinträge

    • getClientConfigUserKey

      @GET @Path("/config/{app}/user/{key}") public jakarta.ws.rs.core.Response getClientConfigUserKey(@PathParam("schema") String schema, @PathParam("app") String app, @PathParam("key") String key, @Context jakarta.servlet.http.HttpServletRequest request)
      Gibt den Konfigurationseintrag der angegebenen Anwendung für den angebenen Schlüsselwert zurück. Liest den Schlüsselwert aus der Konfiguration für den Client aus Ist sowohl ein globaler als auch eine benutzerspezifischer Konfigurationseintrag unter den Name vorhanden, so wird der benutzerspezifische Eintrag zurückgegeben. Die benutzerspezifische Konfiguratio kann somit globale Einstellungen 'überschreiben'. Ist kein Wert vorhanden, so wird ein leerer String zurückgegeben.
      Parameter:
      schema - das Schema aus der Konfiguration
      app - die Applikation in der Konfiguration
      key - der Schlüsselwert aus der Konfiguration
      request - Benutzerkonfiguration
      Gibt zurück:
      config

    • setClientConfigUserKey

      @PUT @Path("/config/{app}/user/{key}") public jakarta.ws.rs.core.Response setClientConfigUserKey(@PathParam("schema") String schema, @PathParam("app") String app, @PathParam("key") String key, InputStream data, @Context jakarta.servlet.http.HttpServletRequest request)
      Schreibt den Konfigurationseintrag der angegebenen Anwendung für den angebenen Schlüsselwert in die benutzerspezifische Konfiguration.
      Parameter:
      schema - das Schema aus der Konfiguration
      app - die Applikation in der Konfiguration
      key - der Schlüsselwert aus der Konfiguration
      data - der Wert der für die benutzerspezifische Clientkonfiguration gesetzt werden soll
      request - Benutzerkonfiguration
      Gibt zurück:
      die HTTP-Response

    • setClientConfigGlobalKey

      @PUT @Path("/config/{app}/global/{key}") public jakarta.ws.rs.core.Response setClientConfigGlobalKey(@PathParam("schema") String schema, @PathParam("app") String app, @PathParam("key") String key, InputStream data, @Context jakarta.servlet.http.HttpServletRequest request)
      Schreibt den Konfigurationseintrag der angegebenen Anwendung für den angebenen Schlüsselwert in die globale Konfiguration. Dabei wird geprüft, ob der angemeldete Benutzer administrative Rechte hat.
      Parameter:
      schema - das Schema aus der globalen Konfiguration
      app - die Applikation in der globalen Konfiguration
      key - der Schlüsselwert aus der globalen Konfiguration
      data - der Wert der in die globale Clientkonfiguration geschrieben werden soll
      request - Benutzerkonfiguration
      Gibt zurück:
      die Response