Package de.svws_nrw.api.dav

Klasse APIDav

java.lang.Object
de.svws_nrw.api.dav.APIDav
@Path("/dav/{schema}") public class APIDav extends Object
Die Klasse spezifiziert die DAV-API-Schnittstelle des SVWS-Servers. Diese enthält die CardDAV-Endpunkte (Adressbücher) und die CalDAV-Endpunkte (Kalender und Kalendereinträge).

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIDav()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    caldavDeleteCalendar(String schema, String idCal, jakarta.servlet.http.HttpServletRequest request)
    API-Methode zum Löschen einer Kalender-Ressourcensammlung
    jakarta.ws.rs.core.Response
    caldavDeleteCalendarEntry(String schema, String idCal, String idEntry, String ifMatchHeader, jakarta.servlet.http.HttpServletRequest request)
    API-Methode für Löschen von Kalendereinträgen
    jakarta.ws.rs.core.Response
    caldavPropfindAllCalendars(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften zu der Kalendersammlung des Benutzers, der die Anfrage stellt.
    jakarta.ws.rs.core.Response
    caldavPropfindCalendar(String schema, String idCal, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften der Ressource Kalender
    jakarta.ws.rs.core.Response
    caldavPutCalendarEntry(String schema, String idCal, String idEntry, String ifNonMatchHeader, String ifMatchHeader, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Anlage eines neuen Kalendereintrags oder zur Änderung eines bestehenden Kalendereintrags
    jakarta.ws.rs.core.Response
    caldavReportCalendar(String schema, String idCal, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Informationen der Ressource Kalender
    jakarta.ws.rs.core.Response
    carddavPropfindAddressbook(String schema, String idBook, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften eines Adressbuches
    jakarta.ws.rs.core.Response
    carddavPropfindAllAddressbooks(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften der Ressource-Colection Adressbuecher
    jakarta.ws.rs.core.Response
    carddavReportAddressbook(String schema, String idBook, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Informationen eines Adressbuches
    jakarta.ws.rs.core.Response
    carddavReportContact(String schema, String idBook, String idEntry, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Informationen der Ressource Kontakt
    jakarta.ws.rs.core.Response
    davPrincipal(String schema, String idUser, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften eines Benutzer-Principals
    jakarta.ws.rs.core.Response
    davRoot(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften der Root-Ressource.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIDav

      public APIDav()
      Leerer Standardkonstruktor.

  • Methodendetails

    • davRoot

      @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response davRoot(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Eigenschaften der Root-Ressource.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response mit einem Ergebnis vom Typ Multistatus oder Error

    • davPrincipal

      @Path("/benutzer/{idUser}") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response davPrincipal(@PathParam("schema") String schema, @PathParam("idUser") String idUser, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Eigenschaften eines Benutzer-Principals
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idUser - die ID des Benutzer-Principals
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response mit einem Ergebnis vom Typ Multistatus oder Error

    • caldavPropfindAllCalendars

      @Path("/kalender") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response caldavPropfindAllCalendars(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Eigenschaften zu der Kalendersammlung des Benutzers, der die Anfrage stellt.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response mit einem Ergebnis vom Typ Multistatus oder Error

    • caldavPropfindCalendar

      @Path("/kalender/{idCal}") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response caldavPropfindCalendar(@PathParam("schema") String schema, @PathParam("idCal") String idCal, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Eigenschaften der Ressource Kalender
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idCal - die ID des Kalenders, für den die Eigenschaften abfragt werden
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response mit einem Ergebnis vom Typ Multistatus oder Error

    • caldavReportCalendar

      @Path("/kalender/{idCal}") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response caldavReportCalendar(@PathParam("schema") String schema, @PathParam("idCal") String idCal, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Informationen der Ressource Kalender
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idCal - die ID des Kalenders, für den die Informationen abfragt werden
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response mit einem Ergebnis vom Typ Multistatus oder Error

    • caldavPutCalendarEntry

      @PUT @Path("/kalender/{idCal}/{idEntry}.ics") @Consumes({"Text/Calendar","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response caldavPutCalendarEntry(@PathParam("schema") String schema, @PathParam("idCal") String idCal, @PathParam("idEntry") String idEntry, @HeaderParam("If-None-Match") String ifNonMatchHeader, @HeaderParam("If-Match") String ifMatchHeader, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Anlage eines neuen Kalendereintrags oder zur Änderung eines bestehenden Kalendereintrags
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idCal - die ID des Kalenders
      idEntry - die UID des Kalendereintrags, auf den geschrieben werden soll
      ifNonMatchHeader - der Header mit dem ETag für PUT einer neuen Ressource
      ifMatchHeader - der Header mit dem ETag für PUT auf vorhandene Ressource
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response mit einem Ergebnis vom Typ Multistatus oder Error

    • caldavDeleteCalendarEntry

      @DELETE @Path("/kalender/{idCal}/{idEntry}.ics") @Produces("text/xml") public jakarta.ws.rs.core.Response caldavDeleteCalendarEntry(@PathParam("schema") String schema, @PathParam("idCal") String idCal, @PathParam("idEntry") String idEntry, @HeaderParam("If-Match") String ifMatchHeader, @Context jakarta.servlet.http.HttpServletRequest request)
      API-Methode für Löschen von Kalendereinträgen
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idCal - die ID des Kalenders
      idEntry - die UID der zu löschenden Ressource
      ifMatchHeader - der Header, welcher die dem CLient bekannte Version angibt
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      den Status 204 NO CONTENT bei erfolgreichem Löschen, ansonsten ein Multistatus mit Fehlermeldung

    • caldavDeleteCalendar

      @DELETE @Path("/kalender/{idCal}") @Produces("text/xml") public jakarta.ws.rs.core.Response caldavDeleteCalendar(@PathParam("schema") String schema, @PathParam("idCal") String idCal, @Context jakarta.servlet.http.HttpServletRequest request)
      API-Methode zum Löschen einer Kalender-Ressourcensammlung
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idCal - die ID des zu löschenden Kalenders
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      den Status 204 NO CONTENT bei erfolgtem Löschen, ansonsten ein Multistatus mit Fehlermeldungen

    • carddavPropfindAllAddressbooks

      @Path("/adressbuecher") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response carddavPropfindAllAddressbooks(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Eigenschaften der Ressource-Colection Adressbuecher
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response mit einem Ergebnis vom Typ Multistatus oder Error

    • carddavPropfindAddressbook

      @Path("/adressbuecher/{idBook}") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response carddavPropfindAddressbook(@PathParam("schema") String schema, @PathParam("idBook") String idBook, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Eigenschaften eines Adressbuches
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idBook - die ID des Adressbuches, für welches die Eigenschaften abfragt werden
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response mit einem Ergebnis vom Typ Multistatus oder Error

    • carddavReportAddressbook

      @Path("/adressbuecher/{idBook}") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response carddavReportAddressbook(@PathParam("schema") String schema, @PathParam("idBook") String idBook, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Informationen eines Adressbuches
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idBook - die ID des Adressbuches, für welches die Informationen abfragt werden
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response mit einem Ergebnis vom Typ Multistatus oder Error

    • carddavReportContact

      @Path("/adressbuecher/{idBook}/{idEntry}.vcf") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response carddavReportContact(@PathParam("schema") String schema, @PathParam("idBook") String idBook, @PathParam("idEntry") String idEntry, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Informationen der Ressource Kontakt
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idBook - die ID des Adressbuches
      idEntry - die ID des Kontaktes, wessen Informationen angefragt werden sollen
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response mit einem Ergebnis vom Typ Multistatus oder Error