Package de.svws_nrw.api.dav

Klasse APIAdressbuch

java.lang.Object
de.svws_nrw.api.dav.APIAdressbuch
@Path("/dav/{schema}") public class APIAdressbuch extends Object
Die Klasse spezifiziert die CardDAV-API-Schnittstelle für den Zugriff auf Adressbücher und Kontakte.

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIAdressbuch()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    propfindOnAddressbook(String schema, String adressbuchId, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften der Ressource Adressbuch
    jakarta.ws.rs.core.Response
    propfindOnAddressbooks(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften der Ressource-Colection Adressbuecher
    jakarta.ws.rs.core.Response
    propfindOnPrincipal(String schema, String benutzerId, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften der Ressource Principal (Benutzer)
    jakarta.ws.rs.core.Response
    propfindOnRoot(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Eigenschaften der Root-Ressource.
    jakarta.ws.rs.core.Response
    reportOnAddressbook(String schema, String adressbuchId, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Informationen der Ressource Adressbuch
    jakarta.ws.rs.core.Response
    reportOnContact(String schema, String adressbuchId, String kontaktId, jakarta.servlet.http.HttpServletRequest request)
    Die CardDAV-API Methode zur Abfrage von Informationen der Ressource Kontakt

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIAdressbuch

      public APIAdressbuch()
      Leerer Standardkonstruktor.

  • Methodendetails

    • propfindOnRoot

      @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response propfindOnRoot(@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:
      Ergebnisobjekt vom Typ Multistatus oder Error

    • propfindOnPrincipal

      @Path("/benutzer/{benutzerId}") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response propfindOnPrincipal(@PathParam("schema") String schema, @PathParam("benutzerId") String benutzerId, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Eigenschaften der Ressource Principal (Benutzer)
      Parameter:
      schema - Das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      benutzerId - Id des Principals (Benutzer), für den die Eigenschaften abfragt werden
      request - Die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Ergebnisobjekt vom Typ Multistatus oder Error

    • propfindOnAddressbooks

      @Path("/adressbuecher") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response propfindOnAddressbooks(@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:
      Ergebnisobjekt vom Typ Multistatus oder Error

    • propfindOnAddressbook

      @Path("/adressbuecher/{resourceCollectionId}") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response propfindOnAddressbook(@PathParam("schema") String schema, @PathParam("resourceCollectionId") String adressbuchId, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Eigenschaften der Ressource Adressbuch
      Parameter:
      schema - Das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      adressbuchId - Id des Adressbuchs, für den die Eigenschaften abfragt werden
      request - Die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Ergebnisobjekt vom Typ Multistatus oder Error

    • reportOnAddressbook

      @Path("/adressbuecher/{resourceCollectionId}") @Consumes({"text/xml","application/xml"}) @Produces("text/xml") public jakarta.ws.rs.core.Response reportOnAddressbook(@PathParam("schema") String schema, @PathParam("resourceCollectionId") String adressbuchId, @Context jakarta.servlet.http.HttpServletRequest request)
      Die CardDAV-API Methode zur Abfrage von Informationen der Ressource Adressbuch
      Parameter:
      schema - Das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      adressbuchId - Id des Adressbuchs, für den die Informationen abfragt werden
      request - Die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Ergebnisobjekt vom Typ Multistatus oder Error

    • reportOnContact

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