Package de.svws_nrw.api.server

Klasse APIConfig

java.lang.Object
de.svws_nrw.api.server.APIConfig
@Path("") @Produces("text/plain") @Consumes("text/plain") public class APIConfig extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf die Konfiguration des SVWS-Servers. Die Config-API stellt neben einer Schnittstelle zum Prüfen, ob ein SVWS-Server vorhanden ist (alive), weitere Konfigurationsmöglichkteiten zur Verfügung.

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIConfig()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    getConfigCertificate()
    Diese Methode liefert das Zertifikat des Servers
    jakarta.ws.rs.core.Response
    getConfigCertificateBase64()
    Diese Methode liefert das Zertifikat des Servers in Base64-Kodierung
    jakarta.ws.rs.core.Response
    getConfigCertificateFile()
    Diese Methode liefert das Zertifikat des Servers als .cer-Datei
    List<DBSchemaListeEintrag>
    getConfigDBSchemata()
    Die OpenAPI-Methode für die Abfrage der Liste aller konfigurierten DB-Schemata.
    jakarta.ws.rs.core.Response
    getConfigPublicKeyBase64()
    Diese Methode liefert den öffentlichen Schlüssel des Servers in Base64-Kodierung
    jakarta.ws.rs.core.Response
    getSchildMinVersion()
    Die OpenAPI-Methode für die Abfrage der ersten kompatiblen Schild-Version
    jakarta.ws.rs.core.Response
    getServerDBRevision()
    Die OpenAPI-Methode für die Abfrage der Datenbank-Revision, welche der SVWS-Server unterstützt.
    jakarta.ws.rs.core.Response
    getServerModus()
    Die OpenAPI-Methode für die Abfrage des Betriebsmodus des SVWS-Servers.
    jakarta.ws.rs.core.Response
    getServerVersion()
    Die OpenAPI-Methode für die Abfrage der Version des SVWS-Servers.
    jakarta.ws.rs.core.Response
    isAlive()
    Diese Methode kann genutzt werden, um die Verfügbarkeit des SVWS-Server zu testen.
    jakarta.ws.rs.core.Response
    isAlivePrivileged(jakarta.servlet.http.HttpServletRequest request)
    Diese Methode kann genutzt werden, um die Verfügbarkeit des SVWS-Server über die Privileged-API zu testen.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIConfig

      public APIConfig()
      Leerer Standardkonstruktor.

  • Methodendetails

    • isAlive

      @GET @Produces("text/plain") @Path("/status/alive") public jakarta.ws.rs.core.Response isAlive()
      Diese Methode kann genutzt werden, um die Verfügbarkeit des SVWS-Server zu testen.
      Gibt zurück:
      die HTTP-Response

    • isAlivePrivileged

      @GET @Produces("application/json") @Path("/status/alive/privileged") public jakarta.ws.rs.core.Response isAlivePrivileged(@Context jakarta.servlet.http.HttpServletRequest request)
      Diese Methode kann genutzt werden, um die Verfügbarkeit des SVWS-Server über die Privileged-API zu testen.
      Parameter:
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response mit true oder false

    • getServerVersion

      @GET @Produces("application/json") @Path("/status/version") public jakarta.ws.rs.core.Response getServerVersion()
      Die OpenAPI-Methode für die Abfrage der Version des SVWS-Servers.
      Gibt zurück:
      die Version des SVWS-Servers

    • getServerModus

      @GET @Produces("application/json") @Path("/status/mode") public jakarta.ws.rs.core.Response getServerModus()
      Die OpenAPI-Methode für die Abfrage des Betriebsmodus des SVWS-Servers.
      Gibt zurück:
      der Betriebsmodus des SVWS-Servers

    • getSchildMinVersion

      @GET @Produces("application/json") @Path("/status/schild/minversion") public jakarta.ws.rs.core.Response getSchildMinVersion()
      Die OpenAPI-Methode für die Abfrage der ersten kompatiblen Schild-Version
      Gibt zurück:
      die erste kompatible Schild-Version

    • getConfigPublicKeyBase64

      @GET @Produces("text/plain") @Path("/config/publickey_base64") public jakarta.ws.rs.core.Response getConfigPublicKeyBase64()
      Diese Methode liefert den öffentlichen Schlüssel des Servers in Base64-Kodierung
      Gibt zurück:
      der öffentlichen Schlüssel des Servers in Base64-Kodierung

    • getConfigCertificateBase64

      @GET @Produces("application/octet-stream") @Path("/config/certificate_base64") public jakarta.ws.rs.core.Response getConfigCertificateBase64()
      Diese Methode liefert das Zertifikat des Servers in Base64-Kodierung
      Gibt zurück:
      das Zertifikat des Servers in Base64-Kodierung

    • getConfigCertificate

      @GET @Produces("text/plain") @Path("/config/certificate") public jakarta.ws.rs.core.Response getConfigCertificate()
      Diese Methode liefert das Zertifikat des Servers
      Gibt zurück:
      das Zertifikat des Servers

    • getConfigCertificateFile

      @GET @Produces("application/octet-stream") @Path("/config/certificate_file") public jakarta.ws.rs.core.Response getConfigCertificateFile()
      Diese Methode liefert das Zertifikat des Servers als .cer-Datei
      Gibt zurück:
      die HTTP-Response mit der Zertifikats-Datei

    • getConfigDBSchemata

      @GET @Produces("application/json") @Path("/config/db/schemata") public List<DBSchemaListeEintrag> getConfigDBSchemata()
      Die OpenAPI-Methode für die Abfrage der Liste aller konfigurierten DB-Schemata.
      Gibt zurück:
      die Liste mit den einzelnen DB-Schemata

    • getServerDBRevision

      @GET @Produces("application/json") @Path("/status/db/revision") public jakarta.ws.rs.core.Response getServerDBRevision()
      Die OpenAPI-Methode für die Abfrage der Datenbank-Revision, welche der SVWS-Server unterstützt. Diese muss zwischenzeitlich nicht mit den Revisionen der einzelnen DB-Schemata übereinstimmen!
      Gibt zurück:
      die Datenbank-Revision des SVWS-Servers