Class DefaultVCardProvider

  • All Implemented Interfaces:
    VCardProvider
    Direct Known Subclasses:
    CrowdVCardProvider

    public class DefaultVCardProvider
    extends Object
    implements VCardProvider
    Default implementation of the VCardProvider interface, which reads and writes data from the ofVCard database table.
    Author:
    Gaston Dombiak
    • Constructor Detail

      • DefaultVCardProvider

        public DefaultVCardProvider()
    • Method Detail

      • loadVCard

        public org.dom4j.Element loadVCard​(String username)
        Description copied from interface: VCardProvider
        Loads the specified user vcard by username. Returns null if no vCard was found for the specified username.
        Specified by:
        loadVCard in interface VCardProvider
        Parameters:
        username - the username
        Returns:
        the vCard as an DOM element or null if none was found.
      • createVCard

        public org.dom4j.Element createVCard​(String username,
                                             org.dom4j.Element vCardElement)
                                      throws AlreadyExistsException
        Description copied from interface: VCardProvider
        Creates and saves the new user vcard. This method should throw an UnsupportedOperationException if this operation is not supported by the backend vcard store. The method is expected to return the vCard after it has had a chance to make any modifications to it that it needed to. In many cases, this may be a simple return of the passed in vCard. This change was made in 3.4.4.
        Specified by:
        createVCard in interface VCardProvider
        Parameters:
        username - the username.
        vCardElement - the vCard to save.
        Returns:
        vCard as it is after the provider has a chance to adjust it.
        Throws:
        AlreadyExistsException - if the user already has a vCard.
      • updateVCard

        public org.dom4j.Element updateVCard​(String username,
                                             org.dom4j.Element vCardElement)
                                      throws NotFoundException
        Description copied from interface: VCardProvider
        Updates the user vcard in the backend store. This method should throw an UnsupportedOperationException if this operation is not supported by the backend vcard store. The method is expected to return the vCard after it has had a chance to make any modifications to it that it needed to. In many cases, this may be a simple return of the passed in vCard. This change was made in 3.4.4.
        Specified by:
        updateVCard in interface VCardProvider
        Parameters:
        username - the username.
        vCardElement - the vCard to save.
        Returns:
        vCard as it is after the provider has a chance to adjust it.
        Throws:
        NotFoundException - if the vCard to update does not exist.
      • deleteVCard

        public void deleteVCard​(String username)
        Description copied from interface: VCardProvider
        Delets a user vcard. This method should throw an UnsupportedOperationException if this operation is not supported by the backend vcard store.
        Specified by:
        deleteVCard in interface VCardProvider
        Parameters:
        username - the username to delete.
      • isReadOnly

        public boolean isReadOnly()
        Description copied from interface: VCardProvider
        Returns true if this VCardProvider is read-only. When read-only, vcards can not be created, deleted, or modified.
        Specified by:
        isReadOnly in interface VCardProvider
        Returns:
        true if the vcard provider is read-only.