Package se.idsec.signservice.integration.document.pdf

Class PreparedPdfDocument.PreparedPdfDocumentBuilder

java.lang.Object

se.idsec.signservice.integration.document.pdf.PreparedPdfDocument.PreparedPdfDocumentBuilder

All Implemented Interfaces:

ObjectBuilder<PreparedPdfDocument>

Enclosing class:

PreparedPdfDocument

public static class PreparedPdfDocument.PreparedPdfDocumentBuilder
extends Object
implements ObjectBuilder<PreparedPdfDocument>

Builder for PreparedPdfDocument objects.

Method Summary

Modifier and Type	Method	Description
PreparedPdfDocument	build()	Builds the object.
PreparedPdfDocument.PreparedPdfDocumentBuilder	extension(Extension extension)	Extensions for the object.
PreparedPdfDocument.PreparedPdfDocumentBuilder	policy(String policy)	The policy under which the data held in this class may be used.
String	toString()
PreparedPdfDocument.PreparedPdfDocumentBuilder	updatedPdfDocument(String updatedPdfDocument)	If the PDF document passed to ExtendedSignServiceIntegrationService.preparePdfSignaturePage(String, byte[], PdfSignaturePagePreferences) was updated with a PDF signature page this property holds the updated PDf document (in its Base64 encoded form).
PreparedPdfDocument.PreparedPdfDocumentBuilder	updatedPdfDocumentReference(String updatedPdfDocumentReference)	If PdfSignaturePagePreferences.getReturnDocumentReference() is true the updated document will be returned as a reference instead of via a PreparedPdfDocument.getUpdatedPdfDocument() call.
PreparedPdfDocument.PreparedPdfDocumentBuilder	visiblePdfSignatureRequirement(VisiblePdfSignatureRequirement visiblePdfSignatureRequirement)	The resulting VisiblePdfSignatureRequirement object that should be passed as a property in the TbsDocument holding the PDF document that is passed to SignServiceIntegrationService.createSignRequest(se.idsec.signservice.integration.SignRequestInput).

Methods inherited from class java.lang.Object

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

Method Details

policy

public PreparedPdfDocument.PreparedPdfDocumentBuilder policy(String policy)

The policy under which the data held in this class may be used. This is always the same as the policy given in the call to ExtendedSignServiceIntegrationService.preparePdfSignaturePage(String, byte[], PdfSignaturePagePreferences).

Parameters:

policy - the policy

Returns:

this.

updatedPdfDocument

public PreparedPdfDocument.PreparedPdfDocumentBuilder updatedPdfDocument(String updatedPdfDocument)

If the PDF document passed to ExtendedSignServiceIntegrationService.preparePdfSignaturePage(String, byte[], PdfSignaturePagePreferences) was updated with a PDF signature page this property holds the updated PDf document (in its Base64 encoded form).

If the property is null it means that the PDF document was not modified by preparePdfSignaturePage.

Note: This property is only assigned if PdfSignaturePagePreferences.getReturnDocumentReference() is false. If document references should be used the reference for the updated document is obtained by calling PreparedPdfDocument.getUpdatedPdfDocumentReference().

Parameters:

updatedPdfDocument - updated PDF document (in Base64 encoded form)

Returns:

this.

updatedPdfDocumentReference

public PreparedPdfDocument.PreparedPdfDocumentBuilder updatedPdfDocumentReference(String updatedPdfDocumentReference)

If PdfSignaturePagePreferences.getReturnDocumentReference() is true the updated document will be returned as a reference instead of via a PreparedPdfDocument.getUpdatedPdfDocument() call. The reason for using document references is that a potentially heavy document only has to be uploaded once. Later when including the document in a call to SignServiceIntegrationService.createSignRequest(se.idsec.signservice.integration.SignRequestInput) the reference is set in TbsDocument.setContentReference(String).

Note: If document references are used a reference is set in all cases (even if no update of the document was necessary).

Parameters:

updatedPdfDocumentReference - reference to the updated document

Returns:

this.

visiblePdfSignatureRequirement

public PreparedPdfDocument.PreparedPdfDocumentBuilder visiblePdfSignatureRequirement(VisiblePdfSignatureRequirement visiblePdfSignatureRequirement)

The resulting VisiblePdfSignatureRequirement object that should be passed as a property in the TbsDocument holding the PDF document that is passed to SignServiceIntegrationService.createSignRequest(se.idsec.signservice.integration.SignRequestInput).

Parameters:

visiblePdfSignatureRequirement - a VisiblePdfSignatureRequirement object to be used in a TbsDocument for the PDF document that is about to be signed with a signature image

Returns:

this.

extension

public PreparedPdfDocument.PreparedPdfDocumentBuilder extension(Extension extension)

Extensions for the object.

Returns:

this.

build

public PreparedPdfDocument build()

Description copied from interface: ObjectBuilder

Builds the object.

Specified by:

build in interface ObjectBuilder<PreparedPdfDocument>

Returns:

the object

toString

public String toString()

Overrides:

toString in class Object