net.webpdf.wsclient

Class SoapWebService<T_WEBPDF_PORT,T_OPERATION_TYPE>

java.lang.Object

net.webpdf.wsclient.SoapWebService<T_WEBPDF_PORT,T_OPERATION_TYPE>

All Implemented Interfaces:

WebService<SoapDocument,T_OPERATION_TYPE,SoapDocument>

Direct Known Subclasses:

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

public abstract class SoapWebService<T_WEBPDF_PORT,T_OPERATION_TYPE>
extends Object

Method Summary

Modifier and Type	Method and Description
@NotNull BillingType	getBilling() Returns the BillingType of the current webservice.
T_DOC	getDocument() Returns the Document containing the document source.
@NotNull PdfPasswordType	getPassword() Returns the PdfPasswordType of the current webservice.
protected abstract void	initOperation(@NotNull OperationData operation) Initialize all substructures, that must be set for this webservice to accept parameters for this webservice type.
@NotNull SoapDocument	process() Executes webservice operation and returns result
protected abstract T_WEBPDF_PORT	provideWSPort() Create a matching webservice port for future executions of this SOAP webservice.
void	setDocument(T_DOC document) Sets the Document containing the document source.

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

getOperation, setOperation

Method Detail

process

@NotNull
public @NotNull SoapDocument process()
                                        throws ResultException

Executes webservice operation and returns result

Returns:

the result

Throws:

ResultException - a ResultException

provideWSPort

@NotNull
protected abstract T_WEBPDF_PORT provideWSPort()
                                                  throws ResultException

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

Returns:

The webservice port, that shall be used for executions.

Throws:

ResultException

getDocument

@Nullable
public T_DOC getDocument()

Returns the Document containing the document source.

Specified by:

getDocument in interface WebService<T_DOC extends Document,T_OPERATION_TYPE,T_RESULT>

Returns:

the Document containing the document source.

setDocument

public void setDocument(@Nullable
                        T_DOC document)

Sets the Document containing the document source.

Specified by:

setDocument in interface WebService<T_DOC extends Document,T_OPERATION_TYPE,T_RESULT>

Parameters:

document - sets the Document containing the document source.

getBilling

@NotNull
public @NotNull BillingType getBilling()

Returns the BillingType of the current webservice.

Specified by:

getBilling in interface WebService<T_DOC extends Document,T_OPERATION_TYPE,T_RESULT>

Returns:

the BillingType of the current webservice.

getPassword

@NotNull
public @NotNull PdfPasswordType getPassword()

Returns the PdfPasswordType of the current webservice.

Specified by:

getPassword in interface WebService<T_DOC extends Document,T_OPERATION_TYPE,T_RESULT>

Returns:

the PdfPasswordType of the current webservice.

initOperation

protected abstract void initOperation(@NotNull
                                      @NotNull OperationData operation)

Initialize all substructures, that must be set for this webservice to accept parameters for this webservice type.

Parameters:

operation - The operationData that, shall be initialized for webservice execution.