Package com.logicaldoc.conversion.webservice.rest

Interface ConversionService

  • All Known Implementing Classes:
    RestConversionService
    @Consumes({"application/xml","application/json"})
@Produces("application/json")
public interface ConversionService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      javax.activation.DataHandler convertDocument​(long docId, String fileVersion, String format)
      Converts an existing document and saves the generated conversion in LogicalDOC.
      long convertDocumentAndSave​(long docId, String fileVersion, String format)
      Converts an existing document and saves the generated conversion in LogicalDOC.
      void convertDocumentToPdf​(long docId, String fileVersion)
      Creates the PDF conversion of the given document.
      javax.activation.DataHandler convertFile​(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments)
      Converts a given file and returns the conversion.

    • Method Detail

      • convertDocument

        @GET
@Path("/convertDocument")
@Produces("application/octet-stream")
javax.activation.DataHandler convertDocument​(@QueryParam("docId")
                                             long docId,
                                             @QueryParam("fileVersion")
                                             String fileVersion,
                                             @QueryParam("format")
                                             String format)
                                      throws Exception
        Converts an existing document and saves the generated conversion in LogicalDOC.
        Parameters:
        docId - The document id
        fileVersion - The file version
        format - The output conversion format
        Returns:
        The conversion's binary
        Throws:
        Exception - error in the service

      • convertDocumentAndSave

        @GET
@Path("/convertDocumentAndSave")
@Produces("text/plain")
long convertDocumentAndSave​(@QueryParam("docId")
                            long docId,
                            @QueryParam("fileVersion")
                            String fileVersion,
                            @QueryParam("format")
                            String format)
                     throws Exception
        Converts an existing document and saves the generated conversion in LogicalDOC.
        Parameters:
        docId - The document id
        fileVersion - The file version
        format - The output conversion format
        Returns:
        the ID of the generated conversion file
        Throws:
        Exception - error in the service

      • convertDocumentToPdf

        @GET
@Path("/convertDocumentToPdf")
void convertDocumentToPdf​(@QueryParam("docId")
                          long docId,
                          @QueryParam("fileVersion")
                          String fileVersion)
                   throws Exception
        Creates the PDF conversion of the given document. If the conversion was already created, nothing will happen.
        Parameters:
        docId - The document id
        fileVersion - The specific file version(it can be empty)
        Throws:
        Exception - error in the service

      • convertFile

        @POST
@Path("/convertFile")
@Consumes("multipart/form-data")
@Produces("application/octet-stream")
javax.activation.DataHandler convertFile​(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments)
                                  throws Exception
        Converts a given file and returns the conversion. Expected attachments are:
        1. fileName - name of the original file
        2. format - The output format (ag: pdf, ods, doc)
        3. fileContent - The content of the original file
        Parameters:
        attachments - list of attachments
        Returns:
        the raw content of the converted file
        Throws:
        Exception - error in the service