Package net.webpdf.wsclient.webservice.soap

Class SoapWebService<T_WEBPDF_PORT,T_OPERATION_PARAMETER,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<T_WEBPDF_PORT,T_OPERATION_PARAMETER,T_SOAP_DOCUMENT>

Type Parameters:

T_OPERATION_PARAMETER - The parameter type of the targeted webservice endpoint.

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

T_WEBPDF_PORT - The interface stub type to operate the webservice endpoint with.

All Implemented Interfaces:

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

Direct Known Subclasses:

BarcodeWebService, ConverterWebService, OcrWebService, PdfaWebService, SignatureWebService, ToolboxWebService, UrlConverterWebService

public abstract class SoapWebService<T_WEBPDF_PORT,T_OPERATION_PARAMETER,T_SOAP_DOCUMENT extends SoapDocument>
extends AbstractWebService<SoapSession<T_SOAP_DOCUMENT>,OperationData,T_OPERATION_PARAMETER,T_SOAP_DOCUMENT,BillingType,PdfPasswordType,SettingsType>

An instance of SoapWebService wraps a wsclient connection to a specific webPDF webservice endpoint (WebServiceType), using WebServiceProtocol.SOAP and expecting a SoapDocument as the result.

Constructor Summary

Constructors

Constructor	Description
SoapWebService(@NotNull SoapSession<T_SOAP_DOCUMENT> session, @NotNull WebServiceType webServiceType)	Creates a webservice interface of the given WebServiceType for the given SoapSession.

Method Summary

Modifier and Type	Method	Description
@NotNull BillingType	getBilling()	Returns the BillingType of the current webservice.
protected @NotNull jakarta.xml.ws.soap.MTOMFeature	getMTOMFeature()	Returns the configuration of the MTOMFeature for the current webservice call.
@NotNull PdfPasswordType	getPassword()	Returns the PdfPasswordType of the current webservice.
protected T_WEBPDF_PORT	getPort()	Returns a matching webservice port for future executions of this SoapWebService.
protected @NotNull QName	getQName()	Returns the QName of the current SOAP webservice.
@Nullable SettingsType	getSettings()	Returns the SettingsType of the current webservice.
protected @NotNull URL	getWsdlDocumentLocation()	Returns the URL of the wsdl document.
T_SOAP_DOCUMENT	process()	Execute the webservice operation and return the resulting SoapWebService. You can write the result of the webservice call via: SoapDocument.writeResult(File) or SoapDocument.writeResult(OutputStream)
T_SOAP_DOCUMENT	process(T_SOAP_DOCUMENT sourceDocument)	Execute the webservice operation for the given source SoapWebService and return the resulting SoapWebService. You can write the result of the webservice call via: SoapDocument.writeResult(File) or SoapDocument.writeResult(OutputStream) on either the returned or the source document.
protected abstract @Nullable jakarta.activation.DataHandler	processService(T_SOAP_DOCUMENT sourceDocument)	Execute the webservice operation and returns the DataHandler of the resulting document.
protected abstract T_WEBPDF_PORT	provideWebServicePort()	Create a matching webservice port for future executions of this SoapWebService.
void	setBilling(@Nullable BillingType billing)	Sets the BillingType for the current webservice.
void	setPassword(@Nullable PdfPasswordType password)	Sets the PdfPasswordType for the current webservice.
void	setSettings(@Nullable SettingsType settings)	Sets the SettingsType for the current webservice.

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

getAdditionalParameter, getHeaders, getOperationData, getSession, getWebServiceType, initOperation

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.webpdf.wsclient.webservice.WebService

getOperationParameters, setOperationParameters

Constructor Detail

SoapWebService

public SoapWebService(@NotNull
                      @NotNull SoapSession<T_SOAP_DOCUMENT> session,
                      @NotNull
                      @NotNull WebServiceType webServiceType)
               throws ResultException

Creates a webservice interface of the given WebServiceType for the given SoapSession.

Parameters:

session - The SoapSession the webservice interface shall be created for.

webServiceType - The WebServiceType interface, that shall be created.

Throws:

ResultException

Method Detail

process

@NotNull
public T_SOAP_DOCUMENT process()
                        throws ResultException

Execute the webservice operation and return the resulting SoapWebService.
You can write the result of the webservice call via: SoapDocument.writeResult(File) or SoapDocument.writeResult(OutputStream)

Be aware: A SoapDocument is using DataHandler objects, which might require to be closed, to avoid resource leaks. You should call SoapDocument.close() on the hereby provided result document.

Be aware: Most webservices require a source SoapWebService, with few exceptions, such as the URL-converter webservice. Before using this method, make sure that this is valid for the WebService call you intend to hereby execute.

Returns:

The resulting SoapWebService.

Throws:

ResultException - Shall be thrown, upon an execution failure.

process

@NotNull
public T_SOAP_DOCUMENT process(@NotNull
                               T_SOAP_DOCUMENT sourceDocument)
                        throws ResultException

Execute the webservice operation for the given source SoapWebService and return the resulting SoapWebService.
You can write the result of the webservice call via: SoapDocument.writeResult(File) or SoapDocument.writeResult(OutputStream) on either the returned or the source document.

Be aware: The hereby returned SoapDocument is identical to the given source document.
Be aware: A SoapDocument is using DataHandler objects, which might require to be closed, to avoid resource leaks. You should call SoapDocument.close() on the hereby provided result document.

Parameters:

sourceDocument - The source SoapWebService, that shall be processed.

Returns:

The resulting SoapWebService.

Throws:

ResultException - Shall be thrown, upon an execution failure.

getPassword

@NotNull
public @NotNull PdfPasswordType getPassword()

Returns the PdfPasswordType of the current webservice.

Returns:

the PdfPasswordType of the current webservice.

setPassword

public void setPassword(@Nullable
                        @Nullable PdfPasswordType password)

Sets the PdfPasswordType for the current webservice.

Parameters:

password - The PdfPasswordType for the current webservice.

getBilling

@NotNull
public @NotNull BillingType getBilling()

Returns the BillingType of the current webservice.

Returns:

the BillingType of the current webservice.

setBilling

public void setBilling(@Nullable
                       @Nullable BillingType billing)

Sets the BillingType for the current webservice.

Parameters:

billing - The BillingType for the current webservice.

getSettings

@Nullable
public @Nullable SettingsType getSettings()

Returns the SettingsType of the current webservice.

Returns:

the SettingsType of the current webservice.

setSettings

public void setSettings(@Nullable
                        @Nullable SettingsType settings)

Sets the SettingsType for the current webservice.

Parameters:

settings - The SettingsType for the current webservice.

processService

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

Execute the webservice operation and returns the DataHandler of the resulting document.

Parameters:

sourceDocument - The SoapWebService to process.

Returns:

The DataHandler of the resulting document.

Throws:

WebServiceException - Shall be thrown, upon an execution failure.

getQName

@NotNull
protected @NotNull QName getQName()

Returns the QName of the current SOAP webservice.

Returns:

the QName of the current SOAP webservice.

getWsdlDocumentLocation

@NotNull
protected @NotNull URL getWsdlDocumentLocation()
                                        throws ResultException

Returns the URL of the wsdl document.

Returns:

the URL of the wsdl document.

Throws:

ResultException - a ResultException

getMTOMFeature

@NotNull
protected @NotNull jakarta.xml.ws.soap.MTOMFeature getMTOMFeature()

Returns the configuration of the MTOMFeature for the current webservice call.

Returns:

The configuration of the MTOMFeature for the current webservice call.

provideWebServicePort

@NotNull
protected abstract T_WEBPDF_PORT provideWebServicePort()
                                                throws ResultException

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

Returns:

The webservice port, that shall be used for executions.

Throws:

ResultException - Shall be thrown, upon an execution failure.

getPort

@NotNull
protected T_WEBPDF_PORT getPort()

Returns a matching webservice port for future executions of this SoapWebService.

Returns:

The webservice port, that shall be used for executions.