Class SoapImpexClient

java.lang.Object
com.logicaldoc.webservice.soap.client.SoapClient<ImpexService>
com.logicaldoc.impex.webservice.soap.client.SoapImpexClient
All Implemented Interfaces:
ImpexService

public class SoapImpexClient extends com.logicaldoc.webservice.soap.client.SoapClient<ImpexService> implements ImpexService
  • Constructor Details

    • SoapImpexClient

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

      public SoapImpexClient(String endpoint)
  • Method Details

    • createExportArchive

      public long createExportArchive(String sid, String name, String description) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: ImpexService
      Defines a new export archive.
      Specified by:
      createExportArchive in interface ImpexService
      Parameters:
      sid - Session identifier
      name - Name of the archive, mandatory
      description - Description of the archive, optional
      Returns:
      The id of the newly created export archive
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
    • addDocumentToExportArchive

      public void addDocumentToExportArchive(String sid, long archiveId, long docId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, com.logicaldoc.gui.common.client.ServerException
      Description copied from interface: ImpexService
      Adds a document to an existing export archive
      Specified by:
      addDocumentToExportArchive in interface ImpexService
      Parameters:
      sid - Session identifier
      archiveId - identifier of the archive to be used
      docId - identifier of the document to be added
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.gui.common.client.ServerException - Error in the application server
    • closeExportArchive

      public void closeExportArchive(String sid, long archiveId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: ImpexService
      Closes an export archive
      Specified by:
      closeExportArchive in interface ImpexService
      Parameters:
      sid - Session identifier
      archiveId - identifier of the archive to be closed
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
    • deleteExportArchive

      public void deleteExportArchive(String sid, long archiveId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: ImpexService
      Deletes an export archive
      Specified by:
      deleteExportArchive in interface ImpexService
      Parameters:
      sid - Session identifier
      archiveId - identifier of the archive to be closed
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
    • getArchiveIdByName

      public Long getArchiveIdByName(String sid, String name) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: ImpexService
      Retrieves the ID of an existing archive
      Specified by:
      getArchiveIdByName in interface ImpexService
      Parameters:
      sid - Session identifier
      name - Name of the archive
      Returns:
      The id of the archive
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer