Package de.svws_nrw.api.privileged

Klasse APIPrivilegedConfig

java.lang.Object
de.svws_nrw.api.privileged.APIPrivilegedConfig
@Path("/api/privileged") @Produces("application/json") @Consumes("application/json") public class APIPrivilegedConfig extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für priviligierte Datenbankbenutzer in Bezug auf den Zugriff auf die SVWS-Konfiguration des Servers Ein Zugriff erfolgt über den Pfad https://{Hostname}/api/privileged/...

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIPrivilegedConfig()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    isPrivilegedUser(jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage ob der angemeldete Datenbankuser ein priviligierter Datenbank-Benutzer mit Rechten zur Anpassung der SVWS-Konfiguration ist.
    jakarta.ws.rs.core.Response
    removeSchemaFromConfig(String schemaname, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen eines Schemas aus der SVWS-Konfiguration.
    jakarta.ws.rs.core.Response
    setConfigPrivateKeyCertificateBase64(String alias, PrivateKeyCertificateMultipartBody multipart, jakarta.servlet.http.HttpServletRequest request)
    Importiert den Private-Key und das Zertifikat im Base 64-Formate für die TLS-Konfiguration des SVWS-Server.
    jakarta.ws.rs.core.Response
    setDefaultSchemaInConfig(String schemaname, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Setzen des Default-Schemas in der SVWS-Konfiguration.
    jakarta.ws.rs.core.Response
    unsetDefaultSchemaInConfig(jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Zurücksetzen des Default-Schemas in der SVWS-Konfiguration.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIPrivilegedConfig

      public APIPrivilegedConfig()
      Leerer Standardkonstruktor.

  • Methodendetails

    • isPrivilegedUser

      @GET @Path("/user/isprivileged") public jakarta.ws.rs.core.Response isPrivilegedUser(@Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage ob der angemeldete Datenbankuser ein priviligierter Datenbank-Benutzer mit Rechten zur Anpassung der SVWS-Konfiguration ist.
      Parameter:
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Rückmeldung, ob der angegebene User existiert

    • setDefaultSchemaInConfig

      @POST @Path("/config/default/schema/{schema}") public jakarta.ws.rs.core.Response setDefaultSchemaInConfig(@PathParam("schema") String schemaname, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Setzen des Default-Schemas in der SVWS-Konfiguration. Der angemeldete Datenbankbenutzer muss dafür priviligierte Rechte für die Bearbeitung der SVWS-Konfiguration haben.
      Parameter:
      schemaname - der Name des Schemas, das als Default-Schema gesetzt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Rückmeldung, ob die Operation erfolgreich war

    • unsetDefaultSchemaInConfig

      @POST @Path("/config/default/schema/") public jakarta.ws.rs.core.Response unsetDefaultSchemaInConfig(@Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Zurücksetzen des Default-Schemas in der SVWS-Konfiguration. Der angemeldete Datenbankbenutzer muss dafür priviligierte Rechte für die Bearbeitung der SVWS-Konfiguration haben.
      Parameter:
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Rückmeldung, ob die Operation erfolgreich war

    • removeSchemaFromConfig

      @POST @Path("/config/schema/{schema}/remove") public jakarta.ws.rs.core.Response removeSchemaFromConfig(@PathParam("schema") String schemaname, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen eines Schemas aus der SVWS-Konfiguration. Der angemeldete Datenbankbenutzer muss dafür priviligierte Rechte für die Bearbeitung der SVWS-Konfiguration haben.
      Parameter:
      schemaname - der Name des Schemas, das aus der Konfiguration entfernt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Rückmeldung, ob die Operation erfolgreich war

    • setConfigPrivateKeyCertificateBase64

      @POST @Consumes("multipart/form-data") @Path("/config/privatekey_cert_base64/{alias}") public jakarta.ws.rs.core.Response setConfigPrivateKeyCertificateBase64(@PathParam("alias") String alias, PrivateKeyCertificateMultipartBody multipart, @Context jakarta.servlet.http.HttpServletRequest request)
      Importiert den Private-Key und das Zertifikat im Base 64-Formate für die TLS-Konfiguration des SVWS-Server.
      Parameter:
      alias - der Keystore-Alias unter welcher der Schlüssel und das Zertifikat abgelegt werden
      multipart - der private Schlüssel und das vom privaten Schlüssel erstellte Zertifikat
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Rückmeldung, ob die Operation erfolgreich war