Class SignatureRestWebService<T_REST_DOCUMENT extends RestDocument>
- java.lang.Object
-
- net.webpdf.wsclient.webservice.AbstractWebService<RestSession<T_REST_DOCUMENT>,T_OPERATION_DATA,T_OPERATION_PARAMETER,T_REST_DOCUMENT,OperationBilling,OperationPdfPassword,OperationSettings>
-
- net.webpdf.wsclient.webservice.rest.RestWebService<OperationSignatureOperation,OperationSignature,T_REST_DOCUMENT>
-
- net.webpdf.wsclient.webservice.rest.SignatureRestWebService<T_REST_DOCUMENT>
-
- Type Parameters:
T_REST_DOCUMENT- The expectedRestDocumenttype for the documents used by the webPDF server.
- All Implemented Interfaces:
WebService<RestSession<T_REST_DOCUMENT>,OperationSignature,T_REST_DOCUMENT,OperationBilling,OperationPdfPassword,OperationSettings>
public class SignatureRestWebService<T_REST_DOCUMENT extends RestDocument> extends RestWebService<OperationSignatureOperation,OperationSignature,T_REST_DOCUMENT>
An instance ofSignatureRestWebServicewraps a wsclient connection to the webPDF webservice endpointWebServiceType.SIGNATURE, usingWebServiceProtocol.RESTand expecting aRestDocumentas the result.
-
-
Constructor Summary
Constructors Constructor Description SignatureRestWebService(@NotNull RestSession<T_REST_DOCUMENT> session)Creates aSignatureRestWebServicefor the givenRestSession
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @Nullable OperationBillinggetBilling()Returns theOperationBillingof the current webservice.@NotNull OperationSignaturegetOperationParameters()Returns theSignatureRestWebServicespecificOperationSignature, which allows setting parameters for the webservice execution.@Nullable OperationPdfPasswordgetPassword()Returns theOperationPdfPasswordof the current webservice.@Nullable OperationSettingsgetSettings()Returns theOperationSettingsof the current webservice.protected @NotNull OperationSignatureOperationinitOperation()Initializes and prepares the execution of thisSignatureRestWebService.voidsetBilling(@Nullable OperationBilling billing)Sets theOperationBillingfor the current webservice.voidsetOperationParameters(@Nullable OperationSignature operation)Sets theSignatureRestWebServicespecificOperationSignatureelement, which allows setting parameters for the webservice execution.voidsetPassword(@Nullable OperationPdfPassword password)Sets theOperationPdfPasswordfor the current webservice.voidsetSettings(@Nullable OperationSettings settings)Sets theOperationSettingsfor the current webservice.-
Methods inherited from class net.webpdf.wsclient.webservice.rest.RestWebService
process, process, process
-
Methods inherited from class net.webpdf.wsclient.webservice.AbstractWebService
getAdditionalParameter, getHeaders, getOperationData, getSession, getWebServiceType
-
-
-
-
Constructor Detail
-
SignatureRestWebService
public SignatureRestWebService(@NotNull @NotNull RestSession<T_REST_DOCUMENT> session)Creates aSignatureRestWebServicefor the givenRestSession- Parameters:
session- TheRestSessionaSignatureRestWebServiceshall be created for.
-
-
Method Detail
-
getOperationParameters
@NotNull public @NotNull OperationSignature getOperationParameters()
Returns theSignatureRestWebServicespecificOperationSignature, which allows setting parameters for the webservice execution.- Returns:
- The
OperationSignatureoperation parameters.
-
setOperationParameters
public void setOperationParameters(@Nullable @Nullable OperationSignature operation)Sets theSignatureRestWebServicespecificOperationSignatureelement, which allows setting parameters for the webservice execution.- Parameters:
operation- Sets theOperationSignatureoperation parameters.
-
getPassword
@Nullable public @Nullable OperationPdfPassword getPassword()
Returns theOperationPdfPasswordof the current webservice.- Returns:
- the
OperationPdfPasswordof the current webservice.
-
setPassword
public void setPassword(@Nullable @Nullable OperationPdfPassword password)Sets theOperationPdfPasswordfor the current webservice.- Parameters:
password- TheOperationPdfPasswordfor the current webservice.
-
getBilling
@Nullable public @Nullable OperationBilling getBilling()
Returns theOperationBillingof the current webservice.- Returns:
- the
OperationBillingof the current webservice.
-
setBilling
public void setBilling(@Nullable @Nullable OperationBilling billing)Sets theOperationBillingfor the current webservice.- Parameters:
billing- TheOperationBillingfor the current webservice.
-
getSettings
@Nullable public @Nullable OperationSettings getSettings()
Returns theOperationSettingsof the current webservice.- Returns:
- the
OperationSettingsof the current webservice.
-
setSettings
public void setSettings(@Nullable @Nullable OperationSettings settings)Sets theOperationSettingsfor the current webservice.- Parameters:
settings- TheOperationSettingsfor the current webservice.
-
initOperation
@NotNull protected @NotNull OperationSignatureOperation initOperation()
Initializes and prepares the execution of thisSignatureRestWebService.- Specified by:
initOperationin classAbstractWebService<RestSession<T_REST_DOCUMENT extends RestDocument>,OperationSignatureOperation,OperationSignature,T_REST_DOCUMENT extends RestDocument,OperationBilling,OperationPdfPassword,OperationSettings>- Returns:
- The prepared
OperationSignatureOperation.
-
-