Package net.webpdf.wsclient.webservice.soap

Class OcrWebService<T_SOAP_DOCUMENT extends SoapDocument>

java.lang.Object

net.webpdf.wsclient.webservice.AbstractWebService<SoapSession<T_SOAP_DOCUMENT>,OperationData,T_OPERATION_PARAMETER,T_SOAP_DOCUMENT,BillingType,PdfPasswordType,SettingsType>

net.webpdf.wsclient.webservice.soap.SoapWebService<OCR,OcrType,T_SOAP_DOCUMENT>

net.webpdf.wsclient.webservice.soap.OcrWebService<T_SOAP_DOCUMENT>

Type Parameters:

T_SOAP_DOCUMENT - The expected SoapDocument type for the documents used by the webPDF server.

All Implemented Interfaces:

WebService<SoapSession<T_SOAP_DOCUMENT>,OcrType,T_SOAP_DOCUMENT,BillingType,PdfPasswordType,SettingsType>

public class OcrWebService<T_SOAP_DOCUMENT extends SoapDocument>
extends SoapWebService<OCR,OcrType,T_SOAP_DOCUMENT>

An instance of OcrWebService wraps a wsclient connection to the webPDF webservice endpoint WebServiceType.OCR, using WebServiceProtocol.SOAP and expecting a SoapDocument as the result.

Constructor Summary

Constructors

Constructor	Description
OcrWebService(@NotNull SoapSession<T_SOAP_DOCUMENT> session)	Creates a OcrWebService for the given SoapSession.

Method Summary

Modifier and Type	Method	Description
@NotNull OcrType	getOperationParameters()	Returns the OcrWebService specific OcrType, which allows setting parameters for the webservice execution.
protected @NotNull OperationData	initOperation()	Initializes and prepares the execution of this OcrWebService.
protected @Nullable jakarta.activation.DataHandler	processService(T_SOAP_DOCUMENT sourceDocument)	Executes the OcrWebService operation and returns the DataHandler of the result document.
protected @NotNull OCR	provideWebServicePort()	Create a matching OCR webservice port for future executions of this SoapWebService.
void	setOperationParameters(@Nullable OcrType operation)	Sets the OcrWebService specific OcrType element, which allows setting parameters for the webservice execution.

Methods inherited from class net.webpdf.wsclient.webservice.soap.SoapWebService

getBilling, getMTOMFeature, getPassword, getPort, getQName, getSettings, getWsdlDocumentLocation, process, process, setBilling, setPassword, setSettings

Methods inherited from class net.webpdf.wsclient.webservice.AbstractWebService

getAdditionalParameter, getHeaders, getOperationData, getSession, getWebServiceType

Methods inherited from class java.lang.Object

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

Constructor Detail

OcrWebService

public OcrWebService(@NotNull
                     @NotNull SoapSession<T_SOAP_DOCUMENT> session)
              throws ResultException

Creates a OcrWebService for the given SoapSession.

Parameters:

session - The SoapSession a OcrWebService shall be created for.

Throws:

ResultException - Shall be thrown, upon an execution failure.

Method Detail

processService

@Nullable
protected @Nullable jakarta.activation.DataHandler processService(@NotNull
                                                                  T_SOAP_DOCUMENT sourceDocument)
                                                           throws WebServiceException

Executes the OcrWebService operation and returns the DataHandler of the result document.

Be aware: SOAP webservices may not be executed without a sourceDocument. It is required, that you at least create a dummy document, such as: new SoapWebServiceDocument() for webservices not requiring a source document. (Such as the URL-converter.)

Specified by:

processService in class SoapWebService<OCR,OcrType,T_SOAP_DOCUMENT extends SoapDocument>

Parameters:

sourceDocument - The source OcrWebService, that shall be processed.

Returns:

The DataHandler of the result document.

Throws:

WebServiceException - Shall be thrown, upon an execution failure.

getOperationParameters

@NotNull
public @NotNull OcrType getOperationParameters()

Returns the OcrWebService specific OcrType, which allows setting parameters for the webservice execution.

Returns:

The OcrType operation parameters.

setOperationParameters

public void setOperationParameters(@Nullable
                                   @Nullable OcrType operation)

Sets the OcrWebService specific OcrType element, which allows setting parameters for the webservice execution.

Parameters:

operation - Sets the OcrType operation parameters.

provideWebServicePort

@NotNull
protected @NotNull OCR provideWebServicePort()
                                      throws ResultException

Create a matching OCR webservice port for future executions of this SoapWebService.

Specified by:

provideWebServicePort in class SoapWebService<OCR,OcrType,T_SOAP_DOCUMENT extends SoapDocument>

Returns:

The OCR webservice port, that shall be used for executions.

Throws:

ResultException - Shall be thrown, upon an execution failure.

initOperation

@NotNull
protected @NotNull OperationData initOperation()

Initializes and prepares the execution of this OcrWebService.

Specified by:

initOperation in class AbstractWebService<SoapSession<T_SOAP_DOCUMENT extends SoapDocument>,OperationData,OcrType,T_SOAP_DOCUMENT extends SoapDocument,BillingType,PdfPasswordType,SettingsType>

Returns:

The prepared OperationData.