Package de.svws_nrw.api.server

Klasse APIDatabase

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIDatabase()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    exportSQLite(String schemaname, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Export einer SQLite-Datenbank aus dem aktuellen Schema.
    jakarta.ws.rs.core.Response
    importSQLite(String schemaname, DBMultipartBodyDataOnly multipart, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Import einer SQLite-Datenbank in das aktuellen Schema.
    jakarta.ws.rs.core.Response
    migrateMariaDB(String schemaname, DatenbankVerbindungsdaten verbindungsdaten, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Migrieren einer bestehenden MariaDB in ein Schema mit angegebenen Namen.
    jakarta.ws.rs.core.Response
    migrateMariaDBSchulnummer(String schemaname, int schulnummer, DatenbankVerbindungsdaten verbindungsdaten, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Migrieren einer bestehenden MariaDB in das angebenene Schema, wobei nur Daten für die angegebene Schulnummer übertragen werden.
    jakarta.ws.rs.core.Response
    migrateMDB(String schemaname, DBMultipartBodyDataOnly multipart, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Migrieren einer MDB in dieses Schema.
    jakarta.ws.rs.core.Response
    migrateMsSqlServer(String schemaname, DatenbankVerbindungsdaten verbindungsdaten, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Migrieren einer bestehenden SQL-Server-Datenbank in das angegebene Schema.
    jakarta.ws.rs.core.Response
    migrateMsSqlServerSchulnummer(String schemaname, int schulnummer, DatenbankVerbindungsdaten verbindungsdaten, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Migrieren einer bestehenden SQL-Server-Datenbank in ein Schema mit angegebenen Namen, wobei nur Daten für die angegebene Schulnummer übertragen werden.
    jakarta.ws.rs.core.Response
    migrateMySql(String schemaname, DatenbankVerbindungsdaten verbindungsdaten, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Migrieren einer bestehenden MySQL-Datenbank in das angebenene Schema.
    jakarta.ws.rs.core.Response
    migrateMySqlSchulnummer(String schemaname, int schulnummer, DatenbankVerbindungsdaten verbindungsdaten, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Migrieren einer bestehenden MySQL-Datenbank in das angebene Schema, wobei nur Daten für die angegebene Schulnummer übertragen werden.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIDatabase

      public APIDatabase()
      Leerer Standardkonstruktor.

  • Methodendetails

    • exportSQLite

      @GET @Produces("application/vnd.sqlite3") @Path("/export/sqlite") public jakarta.ws.rs.core.Response exportSQLite(@PathParam("schema") String schemaname, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Export einer SQLite-Datenbank aus dem aktuellen Schema. Der Aufruf erfordert administrative Rechte.
      Parameter:
      schemaname - Name des Schemas, welches exportiert werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Die SQLite-Datenbank

    • importSQLite

      @POST @Consumes("multipart/form-data") @Path("/import/sqlite") public jakarta.ws.rs.core.Response importSQLite(@PathParam("schema") String schemaname, DBMultipartBodyDataOnly multipart, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Import einer SQLite-Datenbank in das aktuellen Schema. Der Aufruf erfordert administrative Rechte auf dem Schema. Die existierenden Daten in diesem Schema werden dabei entfernt und durch die Daten der SQLite-Datenbank ersetzt.
      Parameter:
      schemaname - Name des Schemas, auf welches die Abfrage ausgeführt wird und in das importiert werden soll
      multipart - Die SQLite-Datenbank
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • migrateMDB

      @POST @Consumes("multipart/form-data") @Path("/migrate/mdb") public jakarta.ws.rs.core.Response migrateMDB(@PathParam("schema") String schemaname, DBMultipartBodyDataOnly multipart, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Migrieren einer MDB in dieses Schema. Die existierenden Daten in diesem Schema werden dabei entfernt.
      Parameter:
      schemaname - Name des Schemas, auf welches die Abfrage ausgeführt wird und in das hinein migriert werden soll
      multipart - die Daten der MDB und das zugehörige Datenbankkennwort
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • migrateMariaDB

      @POST @Path("/migrate/mariadb") public jakarta.ws.rs.core.Response migrateMariaDB(@PathParam("schema") String schemaname, DatenbankVerbindungsdaten verbindungsdaten, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Migrieren einer bestehenden MariaDB in ein Schema mit angegebenen Namen. Die existierenden Daten in diesem Schema werden dabei entfernt.
      Parameter:
      schemaname - Name des Schemas, auf welches die Abfrage ausgeführt wird und in das hinein migriert werden soll
      verbindungsdaten - Die Verbindungsdaten zur MariaDB
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • migrateMariaDBSchulnummer

      @POST @Path("/migrate/mariadb/{schulnummer:\\d{6}}") public jakarta.ws.rs.core.Response migrateMariaDBSchulnummer(@PathParam("schema") String schemaname, @PathParam("schulnummer") int schulnummer, DatenbankVerbindungsdaten verbindungsdaten, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Migrieren einer bestehenden MariaDB in das angebenene Schema, wobei nur Daten für die angegebene Schulnummer übertragen werden. Die existierenden Daten in diesem Schema werden dabei entfernt.
      Parameter:
      schemaname - Name des Schemas, auf welches die Abfrage ausgeführt wird und in das hinein migriert werden soll
      schulnummer - die Schulnummer, für die die Migration durchgeführt wird.
      verbindungsdaten - Die Verbindungsdaten zur MariaDB
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • migrateMySql

      @POST @Path("/migrate/mysql") public jakarta.ws.rs.core.Response migrateMySql(@PathParam("schema") String schemaname, DatenbankVerbindungsdaten verbindungsdaten, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Migrieren einer bestehenden MySQL-Datenbank in das angebenene Schema. Die existierenden Daten in diesem Schema werden dabei entfernt.
      Parameter:
      schemaname - Name des Schemas, auf welches die Abfrage ausgeführt wird und in das hinein migriert werden soll
      verbindungsdaten - Die Verbindungsdaten zur MySQL-Datenbank
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • migrateMySqlSchulnummer

      @POST @Path("/migrate/mysql/{schulnummer:\\d{6}}") public jakarta.ws.rs.core.Response migrateMySqlSchulnummer(@PathParam("schema") String schemaname, @PathParam("schulnummer") int schulnummer, DatenbankVerbindungsdaten verbindungsdaten, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Migrieren einer bestehenden MySQL-Datenbank in das angebene Schema, wobei nur Daten für die angegebene Schulnummer übertragen werden. Die existierenden Daten in diesem Schema werden dabei entfernt.
      Parameter:
      schemaname - Name des Schemas, auf welches die Abfrage ausgeführt wird und in das hinein migriert werden soll
      schulnummer - die Schulnummer, für die die Migration durchgeführt wird.
      verbindungsdaten - Die Verbindungsdaten zur MySQL-Datenbank
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • migrateMsSqlServer

      @POST @Path("/migrate/mssql") public jakarta.ws.rs.core.Response migrateMsSqlServer(@PathParam("schema") String schemaname, DatenbankVerbindungsdaten verbindungsdaten, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Migrieren einer bestehenden SQL-Server-Datenbank in das angegebene Schema. Die existierenden Daten in diesem Schema werden dabei entfernt.
      Parameter:
      schemaname - Name des Schemas, auf welches die Abfrage ausgeführt wird und in das hinein migriert werden soll
      verbindungsdaten - Die Verbindungsdaten zur SQL-Server-Datenbank
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • migrateMsSqlServerSchulnummer

      @POST @Path("/migrate/mssql/{schulnummer:\\d{6}}") public jakarta.ws.rs.core.Response migrateMsSqlServerSchulnummer(@PathParam("schema") String schemaname, @PathParam("schulnummer") int schulnummer, DatenbankVerbindungsdaten verbindungsdaten, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Migrieren einer bestehenden SQL-Server-Datenbank in ein Schema mit angegebenen Namen, wobei nur Daten für die angegebene Schulnummer übertragen werden. Die existierenden Daten in diesem Schema werden dabei entfernt.
      Parameter:
      schemaname - Name des Schemas, auf welches die Abfrage ausgeführt wird und in das hinein migriert werden soll
      schulnummer - die Schulnummer, für die die Migration durchgeführt wird.
      verbindungsdaten - Die Verbindungsdaten zur SQL-Server-Datenbank
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation