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

Class PreparedPdfDocument

java.lang.Object

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

All Implemented Interfaces:

Serializable, Extensible

public class PreparedPdfDocument
extends Object
implements Extensible

The PreparedPdfDocument is the representation of the object that is returned from ExtendedSignServiceIntegrationService.preparePdfSignaturePage(String, byte[], PdfSignaturePagePreferences). The preparePdfSignaturePage method is used to setup a PDF document along with its visible signature requirements (VisiblePdfSignatureRequirement) before SignServiceIntegrationService.createSignRequest(se.idsec.signservice.integration.SignRequestInput) is called.

Author:

Martin Lindström (martin@idsec.se), Stefan Santesson (stefan@idsec.se)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PreparedPdfDocument.PreparedPdfDocumentBuilder	Builder for PreparedPdfDocument objects.

Constructor Summary

Constructors

Constructor	Description
PreparedPdfDocument()
PreparedPdfDocument(String policy, String updatedPdfDocument, String updatedPdfDocumentReference, VisiblePdfSignatureRequirement visiblePdfSignatureRequirement, Extension extension)

Method Summary

Modifier and Type	Method	Description
static PreparedPdfDocument.PreparedPdfDocumentBuilder	builder()
Extension	getExtension()	Returns the extension parameters for the instance.
String	getPolicy()	The policy under which the data held in this class may be used.
String	getUpdatedPdfDocument()	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).
String	getUpdatedPdfDocumentReference()	If PdfSignaturePagePreferences.getReturnDocumentReference() is true the updated document will be returned as a reference instead of via a getUpdatedPdfDocument() call.
VisiblePdfSignatureRequirement	getVisiblePdfSignatureRequirement()	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).
void	setExtension(Extension extension)	Assigns the extension parameters for the instance.
void	setPolicy(String policy)	The policy under which the data held in this class may be used.
void	setUpdatedPdfDocument(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).
void	setUpdatedPdfDocumentReference(String updatedPdfDocumentReference)	If PdfSignaturePagePreferences.getReturnDocumentReference() is true the updated document will be returned as a reference instead of via a getUpdatedPdfDocument() call.
void	setVisiblePdfSignatureRequirement(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).
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface se.idsec.signservice.integration.core.Extensible

addExtensionValue, getExtensionValue

Constructor Details

PreparedPdfDocument

public PreparedPdfDocument()

PreparedPdfDocument

public PreparedPdfDocument(String policy,
 String updatedPdfDocument,
 String updatedPdfDocumentReference,
 VisiblePdfSignatureRequirement visiblePdfSignatureRequirement,
 Extension extension)

Method Details

getExtension

public Extension getExtension()

Returns the extension parameters for the instance.

Specified by:

getExtension in interface Extensible

Returns:

the extension, or null if no extensions are set

setExtension

public void setExtension(Extension extension)

Assigns the extension parameters for the instance.

Specified by:

setExtension in interface Extensible

Parameters:

extension - the extension

builder

public static PreparedPdfDocument.PreparedPdfDocumentBuilder builder()

toString

public String toString()

Overrides:

toString in class Object

setPolicy

public void setPolicy(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

getPolicy

public String getPolicy()

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).

Returns:

the policy

setUpdatedPdfDocument

public void setUpdatedPdfDocument(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 getUpdatedPdfDocumentReference().

Parameters:

updatedPdfDocument - updated PDF document (in Base64 encoded form)

getUpdatedPdfDocument

public String getUpdatedPdfDocument()

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 getUpdatedPdfDocumentReference().

Returns:

the updated PDF document (in Base64 encoded form) or null if the initial PDF document was not updated or if document references are used

setUpdatedPdfDocumentReference

public void setUpdatedPdfDocumentReference(String updatedPdfDocumentReference)

If PdfSignaturePagePreferences.getReturnDocumentReference() is true the updated document will be returned as a reference instead of via a 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

getUpdatedPdfDocumentReference

public String getUpdatedPdfDocumentReference()

If PdfSignaturePagePreferences.getReturnDocumentReference() is true the updated document will be returned as a reference instead of via a 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).

Returns:

reference to the updated document or null

setVisiblePdfSignatureRequirement

public void setVisiblePdfSignatureRequirement(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

getVisiblePdfSignatureRequirement

public VisiblePdfSignatureRequirement getVisiblePdfSignatureRequirement()

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).

Returns:

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