Package org.exoplatform.caldav.service

Interface CaldavConnectorService

public interface CaldavConnectorService

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    createCaldavSetting(CaldavUserSetting caldavUserSetting, long userIdentityId)
    Creates a new caldav user setting
    void
    deleteCaldavSetting(long userIdentityId)
    Deletes an caldav user setting
    void
    deleteCaldavSetting(long userIdentityId, String username)
    Disconnects a user's CalDAV account, and tidies what eXo built from it.
    CaldavUserSetting
    getCaldavSetting(long userIdentityId)
    Retrieves caldav user setting by its technical user identity identifier.
    void
    saveMirrorCalendarHref(String mirrorCalendarHref, long userIdentityId)
    Saves the href of the mirror calendar of a user: the collection, on the connected CalDAV server, that receives the meetings pushed by eXo.

  • Method Details

    • createCaldavSetting

      void createCaldavSetting(CaldavUserSetting caldavUserSetting, long userIdentityId) throws IllegalAccessException
      Creates a new caldav user setting
      Parameters:
      caldavUserSetting - CaldavUserSetting object to create
      userIdentityId - User identity creating the exchange user setting
      Throws:
      IllegalAccessException - when the user is not authorized to create caldav setting

    • getCaldavSetting

      CaldavUserSetting getCaldavSetting(long userIdentityId)
      Retrieves caldav user setting by its technical user identity identifier.
      Parameters:
      userIdentityId - User identity getting the caldav user setting
      Returns:
      A CaldavUserSetting object

    • deleteCaldavSetting

      void deleteCaldavSetting(long userIdentityId)
      Deletes an caldav user setting
      Parameters:
      userIdentityId - User identity deleting his caldav user setting

    • deleteCaldavSetting

      void deleteCaldavSetting(long userIdentityId, String username)
      Disconnects a user's CalDAV account, and tidies what eXo built from it.

      Nothing on the server is touched. In eXo, a calendar eXo materialised from a collection of that account goes with the account — everything in it lives there and nothing in it was created here — while a calendar the user made in eXo and eXo pushed out stays, since the account was its destination and never its source.

      Parameters:
      userIdentityId - identity of the user
      username - the user's login, which agenda's ACL needs to remove a calendar on their behalf; without it only the settings are removed

    • saveMirrorCalendarHref

      void saveMirrorCalendarHref(String mirrorCalendarHref, long userIdentityId)
      Saves the href of the mirror calendar of a user: the collection, on the connected CalDAV server, that receives the meetings pushed by eXo. The href — never the display name — identifies the collection, so renaming it from any CalDAV client does not orphan it.
      Parameters:
      mirrorCalendarHref - href of the mirror calendar collection
      userIdentityId - User identity saving his mirror calendar
      Throws:
      IllegalArgumentException - when the href is blank