Package net.webpdf.wsclient.webservice

Interface WebService<T_SESSION extends Session,T_OPERATION_PARAMETER,T_DOCUMENT extends Document,T_BILLING,T_PASSWORD,T_SETTINGS>

Type Parameters:

T_SESSION - The expected Session type for the webservice connection.

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 Known Implementing Classes:

AbstractWebService, BarcodeRestWebService, BarcodeWebService, ConverterRestWebService, ConverterWebService, OcrRestWebService, OcrWebService, PdfaRestWebService, PdfaWebService, RestWebService, SignatureRestWebService, SignatureWebService, SoapWebService, ToolboxRestWebService, ToolboxWebService, UrlConverterRestWebService, UrlConverterWebService

public interface WebService<T_SESSION extends Session,T_OPERATION_PARAMETER,T_DOCUMENT extends Document,T_BILLING,T_PASSWORD,T_SETTINGS>

A class implementing WebServiceType wraps a wsclient connection to a specific webPDF webservice endpoint (WebServiceType), using a specific WebServiceProtocol and expecting a specific Document type as the result.

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.
T_BILLING	getBilling()	Returns the WebService of the current webservice.
T_OPERATION_PARAMETER	getOperationParameters()	Returns the webservice specific WebService, which allows setting parameters for the webservice execution.
T_PASSWORD	getPassword()	Returns the WebService of the current webservice.
T_SESSION	getSession()	Returns the WebService of the current webservice.
T_SETTINGS	getSettings()	Returns the WebService of the current webservice.
T_DOCUMENT	process()	Execute the webservice operation and return the resulting WebService.
T_DOCUMENT	process(T_DOCUMENT sourceDocument)	Execute the webservice operation for the given source WebService and return the resulting WebService.
void	setBilling(T_BILLING billing)	Sets the WebService for the current webservice.
void	setOperationParameters(T_OPERATION_PARAMETER operation)	Sets the webservice specific WebService, which allows setting parameters for the webservice execution.
void	setPassword(T_PASSWORD password)	Sets the WebService for the current webservice.
void	setSettings(T_SETTINGS settings)	Sets the WebService for the current webservice.

Method Detail

getSession

@NotNull
T_SESSION getSession()

Returns the WebService of the current webservice.

Returns:

The WebService of the current webservice.

process

@NotNull
T_DOCUMENT process()
            throws ResultException

Execute the webservice operation and return the resulting WebService.

Be aware: Most webservices require a source WebService, 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 WebService.

Throws:

ResultException - Shall be thrown, upon an execution failure.

process

@NotNull
T_DOCUMENT process(@NotNull
                   T_DOCUMENT sourceDocument)
            throws ResultException

Execute the webservice operation for the given source WebService and return the resulting WebService.

Parameters:

sourceDocument - The source WebService, that shall be processed.

Returns:

The resulting WebService.

Throws:

ResultException - Shall be thrown, upon an execution failure.

getOperationParameters

@NotNull
T_OPERATION_PARAMETER getOperationParameters()

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

Returns:

The webservice specific WebService.

setOperationParameters

void setOperationParameters(@Nullable
                            T_OPERATION_PARAMETER operation)

Sets the webservice specific WebService, which allows setting parameters for the webservice execution.

Parameters:

operation - The webservice specific WebService.

getPassword

@Nullable
T_PASSWORD getPassword()

Returns the WebService of the current webservice.

Returns:

the WebService of the current webservice.

setPassword

void setPassword(@Nullable
                 T_PASSWORD password)

Sets the WebService for the current webservice.

Parameters:

password - The WebService for the current webservice.

getBilling

@Nullable
T_BILLING getBilling()

Returns the WebService of the current webservice.

Returns:

the WebService of the current webservice.

setBilling

void setBilling(@Nullable
                T_BILLING billing)

Sets the WebService for the current webservice.

Parameters:

billing - The WebService for the current webservice.

getSettings

@Nullable
T_SETTINGS getSettings()

Returns the WebService of the current webservice.

Returns:

the WebService of the current webservice.

setSettings

void setSettings(@Nullable
                 T_SETTINGS settings)

Sets the WebService for the current webservice.

Parameters:

settings - The WebService for the current webservice.

getAdditionalParameter

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

Returns additional url search parameter for this webservice call.

Returns:

additional url search parameter for this webservice call.