Package com.logicaldoc.enterprise.webservice.rest

Interface EnterpriseDocumentService

All Known Implementing Classes:
RestEnterpriseDocumentService
@Consumes("application/json") @Produces("application/json") public interface EnterpriseDocumentService
Enterprise Document Web Service definition interface
Since:
8.7.4
Author:
Alessandro Gasparini - LogicalDOC

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    checkin(Long docId, String comment, String filename, boolean release, com.logicaldoc.webservice.model.WSDocument docVO)
    Checks in an existing document with the given identifier to create a new version, it uses the uploaded chunks
    com.logicaldoc.webservice.model.WSDocument
    create(com.logicaldoc.webservice.model.WSDocument document)
    Creates a new document using the uploaded chunks.
    void
    deleteChunks()
    Deletes all the chunks in the current upload session
    javax.activation.DataHandler
    downloadChunk(long docId, String version, long start, long length)
     
    void
    uploadChunk(byte[] messageBody)
     
    void
    uploadChunkIS(InputStream is)
     

  • Method Details

    • uploadChunk

      @POST @Path("/uploadChunk") @Consumes("application/octet-stream") void uploadChunk(byte[] messageBody) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException
      com.logicaldoc.webservice.WebserviceException
      com.logicaldoc.core.PersistenceException
      IOException

    • uploadChunkIS

      @POST @Path("/uploadChunkIS") @Consumes("application/octet-stream") void uploadChunkIS(InputStream is) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException
      com.logicaldoc.webservice.WebserviceException
      com.logicaldoc.core.PersistenceException
      IOException

    • deleteChunks

      @DELETE @Path("/deleteChunks") void deleteChunks() throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      Deletes all the chunks in the current upload session
      Throws:
      IOException - I/O error
      com.logicaldoc.core.PersistenceException - Error in the database layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice logic
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated

    • create

      @POST @Path("/create") com.logicaldoc.webservice.model.WSDocument create(com.logicaldoc.webservice.model.WSDocument document) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      Creates a new document using the uploaded chunks. The user can completely customize the document through a value object containing the document's metadata
      Parameters:
      document - Web service value object containing the document's metadata
      Returns:
      The value object containing the document's metadata
      Throws:
      IOException - I/O error
      com.logicaldoc.core.PersistenceException - Error in the database layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice logic
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated

    • downloadChunk

      @GET @Path("/downloadChunk") @Produces("application/octet-stream") javax.activation.DataHandler downloadChunk(@QueryParam("docId") long docId, @QueryParam("version") String version, @QueryParam("start") long start, @QueryParam("length") long length) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException
      com.logicaldoc.webservice.WebserviceException
      com.logicaldoc.core.PersistenceException
      IOException

    • checkin

      @POST @Path("/checkin") @Consumes("multipart/form-data") void checkin(Long docId, String comment, String filename, boolean release, com.logicaldoc.webservice.model.WSDocument docVO) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      Checks in an existing document with the given identifier to create a new version, it uses the uploaded chunks
      Parameters:
      docId - The document id
      comment - The check in operation comment
      filename - The document file name
      release - True if this is a new release(e.g.: 2.0) rather than a subversion(e.g.: 1.1)
      docVO - new metadata for the document
      Throws:
      IOException - I/O error
      com.logicaldoc.core.PersistenceException - Error in the database layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice logic
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated