WOPIService (Nuxeo 2021.1.19 API Documentation)

All Known Implementing Classes:

WOPIServiceImpl
```
public interface WOPIService
```
WOPI Service.

Since:

10.3

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getActionURL(Blob blob, String action)`	Returns the WOPI action url given a `blob` and an `action`.
`WOPIBlobInfo`	`getWOPIBlobInfo(Blob blob)`	Returns a `WOPIBlobInfo` for the given blob if it is supported by WOPI, `null` otherwise.
`boolean`	`isEnabled()`	Returns @{code true} if WOPI is enabled, `false` otherwise.
`boolean`	`refreshDiscovery()`	Refreshes the WOPI discovery: fetches the data from the discovery URL, stores it and loads it in memory.
`boolean`	`verifyProofKey(String proofKeyHeader, String oldProofKeyHeader, String url, String accessToken, String timestampHeader)`	Verifies that the request originate from Office Online.

- Method Detail
  - 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.
  - 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