Package com.logicaldoc.conversion.webservice.soap

Interface ConversionService

All Known Implementing Classes:
RestConversionService, SoapConversionClient, SoapConversionService
public interface ConversionService
Conversion Web Service definition interface
Since:
7.7.3
Author:
Marco Meschieri - LogicalDOC

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.activation.DataHandler
    convertDocument(String sid, long docId, String fileVersion, String format)
    Converts an existing document and saves the generated conversion in LogicalDOC.
    long
    convertDocumentAndSave(String sid, long docId, String fileVersion, String format)
    Converts an existing document and saves the generated conversion in LogicalDOC.
    void
    convertDocumentToPdf(String sid, long docId, String fileVersion)
    Creates the PDF conversion of the given document.
    jakarta.activation.DataHandler
    convertFile(String sid, String fileName, String format, jakarta.activation.DataHandler fileContent)
    Converts a given file and returns the conversion.

  • Method Details

    • convertDocument

      jakarta.activation.DataHandler convertDocument(String sid, long docId, String fileVersion, String format) throws FeatureNotEnabledException, com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, com.logicaldoc.core.security.authorization.PermissionException, IOException
      Converts an existing document and saves the generated conversion in LogicalDOC.
      Parameters:
      sid - Session identifier
      docId - The document id
      fileVersion - The file version
      format - The output conversion format
      Returns:
      The conversion's binary
      Throws:
      IOException - I/O error
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice layer
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated
      FeatureNotEnabledException - The required feature is not enabled

    • convertDocumentAndSave

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

    • convertDocumentToPdf

      void convertDocumentToPdf(String sid, long docId, String fileVersion) throws FeatureNotEnabledException, com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, com.logicaldoc.core.security.authorization.PermissionException, IOException
      Creates the PDF conversion of the given document. If the conversion was already created, nothing will happen.
      Parameters:
      sid - Session identifier
      docId - The document id
      fileVersion - The specific file version(it can be empty)
      Throws:
      IOException - I/O error
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice layer
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated
      FeatureNotEnabledException - The required feature is not enabled

    • convertFile

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