Package org.exoplatform.documents.service

Interface PublicDocumentAccessService

public interface PublicDocumentAccessService

  • Method Details

    • createPublicDocumentAccess

      PublicDocumentAccess createPublicDocumentAccess(long docOwnerId, String nodeId, String password, Long expirationDate, boolean hasPassword)
      Creates a public access for a document
      Parameters:
      docOwnerId - document owner
      nodeId - document node id
      password - password of the public access
      expirationDate - public access expiration date
      hasPassword - document has already old password
      Returns:
      PublicDocumentAccess

    • getPublicDocumentAccess

      PublicDocumentAccess getPublicDocumentAccess(String documentId)
      Gets a document public access by its node id
      Parameters:
      documentId - node id
      Returns:
      PublicDocumentAccess

    • isPublicDocumentAccessExpired

      boolean isPublicDocumentAccessExpired(String documentId)
      Checks if public access expired
      Parameters:
      documentId - node id
      Returns:
      true or false

    • isDocumentPublicAccessValid

      boolean isDocumentPublicAccessValid(String documentId, String password)
      Checks the validity of a public access
      Parameters:
      documentId - node id
      password - password of the document public access
      Returns:
      true if access is valid or false else

    • hasDocumentPublicAccess

      boolean hasDocumentPublicAccess(String documentId)
      Checks if a document has public access
      Parameters:
      documentId - document id
      Returns:
      true or false

    • revokeDocumentPublicAccess

      void revokeDocumentPublicAccess(String documentId)
      Revokes a document public access
      Parameters:
      documentId - document id