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 expectedSoapDocumenttype 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 ofOcrWebServicewraps a wsclient connection to the webPDF webservice endpointWebServiceType.OCR, usingWebServiceProtocol.SOAPand expecting aSoapDocumentas the result.
-
-
Constructor Summary
Constructors Constructor Description OcrWebService(@NotNull SoapSession<T_SOAP_DOCUMENT> session)Creates aOcrWebServicefor the givenSoapSession.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NotNull OcrTypegetOperationParameters()Returns theOcrWebServicespecificOcrType, which allows setting parameters for the webservice execution.protected @NotNull OperationDatainitOperation()Initializes and prepares the execution of thisOcrWebService.protected @Nullable jakarta.activation.DataHandlerprocessService(T_SOAP_DOCUMENT sourceDocument)Executes theOcrWebServiceoperation and returns theDataHandlerof the result document.protected @NotNull OCRprovideWebServicePort()Create a matchingOCRwebservice port for future executions of thisSoapWebService.voidsetOperationParameters(@Nullable OcrType operation)Sets theOcrWebServicespecificOcrTypeelement, 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
-
-
-
-
Constructor Detail
-
OcrWebService
public OcrWebService(@NotNull @NotNull SoapSession<T_SOAP_DOCUMENT> session) throws ResultExceptionCreates aOcrWebServicefor the givenSoapSession.- Parameters:
session- TheSoapSessionaOcrWebServiceshall 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 WebServiceExceptionExecutes the
OcrWebServiceoperation and returns theDataHandlerof 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:
processServicein classSoapWebService<OCR,OcrType,T_SOAP_DOCUMENT extends SoapDocument>- Parameters:
sourceDocument- The sourceOcrWebService, that shall be processed.- Returns:
- The
DataHandlerof the result document. - Throws:
WebServiceException- Shall be thrown, upon an execution failure.
-
getOperationParameters
@NotNull public @NotNull OcrType getOperationParameters()
Returns theOcrWebServicespecificOcrType, which allows setting parameters for the webservice execution.- Returns:
- The
OcrTypeoperation parameters.
-
setOperationParameters
public void setOperationParameters(@Nullable @Nullable OcrType operation)Sets theOcrWebServicespecificOcrTypeelement, which allows setting parameters for the webservice execution.- Parameters:
operation- Sets theOcrTypeoperation parameters.
-
provideWebServicePort
@NotNull protected @NotNull OCR provideWebServicePort() throws ResultException
Create a matchingOCRwebservice port for future executions of thisSoapWebService.- Specified by:
provideWebServicePortin classSoapWebService<OCR,OcrType,T_SOAP_DOCUMENT extends SoapDocument>- Returns:
- The
OCRwebservice 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 thisOcrWebService.- Specified by:
initOperationin classAbstractWebService<SoapSession<T_SOAP_DOCUMENT extends SoapDocument>,OperationData,OcrType,T_SOAP_DOCUMENT extends SoapDocument,BillingType,PdfPasswordType,SettingsType>- Returns:
- The prepared
OperationData.
-
-