Package com.logicaldoc.split.webservice.soap.endpoint

Class SoapSplitService

java.lang.Object

com.logicaldoc.webservice.AbstractService

com.logicaldoc.split.webservice.soap.endpoint.SoapSplitService

All Implemented Interfaces:

SplitService

public class SoapSplitService
extends com.logicaldoc.webservice.AbstractService
implements SplitService

Implementation of the Split webservice

Since:

8.4

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapSplitService()

Method Summary

Modifier and Type	Method	Description
Long[]	splitAllPages(String sid, long docId)	Splits a PDF document, each page in a different file
Long[]	splitSelection(String sid, long docId, String expression)	Splits a PDF document in a selection of pages
Long[]	splitUsingBarcode(String sid, long docId, String expression, int separator)	Splits a PDF document using a barcode as separator
Long[]	splitUsingBlankPage(String sid, long docId, int separator)	Splits a PDF document using a blank page as separator
Long[]	splitUsingText(String sid, long docId, String expression, int separator)	Splits a PDF document using a text as separator

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

SoapSplitService

public SoapSplitService()

Method Details

splitAllPages

public 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 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 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 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 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