Package org.nuxeo.wopi.rest

Class FilesEndpoint

java.lang.Object
org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>
org.nuxeo.ecm.webengine.model.impl.DefaultObject
org.nuxeo.wopi.rest.FilesEndpoint
All Implemented Interfaces:
Resource, Adaptable
public class FilesEndpoint extends DefaultObject
Implementation of the Files endpoint.

See Files endpoint.

Since:
10.3

  • Field Details

    • request

      @Context protected jakarta.servlet.http.HttpServletRequest request

    • response

      @Context protected jakarta.servlet.http.HttpServletResponse response

    • httpHeaders

      @Context protected jakarta.ws.rs.core.HttpHeaders httpHeaders

    • session

      protected CoreSession session

    • doc

      protected DocumentModel doc

    • blob

      protected Blob blob

    • xpath

      protected String xpath

    • fileId

      protected String fileId

    • baseURL

      protected String baseURL

    • wopiBaseURL

      protected String wopiBaseURL

  • Constructor Details

    • FilesEndpoint

      public FilesEndpoint()

  • Method Details

    • initialize

      public void initialize(Object... args)
      Overrides:
      initialize in class AbstractResource<ResourceTypeImpl>

    • checkFileInfo

      @GET @Produces("application/json") public jakarta.ws.rs.core.Response checkFileInfo()
      Implements the CheckFileInfo operation.

      See CheckFileInfo.

    • getFile

      @GET @Path("contents") public Blob getFile(@HeaderParam("X-WOPI-MaxExpectedSize") String maxExpectedSizeHeader)
      Implements the GetFile operation.

      See GetFile.

    • doPost

      @POST public jakarta.ws.rs.core.Response doPost(@HeaderParam("X-WOPI-Override") Operation operation)

    • lockOrUnlockAndRelock

      protected jakarta.ws.rs.core.Response lockOrUnlockAndRelock()
      Implements the Lock and UnlockAndRelock operations.

      See Lock and UnlockAndRelock.

    • lock

      protected jakarta.ws.rs.core.Response lock(String lock)

    • buildItemVersionResponse

      protected jakarta.ws.rs.core.Response buildItemVersionResponse(String operation, Blob blob)

    • unlockAndRelock

      protected jakarta.ws.rs.core.Response unlockAndRelock(String lock, String oldLock)

    • getCurrentLock

      protected String getCurrentLock(String operation)
      Returns the WOPI lock if not null and throws a ConflictException otherwise.

      Must be called to check that a locked document is not locked by Nuxeo.

    • buildConflictResponse

      protected jakarta.ws.rs.core.Response buildConflictResponse(String operation, String lock)
      Builds a conflict response with the given WOPI lock as a header.

      Must be called in case of "lock mismatch", for instance when a document is locked by another WOPI client.

    • getLock

      protected jakarta.ws.rs.core.Response getLock()
      Implements the GetLock operation.

      See GetLock.

    • unlockOrRefresh

      protected jakarta.ws.rs.core.Response unlockOrRefresh(String operation, String lock, boolean unlock)

    • putRelativeFile

      public jakarta.ws.rs.core.Response putRelativeFile()
      Implements the PutRelativeFile operation.

      New file creation is not supported, only the binary document conversion is supported.

      See PutRelativeFile.

    • createVersionFromRequestBody

      protected DocumentModel createVersionFromRequestBody(String filename)

    • renameFile

      public jakarta.ws.rs.core.Response renameFile()
      Implements the RenameFile operation.

      See RenameFile.

    • renameBlob

      protected jakarta.ws.rs.core.Response renameBlob(String requestedName)
      Renames the blob with the requestedName.
      Returns:
      the expected JSON response for the RenameFile operation.

    • getShareUrl

      public jakarta.ws.rs.core.Response getShareUrl()
      Implements the GetShareUrl operation.

      See GetShareUrl.

    • doPostContents

      @POST @Path("contents") public jakarta.ws.rs.core.Response doPostContents(@HeaderParam("X-WOPI-Override") Operation operation)

    • putFile

      public jakarta.ws.rs.core.Response putFile()
      Implements the PutFile operation.

      See PutFile.

    • updateBlob

      protected jakarta.ws.rs.core.Response updateBlob()
      Updates the document's blob from a new one.
      Returns:
      the expected response for the PutFile operation, with the 'X-WOPI-ItemVersion' header set.

    • createBlobFromRequestBody

      protected Blob createBlobFromRequestBody(String filename, String mimeType)
      Creates a new blob from the request body, given a filename and an optional mimeType.
      Returns:
      the new blob

    • unlock

      protected jakarta.ws.rs.core.Response unlock()
      Implements the Unlock operation.

      See Unlock.

    • refreshLock

      protected jakarta.ws.rs.core.Response refreshLock()
      Implements the RefreshLock operation.

      See RefreshLock.

    • getMaxExpectedSize

      protected int getMaxExpectedSize(String maxExpectedSizeHeader)

    • getHeader

      protected String getHeader(String operation, String headerName)

    • getHeader

      protected String getHeader(String operation, String headerName, boolean nullable)

    • checkWritePropertiesPermission

      protected void checkWritePropertiesPermission(String operation)

    • buildCheckFileInfoMap

      protected Map<String,Serializable> buildCheckFileInfoMap()

    • addRequiredProperties

      protected void addRequiredProperties(Map<String,Serializable> map)

    • addHostCapabilitiesProperties

      protected void addHostCapabilitiesProperties(Map<String,Serializable> map)

    • addUserMetadataProperties

      protected void addUserMetadataProperties(Map<String,Serializable> map)

    • addUserPermissionsProperties

      protected void addUserPermissionsProperties(Map<String,Serializable> map)

    • addFileURLProperties

      protected void addFileURLProperties(Map<String,Serializable> map)

    • addBreadcrumbProperties

      protected void addBreadcrumbProperties(Map<String,Serializable> map)

    • getItemVersion

      protected String getItemVersion()

    • getDocumentURL

      protected String getDocumentURL(DocumentModel doc)

    • logRequest

      protected void logRequest(String operation, String... headers)

    • logCondition

      protected void logCondition(String condition)

    • logCondition

      protected void logCondition(Supplier<String> condition)

    • logNuxeoAction

      protected void logNuxeoAction(String action)

    • logNuxeoAction

      protected void logNuxeoAction(Supplier<String> action)

    • logResponse

      protected void logResponse(String operation, int status, String... headers)

    • logResponse

      protected void logResponse(String operation, int status, Object entity, String... headers)

    • getHeaderString

      protected String getHeaderString(String... headers)

    • getEntityString

      protected String getEntityString(Object entity)