Package net.webpdf.wsclient.webservice

Class AbstractWebService<T_SESSION extends Session,T_OPERATION_DATA,T_OPERATION_PARAMETER,T_DOCUMENT extends Document,T_BILLING,T_PASSWORD,T_SETTINGS>

java.lang.Object

net.webpdf.wsclient.webservice.AbstractWebService<T_SESSION,T_OPERATION_DATA,T_OPERATION_PARAMETER,T_DOCUMENT,T_BILLING,T_PASSWORD,T_SETTINGS>

Type Parameters:

T_SESSION - The expected Session type for the webservice connection.

T_OPERATION_DATA - The operation type of the targeted webservice endpoint.

T_OPERATION_PARAMETER - The parameter type of the targeted webservice endpoint.

T_DOCUMENT - The expected Document type for the results produced by the webPDF server.

T_BILLING - The operation´s billing type configuring the server´s billing log entries.

T_PASSWORD - The operation´s password type, used to configure material for password-protected documents.

T_SETTINGS - The operation´s additional settings type, used to configure webservice independent options and parameters.

All Implemented Interfaces:

WebService<T_SESSION,T_OPERATION_PARAMETER,T_DOCUMENT,T_BILLING,T_PASSWORD,T_SETTINGS>

Direct Known Subclasses:

RestWebService, SoapWebService

public abstract class AbstractWebService<T_SESSION extends Session,T_OPERATION_DATA,T_OPERATION_PARAMETER,T_DOCUMENT extends Document,T_BILLING,T_PASSWORD,T_SETTINGS>
extends Object
implements WebService<T_SESSION,T_OPERATION_PARAMETER,T_DOCUMENT,T_BILLING,T_PASSWORD,T_SETTINGS>

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

Constructor Summary

Constructors

Constructor	Description
AbstractWebService(@NotNull WebServiceType webServiceType, T_SESSION session)	Creates a webservice interface of the given WebServiceType for the given AbstractWebService.

Method Summary

Modifier and Type	Method	Description
@NotNull List<org.apache.hc.core5.http.NameValuePair>	getAdditionalParameter()	Returns additional url search parameter for this webservice call.
protected @NotNull Map<String,List<String>>	getHeaders()	Returns the headers of the current webservice operation.
protected T_OPERATION_DATA	getOperationData()	Returns the AbstractWebService of the current webservice.
T_SESSION	getSession()	Returns the AbstractWebService of the current webservice.
protected @NotNull WebServiceType	getWebServiceType()	Returns the WebServiceType of the current webservice.
protected abstract T_OPERATION_DATA	initOperation()	Initializes and prepares the AbstractWebService of the current webservice.

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

getBilling, getOperationParameters, getPassword, getSettings, process, process, setBilling, setOperationParameters, setPassword, setSettings

Constructor Detail

AbstractWebService

public AbstractWebService(@NotNull
                          @NotNull WebServiceType webServiceType,
                          @NotNull
                          T_SESSION session)

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

Parameters:

webServiceType - The WebServiceType interface, that shall be created.

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

Method Detail

getSession

@NotNull
public T_SESSION getSession()

Returns the AbstractWebService of the current webservice.

Specified by:

getSession in interface WebService<T_SESSION extends Session,T_OPERATION_DATA,T_OPERATION_PARAMETER,T_DOCUMENT extends Document,T_BILLING,T_PASSWORD>

Returns:

The AbstractWebService of the current webservice.

getOperationData

@NotNull
protected T_OPERATION_DATA getOperationData()

Returns the AbstractWebService of the current webservice.

Returns:

The AbstractWebService of the current webservice.

getWebServiceType

@NotNull
protected @NotNull WebServiceType getWebServiceType()

Returns the WebServiceType of the current webservice.

Returns:

The WebServiceType of the current webservice.

getHeaders

@NotNull
protected @NotNull Map<String,List<String>> getHeaders()

Returns the headers of the current webservice operation.

Returns:

The headers of the current webservice operation.

initOperation

@NotNull
protected abstract T_OPERATION_DATA initOperation()

Initializes and prepares the AbstractWebService of the current webservice.

Returns:

The initialized AbstractWebService of the current webservice.

getAdditionalParameter

@NotNull
public @NotNull List<org.apache.hc.core5.http.NameValuePair> getAdditionalParameter()

Returns additional url search parameter for this webservice call.

Specified by:

getAdditionalParameter in interface WebService<T_SESSION extends Session,T_OPERATION_DATA,T_OPERATION_PARAMETER,T_DOCUMENT extends Document,T_BILLING,T_PASSWORD>

Returns:

additional url search parameter for this webservice call.