Package de.svws_nrw.api.server

Klasse APISchema

java.lang.Object
de.svws_nrw.api.server.APISchema
@Path("/db/{schema}/api") @Produces("application/json") @Consumes("application/json") public class APISchema extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf Schemaoperationen ohne Root-Rechte. Ein Zugriff erfolgt über den Pfad https://{Hostname}/db/{schema}/api/update/... oder https://{Hostname}/db/{schema}/api/revision

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APISchema()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    isTainted(String schemaname, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage ob es sich bei dem Datenbankschemas um ein "verdorbenes" Schema handelt.
    jakarta.ws.rs.core.Response
    revision(String schemaname, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Revision des Datenbankschemas.
    jakarta.ws.rs.core.Response
    updateSchema(String schemaname, long revision, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode um ein Datenbankschema auf eine bestimmte Revision upzudaten.
    jakarta.ws.rs.core.Response
    updateSchemaToCurrent(String schemaname, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode um ein Datenbankschema auf die neueste Revision upzudaten.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APISchema

      public APISchema()
      Leerer Standardkonstruktor.

  • Methodendetails

    • updateSchema

      @POST @Path("/update/{revision : \\d+}") public jakarta.ws.rs.core.Response updateSchema(@PathParam("schema") String schemaname, @PathParam("revision") long revision, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode um ein Datenbankschema auf eine bestimmte Revision upzudaten.
      Parameter:
      schemaname - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      revision - die Revision, auf die angehoben werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Logmeldung über den Updatevorgang

    • updateSchemaToCurrent

      @POST @Path("/update") public jakarta.ws.rs.core.Response updateSchemaToCurrent(@PathParam("schema") String schemaname, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode um ein Datenbankschema auf die neueste Revision upzudaten.
      Parameter:
      schemaname - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Logmeldung über den Updatevorgang

    • revision

      @GET @Path("/revision") public jakarta.ws.rs.core.Response revision(@PathParam("schema") String schemaname, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Revision des Datenbankschemas.
      Parameter:
      schemaname - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Revisionsnummer des Datenbankschemas

    • isTainted

      @GET @Path("/isTainted") public jakarta.ws.rs.core.Response isTainted(@PathParam("schema") String schemaname, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage ob es sich bei dem Datenbankschemas um ein "verdorbenes" Schema handelt. Eine Schema wird als "verdorben" bezeichnet, wenn es ggf. fehlerhaft ist, weil es mithilfe einer Entwicklerversion des SVWS-Servers aktualisiert wurde.
      Parameter:
      schemaname - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      true, falls es sich um ein "verdorbenes" Schema handelt und ansonsten false