Class SoapSplitClient

java.lang.Object
com.logicaldoc.webservice.soap.client.SoapClient<SplitService>
com.logicaldoc.split.webservice.soap.client.SoapSplitClient
All Implemented Interfaces:
SplitService

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

    • SoapSplitClient

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

      public SoapSplitClient(String endpoint)
  • Method Details

    • splitAllPages

      public List<Long> splitAllPages(String sid, long docId) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: SplitService
      Splits a PDF document, each page in a different file
      Specified by:
      splitAllPages in interface SplitService
      Parameters:
      sid - identifier of the session
      docId - identifier of the document
      Returns:
      identifiers of the created segments
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
    • splitSelection

      public List<Long> splitSelection(String sid, long docId, String expression) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: SplitService
      Splits a PDF document in a selection of pages
      Specified by:
      splitSelection in interface SplitService
      Parameters:
      sid - identifier of the session
      docId - identifier of the document
      expression - the selection of pages (e.g.: 1,2,4-6,9)
      Returns:
      identifiers of the created segments
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
    • splitUsingBlankPage

      public List<Long> splitUsingBlankPage(String sid, long docId, int separator) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: SplitService
      Splits a PDF document using a blank page as separator
      Specified by:
      splitUsingBlankPage in interface SplitService
      Parameters:
      sid - identifier of the session
      docId - identifier of the document
      separator - how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment
      Returns:
      identifiers of the created segments
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
    • splitUsingBarcode

      public List<Long> splitUsingBarcode(String sid, long docId, String expression, int separator) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: SplitService
      Splits a PDF document using a barcode as separator
      Specified by:
      splitUsingBarcode in interface SplitService
      Parameters:
      sid - identifier of the session
      docId - identifier of the document
      expression - regular expression that must be matched by the barcode's value, see Pattern
      separator - how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment
      Returns:
      identifiers of the created segments
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
    • splitUsingText

      public List<Long> splitUsingText(String sid, long docId, String expression, int separator) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: SplitService
      Splits a PDF document using a text as separator
      Specified by:
      splitUsingText in interface SplitService
      Parameters:
      sid - identifier of the session
      docId - identifier of the document
      expression - regular expression that must be matched by the text, see Pattern
      separator - how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment
      Returns:
      identifiers of the created segments
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer