Package org.nuxeo.wopi

Interface WOPIService

All Known Implementing Classes:
WOPIServiceImpl
public interface WOPIService
WOPI Service.
Since:
10.3

  • Method Details

    • isEnabled

      boolean isEnabled()
      Returns @{code true} if WOPI is enabled, false otherwise.

      The WOPI discovery XML file has been loaded.

    • getWOPIBlobInfo

      WOPIBlobInfo getWOPIBlobInfo(Blob blob)
      Returns a WOPIBlobInfo for the given blob if it is supported by WOPI, null otherwise.

    • isSupported

      default boolean isSupported(Blob blob)
      Returns true if the given blob is supported by WOPI, false otherwise.

      This method relies on checking that the blob's filename extension is supported by the WOPI discovery.

      Since:
      2021.43

    • getActionURL

      String getActionURL(Blob blob, String action)
      Returns the WOPI action url given a blob and an action.

    • verifyProofKey

      boolean verifyProofKey(String proofKeyHeader, String oldProofKeyHeader, String url, String accessToken, String timestampHeader)
      Verifies that the request originate from Office Online.

    • refreshDiscovery

      boolean refreshDiscovery()
      Refreshes the WOPI discovery: fetches the data from the discovery URL, stores it and loads it in memory.
      Returns:
      true if refreshing the discovery has succeeded, false otherwise
      Since:
      10.10

    • checkDownloadBlob

      default boolean checkDownloadBlob(DocumentModel doc, String xpath, Blob blob)
      Checks whether the download of the blob is allowed.
      Returns:
      true if download is allowed
      Since:
      2021.37

    • updateCheckFileInfoProperties

      default Map<String,Serializable> updateCheckFileInfoProperties(Map<String,Serializable> checkFileInfoProperties)
      Since:
      2021.40