Package io.jmix.webdav.service

Interface WebdavUrlManagementService

All Known Implementing Classes:
WebdavUrlManagementServiceImpl
public interface WebdavUrlManagementService
Service for getting non-persisted links.
The links store information about the opening application/access mode/filename/document version.
The link opens the app for the file stored in the WebdavDocument/WebdavDocumentVersion entity or downloads it.

For example: ms-word:ofv|u|http://localhost:8080/app/webdav/document/0e68df0e-8395-4d25-a230-3eb89e6b2674/example.docx
String value of link is encapsulated by field WebdavUrl.url of WebdavUrl

Links are not stored in database and generated on the fly.

Note: recommend to use persistent links from WebdavRawLinksManagementService

  • Method Details

    • retrieveDocumentUrlByWebdavDocumentId

      @Nullable WebdavUrl retrieveDocumentUrlByWebdavDocumentId(UUID documentId)
      Returns a link to the last document version with full access mode.
      Returns:
      Returns a link to last version of file with full access mode. Returns a read-only link if user don't have rights to update document. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document not found.

    • retrieveDocumentUrlByWebdavDocument

      @Nullable WebdavUrl retrieveDocumentUrlByWebdavDocument(WebdavDocument document)
      Returns a link to the last document version with full access mode.
      Returns:
      Returns a link to last version of file with full access mode. Returns a read-only link if user don't have rights to update document. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document not found.

    • retrieveDocumentUrlByWebdavDocumentVersionId

      @Nullable WebdavUrl retrieveDocumentUrlByWebdavDocumentVersionId(UUID documentVersionId)
      Returns a link to the last document version with full access mode. It finds the related document and gets last version for it.
      Returns:
      Returns a link to last version of file with full access mode. Returns a read-only link if user don't have rights to update document. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document not found.

    • retrieveDocumentUrlByWebdavDocumentVersion

      @Nullable WebdavUrl retrieveDocumentUrlByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)
      Returns a link to the last document version with full access mode. It finds related document and gets last version for it.
      Returns:
      Returns a link to last version of file with full access mode. Returns a read-only link if user don't have rights to update document. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document not found.

    • retrieveConcreteVersionUrlByWebdavDocumentVersionId

      @Nullable WebdavUrl retrieveConcreteVersionUrlByWebdavDocumentVersionId(UUID documentVersionId)
      Returns a link to the concrete document version with read-only access mode.
      Returns:
      Returns a read-only link to the concrete version of file. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document version not found.

    • retrieveConcreteVersionUrlByWebdavDocumentVersion

      @Nullable WebdavUrl retrieveConcreteVersionUrlByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)
      Returns a link to the concrete document version with read-only access mode.
      Returns:
      Returns a read-only link to the concrete version of file. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document version not found.

    • retrieveConcreteVersionUrlByWebdavDocumentIdAndNaturalVersion

      @Nullable WebdavUrl retrieveConcreteVersionUrlByWebdavDocumentIdAndNaturalVersion(UUID documentId, Long naturalVersionId)
      Returns a link to the concrete document version with read-only access mode.
      Returns:
      Returns a read-only link to the concrete version of file. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document version not found.

    • retrieveConcreteVersionUrlByWebdavDocumentAndNaturalVersion

      @Nullable WebdavUrl retrieveConcreteVersionUrlByWebdavDocumentAndNaturalVersion(WebdavDocument document, Long naturalVersionId)
      Returns a link to the concrete document version with read-only access mode.
      Returns:
      Returns a read-only link to the concrete version of file. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document version not found.

    • retrieveLastVersionUrlByWebdavDocumentId

      @Nullable WebdavUrl retrieveLastVersionUrlByWebdavDocumentId(UUID documentId)
      Returns a link to the last document version with read-only access mode.
      Returns:
      Returns a read-only link to the last version of file. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document version not found.

    • retrieveLastVersionUrlByWebdavDocument

      @Nullable WebdavUrl retrieveLastVersionUrlByWebdavDocument(WebdavDocument document)
      Returns a link to the last document version with read-only access mode.
      Returns:
      Returns a read-only link to the last version of file. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document version not found.

    • retrieveLastVersionUrlByWebdavDocumentVersionId

      @Nullable WebdavUrl retrieveLastVersionUrlByWebdavDocumentVersionId(UUID documentVersionId)
      Returns a link to the last document version with read-only access mode.
      Returns:
      Returns a read-only link to the last version of file. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document version not found.

    • retrieveLastVersionUrlByWebdavDocumentVersion

      @Nullable WebdavUrl retrieveLastVersionUrlByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)
      Returns a link to the last document version with read-only access mode.
      Returns:
      Returns a read-only link to the last version of file. Returns a link for downloading of file if there is no applications for this type of file. Returns null if document version not found.

    • resolveEffectiveApplication

      Application resolveEffectiveApplication(WebdavDocumentVersion version, ApplicationProtocolType protocolType)
      Returns an application for document version with specific ApplicationProtocolType.
      Returns:
      Application information