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

Class VisiblePdfSignatureRequirement

java.lang.Object

se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation

se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement

All Implemented Interfaces:

Serializable, Extensible

public class VisiblePdfSignatureRequirement
extends VisiblePdfSignatureUserInformation

Class that represents the requirement for including a visible indication stating that a PDF document has been signed, and by whom.

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	VisiblePdfSignatureRequirement.VisiblePdfSignatureRequirementBuilder	Builder for VisiblePdfSignatureRequirement objects.

Nested classes/interfaces inherited from class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation

VisiblePdfSignatureUserInformation.SignerName, VisiblePdfSignatureUserInformation.VisiblePdfSignatureUserInformationBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NULL_INDICATOR_EXTENSION	Constant for an extension that denotes a "null" visible PDF signature requirement.

Fields inherited from class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation

extension

Constructor Summary

Constructors

Constructor	Description
VisiblePdfSignatureRequirement()
VisiblePdfSignatureRequirement(String templateImageRef, Integer xPosition, Integer yPosition, Integer scale, Integer page)
VisiblePdfSignatureRequirement(VisiblePdfSignatureUserInformation userInformation)	Constructor that accepts a VisiblePdfSignatureUserInformation object and initializes the properties from this object.
VisiblePdfSignatureRequirement(VisiblePdfSignatureUserInformation.SignerName signerName, Map<String,String> fieldValues, Extension extension, String templateImageRef, Integer xPosition, Integer yPosition, Integer scale, Integer page)

Method Summary

Modifier and Type	Method	Description
static VisiblePdfSignatureRequirement.VisiblePdfSignatureRequirementBuilder	builder()
static VisiblePdfSignatureRequirement	createNullVisiblePdfSignatureRequirement()	Creates a "null" visible PDF signature requirement.
Integer	getPage()	The number of the page where the visible signature should appear.
Integer	getScale()	The scale of the final visible signature image expressed as zoom percentage.
String	getTemplateImageRef()	A unique reference of the template image that should be by the SignService Integration Service when generating a PDF visible signature.
Integer	getXPosition()	The X coordinate position (in pixels) of the PDF visible signature image in the PDF document.
Integer	getYPosition()	The Y coordinate position (in pixels) of the PDF visible signature image in the PDF document.
void	setPage(Integer page)	The number of the page where the visible signature should appear.
void	setScale(Integer scale)	The scale of the final visible signature image expressed as zoom percentage.
void	setTemplateImageRef(String templateImageRef)	A unique reference of the template image that should be by the SignService Integration Service when generating a PDF visible signature.
void	setXPosition(Integer xPosition)	The X coordinate position (in pixels) of the PDF visible signature image in the PDF document.
void	setYPosition(Integer yPosition)	The Y coordinate position (in pixels) of the PDF visible signature image in the PDF document.
String	toString()

Methods inherited from class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation

getExtension, getFieldValues, getSignerName, setExtension, setFieldValues, setSignerName, toBuilder

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

Field Details

NULL_INDICATOR_EXTENSION

public static final String NULL_INDICATOR_EXTENSION

Constant for an extension that denotes a "null" visible PDF signature requirement.

See Also:

• Constant Field Values

Constructor Details

VisiblePdfSignatureRequirement

public VisiblePdfSignatureRequirement(VisiblePdfSignatureUserInformation.SignerName signerName,
 Map<String,String> fieldValues,
 Extension extension,
 String templateImageRef,
 Integer xPosition,
 Integer yPosition,
 Integer scale,
 Integer page)

VisiblePdfSignatureRequirement

public VisiblePdfSignatureRequirement(VisiblePdfSignatureUserInformation userInformation)

Constructor that accepts a VisiblePdfSignatureUserInformation object and initializes the properties from this object.

Parameters:

userInformation - a VisiblePdfSignatureUserInformation object

VisiblePdfSignatureRequirement

public VisiblePdfSignatureRequirement()

VisiblePdfSignatureRequirement

public VisiblePdfSignatureRequirement(String templateImageRef,
 Integer xPosition,
 Integer yPosition,
 Integer scale,
 Integer page)

Method Details

createNullVisiblePdfSignatureRequirement

public static VisiblePdfSignatureRequirement createNullVisiblePdfSignatureRequirement()

Creates a "null" visible PDF signature requirement. This may be used in cases where the signature policy that is being used has a default visible PDF signature requirement (see IntegrationServiceDefaultConfiguration.getDefaultVisiblePdfSignatureRequirement()) but we, for some reason, don't want to apply this.

Returns:

a VisiblePdfSignatureRequirement instance with the extension value "nullVisiblePdfSignatureRequirement" set to true

builder

public static VisiblePdfSignatureRequirement.VisiblePdfSignatureRequirementBuilder builder()

toString

public String toString()

Overrides:

toString in class VisiblePdfSignatureUserInformation

getTemplateImageRef

public String getTemplateImageRef()

A unique reference of the template image that should be by the SignService Integration Service when generating a PDF visible signature. See PdfSignatureImageTemplate.

Returns:

the unique reference of the image template

setTemplateImageRef

public void setTemplateImageRef(String templateImageRef)

A unique reference of the template image that should be by the SignService Integration Service when generating a PDF visible signature. See PdfSignatureImageTemplate.

Parameters:

templateImageRef - the unique reference of the image template

getXPosition

public Integer getXPosition()

The X coordinate position (in pixels) of the PDF visible signature image in the PDF document.

Returns:

the X coordinate position (in pixels)

setXPosition

public void setXPosition(Integer xPosition)

The X coordinate position (in pixels) of the PDF visible signature image in the PDF document.

Parameters:

xPosition - the X coordinate position (in pixels)

getYPosition

public Integer getYPosition()

The Y coordinate position (in pixels) of the PDF visible signature image in the PDF document.

Returns:

the Y coordinate position (in pixels)

setYPosition

public void setYPosition(Integer yPosition)

The Y coordinate position (in pixels) of the PDF visible signature image in the PDF document.

Parameters:

yPosition - the Y coordinate position (in pixels)

getScale

public Integer getScale()

The scale of the final visible signature image expressed as zoom percentage. The value -100 represents a 0 sized image, the value 0 represents unaltered size, the value 100 double size and so on. If null, 0 is assumed.

Returns:

the scale of the final visible signature image

setScale

public void setScale(Integer scale)

The scale of the final visible signature image expressed as zoom percentage. The value -100 represents a 0 sized image, the value 0 represents unaltered size, the value 100 double size and so on. If null, 0 is assumed.

Parameters:

scale - the scale of the final visible signature image

getPage

public Integer getPage()

The number of the page where the visible signature should appear. A value of 1 represents the first page and a value of 0 (or null) represents the last page.

Returns:

the page where the visible signature should appear

setPage

public void setPage(Integer page)

The number of the page where the visible signature should appear. A value of 1 represents the first page and a value of 0 (or null) represents the last page.

Parameters:

page - the page where the visible signature should appear