Class SoapConversionClient

java.lang.Object
com.logicaldoc.webservice.soap.client.SoapClient<ConversionService>
com.logicaldoc.conversion.webservice.soap.client.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
  • Constructor Details

    • SoapConversionClient

      public SoapConversionClient(String endpoint, int gzipThreshold, boolean log, int timeout)
    • SoapConversionClient

      public SoapConversionClient(String endpoint)
  • Method Details

    • convertDocumentToFile

      public void convertDocumentToFile(String sid, long docId, String fileVersion, String format, File output) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.security.authorization.PermissionException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException
      com.logicaldoc.core.security.authorization.PermissionException
      FeatureNotEnabledException
      com.logicaldoc.webservice.WebserviceException
      com.logicaldoc.core.PersistenceException
      IOException
    • convertDocument

      public javax.activation.DataHandler convertDocument(String sid, long docId, String fileVersion, String format) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.security.authorization.PermissionException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      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:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      FeatureNotEnabledException - The required feature is not enabled
      com.logicaldoc.webservice.WebserviceException - Error in the webservice layer
      com.logicaldoc.core.PersistenceException - Error in the data layer
      IOException - I/O error
    • convertDocumentAndSave

      public long convertDocumentAndSave(String sid, long docId, String fileVersion, String format) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.security.authorization.PermissionException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      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:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      FeatureNotEnabledException - The required feature is not enabled
      com.logicaldoc.webservice.WebserviceException - Error in the webservice layer
      com.logicaldoc.core.PersistenceException - Error in the data layer
      IOException - I/O error
    • convertDocumentToPdf

      public void convertDocumentToPdf(String sid, long docId, String fileVersion) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.security.authorization.PermissionException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      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:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      FeatureNotEnabledException - The required feature is not enabled
      com.logicaldoc.webservice.WebserviceException - Error in the webservice layer
      com.logicaldoc.core.PersistenceException - Error in the data layer
      IOException - I/O error
    • convertFile

      public javax.activation.DataHandler convertFile(String sid, String fileName, String format, javax.activation.DataHandler fileContent) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      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:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated
      FeatureNotEnabledException - The required feature is not enabled
      com.logicaldoc.webservice.WebserviceException - Error in the webservice layer
      com.logicaldoc.core.PersistenceException - Error in the data layer
      IOException - I/O error
    • convertFile

      public void convertFile(String sid, File input, File output) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOException
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException
      FeatureNotEnabledException
      com.logicaldoc.webservice.WebserviceException
      com.logicaldoc.core.PersistenceException
      IOException