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

      All Methods Instance Methods Abstract Methods 
      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 Detail

      • uploadChunk

        @POST
@Path("/uploadChunk")
@Consumes("application/octet-stream")
void uploadChunk​(byte[] messageBody)
          throws Exception
        Throws:
        Exception

      • uploadChunkIS

        @POST
@Path("/uploadChunkIS")
@Consumes("application/octet-stream")
void uploadChunkIS​(InputStream is)
            throws Exception
        Throws:
        Exception

      • deleteChunks

        @DELETE
@Path("/deleteChunks")
void deleteChunks()
           throws Exception
        Deletes all the chunks in the current upload session
        Throws:
        Exception - a generic error

      • create

        @POST
@Path("/create")
com.logicaldoc.webservice.model.WSDocument create​(com.logicaldoc.webservice.model.WSDocument document)
                                           throws Exception
        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:
        Exception - error in the server or in the database

      • 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 Exception
        Throws:
        Exception

      • 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 Exception
        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:
        Exception - error in the server or in the database