Package de.svws_nrw.api.server
Klasse APIBenutzer
java.lang.Object
de.svws_nrw.api.server.APIBenutzer
@Path("/db/{schema}/benutzer")
@Produces("application/json")
@Consumes("application/json")
public class APIBenutzer
extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf die
angelegten Benutzer und die den Benutzern
zugeordneten Kompetenezen.
Ein Zugriff erfolgt über den Pfad https://{Hostname}/db/{schema}/benutzer/...
-
Konstruktorübersicht
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibungjakarta.ws.rs.core.Response
addBenutzerAdmin
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für Setzen des Admin-Flags bei einem Benutzer.jakarta.ws.rs.core.Response
addBenutzergruppeAdmin
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für Setzen des Admin-Flags bei einer Benutzergruppen.jakarta.ws.rs.core.Response
addBenutzergruppeBenutzer
(String schema, long id, List<Long> bids, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Hinzufügen von einen oder mehreren Benutzern bei einer Benutzergruppejakarta.ws.rs.core.Response
addBenutzergruppeKompetenzen
(String schema, long id, List<Long> kids, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Hinzufügen von einer oder mehreren Kompetenzen bei einer Benutzergruppejakarta.ws.rs.core.Response
addBenutzerKompetenzen
(String schema, long id, List<Long> kids, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Hinzufügen von einer oder mehreren Kompetenzen bei einem Benutzerjakarta.ws.rs.core.Response
createBenutzerAllgemein
(String schema, BenutzerAllgemeinCredentials cred, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Erstellen eines neuen Benutzers mit seinen Credentials und einem Anzeigenamen.jakarta.ws.rs.core.Response
createBenutzergruppe
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Erstellen eines neuen Benutzers.jakarta.ws.rs.core.Response
getBenutzerDaten
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Daten eines Benutzers.jakarta.ws.rs.core.Response
getBenutzerDatenEigene
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Daten des angemeldeten Benutzers, der die Abfrage ausführt.jakarta.ws.rs.core.Response
getBenutzerEmailDaten
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der EMail-Daten des angemeldeten Benutzers, der die Abfrage ausführt.jakarta.ws.rs.core.Response
getBenutzergruppeDaten
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Daten einer Benutzergruppe.jakarta.ws.rs.core.Response
getBenutzergruppenliste
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Liste aller im System vorhandenen Benutzergruppen.jakarta.ws.rs.core.Response
getBenutzerliste
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Liste aller im System vorhandenen Benutzer.jakarta.ws.rs.core.Response
getBenutzerMitGruppenID
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Benutzer einer Gruppe.jakarta.ws.rs.core.Response
getKatalogBenutzerkompetenzen
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage des Katalogs der Benutzerkompetenzen.jakarta.ws.rs.core.Response
getKatalogBenutzerkompetenzgruppen
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage des Katalogs der Benutzerkompetenzgruppen.jakarta.ws.rs.core.Response
patchBenutzerEmailDaten
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen der EMail-Daten des angemeldeten Benutzers, der die Abfrage ausführt.jakarta.ws.rs.core.Response
removeBenutzerAdmin
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Löschen der Admin-Berechtiung eines Benutzersjakarta.ws.rs.core.Response
removeBenutzerGruppe
(String schema, List<Long> bgids, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Löschen von einer oder mehreren Benutzergruppenjakarta.ws.rs.core.Response
removeBenutzergruppeAdmin
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Löschen der Admin-Berechtiung einer Benutzergruppejakarta.ws.rs.core.Response
removeBenutzergruppeBenutzer
(String schema, long id, List<Long> bids, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Entfernen von einem oder mehreren Benutzern bei einer Benutzergruppejakarta.ws.rs.core.Response
removeBenutzergruppeKompetenzen
(String schema, long id, List<Long> kids, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Entfernen von einer oder mehreren Kompetenzen bei einer Benutzergruppejakarta.ws.rs.core.Response
removeBenutzerKompetenzen
(String schema, long id, List<Long> kids, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Entfernen von einer oder mehreren Kompetenzen bei einem Benutzerjakarta.ws.rs.core.Response
removeBenutzerMenge
(String schema, List<Long> bids, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Löschen von einer oder mehreren Benutzernjakarta.ws.rs.core.Response
setAnzeigename
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für Setzen eines Anzeigenamens.jakarta.ws.rs.core.Response
setBenutzergruppeBezeichnung
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Setzen der Bezeichnung einer Benutzergruppen.jakarta.ws.rs.core.Response
setBenutzername
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für Setzen eines Anmeldenamens.jakarta.ws.rs.core.Response
setPassword
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für Setzen eines neuen Passworts.
-
Konstruktordetails
-
APIBenutzer
public APIBenutzer()Leerer Standardkonstruktor.
-
-
Methodendetails
-
getBenutzerliste
@GET @Path("/") public jakarta.ws.rs.core.Response getBenutzerliste(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Liste aller im System vorhandenen Benutzer.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste mit den Benutzern
-
getBenutzerDatenEigene
@GET @Path("/angemeldet/daten") public jakarta.ws.rs.core.Response getBenutzerDatenEigene(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Daten des angemeldeten Benutzers, der die Abfrage ausführt.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Daten des angemeldeten Benutzers, der diese Abfrage ausführt.
-
getBenutzerDaten
@GET @Path("/{id : \\d+}") public jakarta.ws.rs.core.Response getBenutzerDaten(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Daten eines Benutzers.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollid
- die Datenbank-ID zur Identifikation des Benutzersrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Daten des Benutzers
-
getBenutzergruppenliste
@GET @Path("/gruppe") public jakarta.ws.rs.core.Response getBenutzergruppenliste(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Liste aller im System vorhandenen Benutzergruppen.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste mit den Benutzergruppen
-
getBenutzergruppeDaten
@GET @Path("/gruppe/{id : \\d+}") public jakarta.ws.rs.core.Response getBenutzergruppeDaten(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Daten einer Benutzergruppe.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollid
- die Datenbank-ID zur Identifikation der Benutzergrupperequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Daten der Benutzergruppe
-
getBenutzerMitGruppenID
@GET @Path("/gruppe/{id : \\d+}/benutzer") public jakarta.ws.rs.core.Response getBenutzerMitGruppenID(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Benutzer einer Gruppe.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollid
- die Datenbank-ID zur Identifikation der Benutzergrupperequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Benutzer der Benutzergruppe
-
setAnzeigename
@POST @Path("/{id : \\d+}/anzeigename") public jakarta.ws.rs.core.Response setAnzeigename(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für Setzen eines Anzeigenamens.- Parameter:
schema
- das Datenbankschema, in welchem der Benutzer ist.id
- die ID des Benutzersis
- der Input-Stream mit dem Azeigenamenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
setBenutzername
@POST @Path("/{id : \\d+}/anmeldename") public jakarta.ws.rs.core.Response setBenutzername(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für Setzen eines Anmeldenamens.- Parameter:
schema
- das Datenbankschema, in welchem der Benutzer ist.id
- die ID des Benutzersis
- der Input-Stream mit dem Anmeldenamenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
setPassword
@POST @Path("/{id : \\d+}/password") public jakarta.ws.rs.core.Response setPassword(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für Setzen eines neuen Passworts.- Parameter:
schema
- das Datenbankschema, in welchem der Benutzer ist.id
- die ID des Benutzersis
- der Input-Stream mit dem neuen Passwortrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
addBenutzerAdmin
@POST @Path("/{id : \\d+}/addAdmin") public jakarta.ws.rs.core.Response addBenutzerAdmin(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für Setzen des Admin-Flags bei einem Benutzer.- Parameter:
schema
- das Datenbankschemaid
- die ID des Benutzersrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
removeBenutzerAdmin
@DELETE @Path("/{id : \\d+}/removeAdmin") public jakarta.ws.rs.core.Response removeBenutzerAdmin(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Löschen der Admin-Berechtiung eines Benutzers- Parameter:
schema
- das Datenbankschemaid
- die ID des Benutzersrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
addBenutzerKompetenzen
@POST @Path("/{id : \\d+}/kompetenz/add") public jakarta.ws.rs.core.Response addBenutzerKompetenzen(@PathParam("schema") String schema, @PathParam("id") long id, List<Long> kids, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Hinzufügen von einer oder mehreren Kompetenzen bei einem Benutzer- Parameter:
schema
- das Datenbankschema, in welchem die Blockung erstellt wirdid
- die ID des Benutzerskids
- die IDs der Kompetenzenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
removeBenutzerKompetenzen
@DELETE @Path("/{id : \\d+}/kompetenz/remove") public jakarta.ws.rs.core.Response removeBenutzerKompetenzen(@PathParam("schema") String schema, @PathParam("id") long id, List<Long> kids, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Entfernen von einer oder mehreren Kompetenzen bei einem Benutzer- Parameter:
schema
- das Datenbankschema, in welchem die Blockung erstellt wirdid
- die ID des Benutzerskids
- die IDs der Kompetenzenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
getKatalogBenutzerkompetenzen
@GET @Path("/allgemein/kompetenzen") public jakarta.ws.rs.core.Response getKatalogBenutzerkompetenzen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage des Katalogs der Benutzerkompetenzen.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste der Benutzerkompetenzen
-
getKatalogBenutzerkompetenzgruppen
@GET @Path("/allgemein/kompetenzgruppen") public jakarta.ws.rs.core.Response getKatalogBenutzerkompetenzgruppen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage des Katalogs der Benutzerkompetenzgruppen.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste der Benutzerkompetenzgruppen
-
setBenutzergruppeBezeichnung
@POST @Path("/gruppe/{id : \\d+}/bezeichnung") public jakarta.ws.rs.core.Response setBenutzergruppeBezeichnung(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Setzen der Bezeichnung einer Benutzergruppen.- Parameter:
schema
- das Datenbankschemaid
- die ID der Benutzergruppeis
- der Input-Stream mit der Bezeichnung der Benutzergrupperequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
addBenutzergruppeAdmin
@POST @Path("/gruppe/{id : \\d+}/addAdmin") public jakarta.ws.rs.core.Response addBenutzergruppeAdmin(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für Setzen des Admin-Flags bei einer Benutzergruppen.- Parameter:
schema
- das Datenbankschemaid
- die ID der Benutzergrupperequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
removeBenutzergruppeAdmin
@DELETE @Path("/gruppe/{id : \\d+}/removeAdmin") public jakarta.ws.rs.core.Response removeBenutzergruppeAdmin(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Löschen der Admin-Berechtiung einer Benutzergruppe- Parameter:
schema
- das Datenbankschemaid
- die ID der Benutzergrupperequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
addBenutzergruppeKompetenzen
@POST @Path("/gruppe/{id : \\d+}/kompetenz/add") public jakarta.ws.rs.core.Response addBenutzergruppeKompetenzen(@PathParam("schema") String schema, @PathParam("id") long id, List<Long> kids, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Hinzufügen von einer oder mehreren Kompetenzen bei einer Benutzergruppe- Parameter:
schema
- das Datenbankschemaid
- die ID der Benutzergruppekids
- die IDs der Kompetenzenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
removeBenutzergruppeKompetenzen
@DELETE @Path("/gruppe/{id : \\d+}/kompetenz/remove") public jakarta.ws.rs.core.Response removeBenutzergruppeKompetenzen(@PathParam("schema") String schema, @PathParam("id") long id, List<Long> kids, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Entfernen von einer oder mehreren Kompetenzen bei einer Benutzergruppe- Parameter:
schema
- das Datenbankschemaid
- die ID der Benutzergruppekids
- die IDs der Kompetenzenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
addBenutzergruppeBenutzer
@POST @Path("/gruppe/{id : \\d+}/benutzer/add") public jakarta.ws.rs.core.Response addBenutzergruppeBenutzer(@PathParam("schema") String schema, @PathParam("id") long id, List<Long> bids, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Hinzufügen von einen oder mehreren Benutzern bei einer Benutzergruppe- Parameter:
schema
- das Datenbankschemaid
- die ID der Benutzergruppebids
- die IDs der Benutzerrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
removeBenutzergruppeBenutzer
@DELETE @Path("/gruppe/{id : \\d+}/benutzer/remove") public jakarta.ws.rs.core.Response removeBenutzergruppeBenutzer(@PathParam("schema") String schema, @PathParam("id") long id, List<Long> bids, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Entfernen von einem oder mehreren Benutzern bei einer Benutzergruppe- Parameter:
schema
- das Datenbankschemaid
- die ID der Benutzergruppebids
- die IDs der Benutzerrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
createBenutzerAllgemein
@POST @Path("/new") public jakarta.ws.rs.core.Response createBenutzerAllgemein(@PathParam("schema") String schema, BenutzerAllgemeinCredentials cred, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Erstellen eines neuen Benutzers mit seinen Credentials und einem Anzeigenamen.- Parameter:
schema
- das Datenbankschema, in welchem der Benutzer erstellt wirdcred
- die Benutzer-Credentials mit dem Anzeigenamen des allgemeinen Benutzersrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Daten-Objekt zum neu angelegten Benutzer
-
removeBenutzerMenge
@DELETE @Path("/remove") public jakarta.ws.rs.core.Response removeBenutzerMenge(@PathParam("schema") String schema, List<Long> bids, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Löschen von einer oder mehreren Benutzern- Parameter:
schema
- das Datenbankschemabids
- die IDs der Benutzerrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
createBenutzergruppe
@POST @Path("/benutzergruppe/new") public jakarta.ws.rs.core.Response createBenutzergruppe(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Erstellen eines neuen Benutzers.- Parameter:
schema
- das Datenbankschema, in welchem der Benutzer erstellt wirdis
- JSON-Objekt mit den Datenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit der neuen Blockung
-
removeBenutzerGruppe
@DELETE @Path("/guppe/remove") public jakarta.ws.rs.core.Response removeBenutzerGruppe(@PathParam("schema") String schema, List<Long> bgids, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode zum Löschen von einer oder mehreren Benutzergruppen- Parameter:
schema
- das Datenbankschemabgids
- die IDs der Benutzergruppenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
getBenutzerEmailDaten
@GET @Path("/angemeldet/daten/email") public jakarta.ws.rs.core.Response getBenutzerEmailDaten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der EMail-Daten des angemeldeten Benutzers, der die Abfrage ausführt.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die EMail-Daten des angemeldeten Benutzers, der diese Abfrage ausführt.
-
patchBenutzerEmailDaten
@PATCH @Path("/angemeldet/daten/email") public jakarta.ws.rs.core.Response patchBenutzerEmailDaten(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen der EMail-Daten des angemeldeten Benutzers, der die Abfrage ausführt.- Parameter:
schema
- das Datenbankschema, auf welches der Patch ausgeführt werden sollis
- der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386request
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das Ergebnis der Patch-Operation
-