Package com.logicaldoc.conversion.webservice.soap.endpoint

Class SoapConversionService

java.lang.Object
com.logicaldoc.webservice.AbstractService
com.logicaldoc.conversion.webservice.soap.endpoint.SoapConversionService
All Implemented Interfaces:
ConversionService
Direct Known Subclasses:
RestConversionService
public class SoapConversionService extends com.logicaldoc.webservice.AbstractService implements ConversionService
Conversion Web Service Implementation (SOAP)
Since:
7.7.3
Author:
Marco Meschieri - LogicalDOC

  • Constructor Summary

    Constructors
    Constructor
    Description
    SoapConversionService()
     

  • 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.

    Methods inherited from class com.logicaldoc.webservice.AbstractService

    convertDateToString, convertStringToDate, getCurrentMessage, isValidateSession, setCurrentMessage, setValidateSession

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SoapConversionService

      public SoapConversionService()

  • Method Details

    • convertDocument

      public 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
      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:
      FeatureNotEnabledException - The required feature is not enabled
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice layer
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      IOException - I/O error

    • convertDocumentAndSave

      public 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
      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:
      FeatureNotEnabledException - The required feature is not enabled
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice layer
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      IOException - I/O error

    • convertDocumentToPdf

      public 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
      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:
      FeatureNotEnabledException - The required feature is not enabled
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice layer
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      IOException - I/O error

    • convertFile

      public 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
      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:
      FeatureNotEnabledException - The required feature is not enabled
      com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice layer
      com.logicaldoc.core.PersistenceException - Error in the data layer
      IOException - I/O error