Package de.svws_nrw.api.server

Klasse APIOAuth

java.lang.Object
de.svws_nrw.api.server.APIOAuth
@Path("/db/{schema}/oauth") @Produces("application/json") @Consumes("application/json") public class APIOAuth extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf OAuth2-Client-Secrets aus der SVWS-Datenbank. Ein Zugriff erfolgt über den Pfad https://{Hostname}/db/{schema}/oauth/...

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIOAuth()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    addOAuthClientSecret(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen eines Eintrags zu den OAuth Client Secrets der Schule.
    jakarta.ws.rs.core.Response
    deleteOAuthSecret(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen eines OAuth2-Client-Secrets.
    jakarta.ws.rs.core.Response
    getOAuthClientSecret(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines OAuth2-Client-Secrets der Schule anhand der ID.
    jakarta.ws.rs.core.Response
    getOAuthClientSecrets(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der OAuth2-Client-Secrets der Schule.
    jakarta.ws.rs.core.Response
    patchOAuthSecret(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen der OAuth2-Client-Secrets.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIOAuth

      public APIOAuth()
      Leerer Standardkonstruktor.

  • Methodendetails

    • addOAuthClientSecret

      @POST @Path("/secrets/create") public jakarta.ws.rs.core.Response addOAuthClientSecret(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Hinzufügen eines Eintrags zu den OAuth Client Secrets der Schule.
      Parameter:
      schema - das Datenbankschema
      is - der Input-Stream mit den Daten des Eintrags
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem neuen Eintrag

    • patchOAuthSecret

      @PATCH @Path("/secrets/{id : \\d+}") public jakarta.ws.rs.core.Response patchOAuthSecret(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen der OAuth2-Client-Secrets.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation der OAuth2-Client-Secrets
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • deleteOAuthSecret

      @DELETE @Path("/secrets/{id : \\d+}") public jakarta.ws.rs.core.Response deleteOAuthSecret(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen eines OAuth2-Client-Secrets.
      Parameter:
      schema - das Datenbankschema
      id - die ID des OAuth2-Client-Secrets
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem Status und ggf. OAuth2-Client-Secrets

    • getOAuthClientSecrets

      @GET @Path("/secrets") public jakarta.ws.rs.core.Response getOAuthClientSecrets(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der OAuth2-Client-Secrets der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit den Einträgen der OAuth2ClientSecret

    • getOAuthClientSecret

      @GET @Path("/secrets/{id : \\d+}") public jakarta.ws.rs.core.Response getOAuthClientSecret(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage eines OAuth2-Client-Secrets der Schule anhand der ID.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des OAuth2-Client-Secrets
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das OAuth2-Client-Secrets