Class SoapConversionClient

  • All Implemented Interfaces:
    ConversionService

    public class SoapConversionClient
    extends com.logicaldoc.webservice.soap.client.SoapClient<ConversionService>
    implements ConversionService
    Conversion Web Service client.
    Since:
    7.7.3
    Author:
    Marco Meschieri - LogicalDOC
    • Method Detail

      • convertDocument

        public javax.activation.DataHandler convertDocument​(String sid,
                                                            long docId,
                                                            String fileVersion,
                                                            String format)
                                                     throws Exception
        Description copied from interface: ConversionService
        Converts an existing document and saves the generated conversion in LogicalDOC.
        Specified by:
        convertDocument in interface ConversionService
        Parameters:
        sid - Session identifier
        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

        public long convertDocumentAndSave​(String sid,
                                           long docId,
                                           String fileVersion,
                                           String format)
                                    throws Exception
        Description copied from interface: ConversionService
        Converts an existing document and saves the generated conversion in LogicalDOC.
        Specified by:
        convertDocumentAndSave in interface ConversionService
        Parameters:
        sid - Session identifier
        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

        public void convertDocumentToPdf​(String sid,
                                         long docId,
                                         String fileVersion)
                                  throws Exception
        Description copied from interface: ConversionService
        Creates the PDF conversion of the given document. If the conversion was already created, nothing will happen.
        Specified by:
        convertDocumentToPdf in interface ConversionService
        Parameters:
        sid - Session identifier
        docId - The document id
        fileVersion - The specific file version(it can be empty)
        Throws:
        Exception - error in the service
      • convertFile

        public javax.activation.DataHandler convertFile​(String sid,
                                                        String fileName,
                                                        String format,
                                                        javax.activation.DataHandler fileContent)
                                                 throws Exception
        Description copied from interface: ConversionService
        Converts a given file and returns the conversion.
        Specified by:
        convertFile in interface ConversionService
        Parameters:
        sid - Session identifier
        fileName - Name of the source file
        format - The output conversion format
        fileContent - The content of the input file
        Returns:
        the raw content of the converted file
        Throws:
        Exception - error in the service