Package de.svws_nrw.api.dav

Klasse APIKalender

java.lang.Object
de.svws_nrw.api.dav.APIKalender
@Path("/dav/{schema}") public class APIKalender extends Object
Die Klasse spezifiziert die CardDAV-API-Schnittstelle für den Zugriff auf Kalender und Kalendereinträge.

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIKalender()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    deleteOnCalendar(String schema, String kalenderId, jakarta.servlet.http.HttpServletRequest request)
    API-Methode zum Löschen einer Kalender-Ressourcensammlung
    jakarta.ws.rs.core.Response
    deleteOnCalendar(String schema, String kalenderId, String kalenderEintragUID, String ifMatchHeader, jakarta.servlet.http.HttpServletRequest request)
    API-Methode für Löschen von Kalendereinträgen
    jakarta.ws.rs.core.Response
    propfindOnCalendar(String schema, String kalenderId, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften der Ressource Kalender
    jakarta.ws.rs.core.Response
    propfindOnCalendarCollection(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften der Ressource-Collection Kalender
    jakarta.ws.rs.core.Response
    putOnCalendar(String schema, String kalenderId, String kalenderEintragUId, 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
    reportOnCalendar(String schema, String kalenderId, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Informationen der Ressource Kalender

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIKalender

      public APIKalender()
      Leerer Standardkonstruktor.

  • Methodendetails

    • propfindOnCalendarCollection

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

    • propfindOnCalendar

      @Path("/kalender/{resourceCollectionId}") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response propfindOnCalendar(@PathParam("schema") String schema, @PathParam("resourceCollectionId") String kalenderId, @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
      kalenderId - Id des Kalenders, für den die Eigenschaften abfragt werden
      request - Die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Ergebnisobjekt vom Typ Multistatus oder Error

    • reportOnCalendar

      @Path("/kalender/{resourceCollectionId}") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response reportOnCalendar(@PathParam("schema") String schema, @PathParam("resourceCollectionId") String kalenderId, @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
      kalenderId - Id des Kalenders, für den die Informationen abfragt werden
      request - Die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Ergebnisobjekt vom Typ Multistatus oder Error

    • putOnCalendar

      @PUT @Path("/kalender/{resourceCollectionId}/{resourceId}.ics") @Consumes({"Text/Calendar","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response putOnCalendar(@PathParam("schema") String schema, @PathParam("resourceCollectionId") String kalenderId, @PathParam("resourceId") String kalenderEintragUId, @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
      kalenderId - Id des Kalenders, für den die Informationen abfragt werden
      kalenderEintragUId - die UID des Kalendereintrags, auf den geschrieben werden soll
      ifNonMatchHeader - Header mit ETag für PUT einer neuen Ressource
      ifMatchHeader - Header mit ETag für PUT auf vorhandene Ressource
      request - Die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Ergebnisobjekt vom Typ Multistatus oder Error

    • deleteOnCalendar

      @DELETE @Path("/kalender/{resourceCollectionId}/{resourceId}.ics") @Produces("text/xml") public jakarta.ws.rs.core.Response deleteOnCalendar(@PathParam("schema") String schema, @PathParam("resourceCollectionId") String kalenderId, @PathParam("resourceId") String kalenderEintragUID, @HeaderParam("If-Match") String ifMatchHeader, @Context jakarta.servlet.http.HttpServletRequest request)
      API-Methode für Löschen von Kalendereinträgen
      Parameter:
      schema - das Schema der Datenbank
      kalenderId - die ID des Kalenders
      kalenderEintragUID - die UID der zu löschenden Ressource
      ifMatchHeader - der ifMatchHeader, 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

    • deleteOnCalendar

      @DELETE @Path("/kalender/{resourceCollectionId}") @Produces("text/xml") public jakarta.ws.rs.core.Response deleteOnCalendar(@PathParam("schema") String schema, @PathParam("resourceCollectionId") String kalenderId, @Context jakarta.servlet.http.HttpServletRequest request)
      API-Methode zum Löschen einer Kalender-Ressourcensammlung
      Parameter:
      schema - das Schema der Datenbank
      kalenderId - die ID des zu löschenden Kalenders
      request - Informationen zum HTTP-Request
      Gibt zurück:
      den Status 204 NO CONTENT bei erfolgtem Löschen, ansonsten ein Multistatus mit Fehlermeldungen