Package net.webpdf.wsclient.webservice.soap

Class PdfaWebService<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<Pdfa,PdfaType,T_SOAP_DOCUMENT>

net.webpdf.wsclient.webservice.soap.PdfaWebService<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>,PdfaType,T_SOAP_DOCUMENT,BillingType,PdfPasswordType,SettingsType>

public class PdfaWebService<T_SOAP_DOCUMENT extends SoapDocument>
extends SoapWebService<Pdfa,PdfaType,T_SOAP_DOCUMENT>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NotNull PdfaType	getOperationParameters()	Returns the PdfaWebService specific PdfaType, which allows setting parameters for the webservice execution.
protected @NotNull OperationData	initOperation()	Initializes and prepares the execution of this PdfaWebService.
protected @Nullable jakarta.activation.DataHandler	processService(T_SOAP_DOCUMENT sourceDocument)	Executes the PdfaWebService operation and returns the DataHandler of the result document.
protected @NotNull Pdfa	provideWebServicePort()	Create a matching Pdfa webservice port for future executions of this SoapWebService.
void	setOperationParameters(@Nullable PdfaType operation)	Sets the PdfaWebService specific PdfaType 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

PdfaWebService

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

Creates a PdfaWebService for the given SoapSession.

Parameters:

session - The SoapSession a PdfaWebService 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 PdfaWebService 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<Pdfa,PdfaType,T_SOAP_DOCUMENT extends SoapDocument>

Parameters:

sourceDocument - The source PdfaWebService, that shall be processed.

Returns:

The DataHandler of the result document.

Throws:

WebServiceException - Shall be thrown, upon an execution failure.

getOperationParameters

@NotNull
public @NotNull PdfaType getOperationParameters()

Returns the PdfaWebService specific PdfaType, which allows setting parameters for the webservice execution.

Returns:

The PdfaType operation parameters.

setOperationParameters

public void setOperationParameters(@Nullable
                                   @Nullable PdfaType operation)

Sets the PdfaWebService specific PdfaType element, which allows setting parameters for the webservice execution.

Parameters:

operation - Sets the PdfaType operation parameters.

provideWebServicePort

@NotNull
protected @NotNull Pdfa provideWebServicePort()
                                       throws ResultException

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

Specified by:

provideWebServicePort in class SoapWebService<Pdfa,PdfaType,T_SOAP_DOCUMENT extends SoapDocument>

Returns:

The Pdfa 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 PdfaWebService.

Specified by:

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

Returns:

The prepared OperationData.