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

Class VisiblePdfSignatureUserInformation

java.lang.Object

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

All Implemented Interfaces:

Serializable, Extensible

Direct Known Subclasses:

VisiblePdfSignatureRequirement

public class VisiblePdfSignatureUserInformation
extends Object
implements Extensible, Serializable

Representation of the user information that is injected into a PDF signature image.

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	VisiblePdfSignatureUserInformation.SignerName	Class representing the input needed to display the signer name in a visible PDF signature.
static class	VisiblePdfSignatureUserInformation.VisiblePdfSignatureUserInformationBuilder	Builder for VisiblePdfSignatureUserInformation objects.

Field Summary

Fields

Modifier and Type	Field	Description
protected Extension	extension	Extensions for the object.

Constructor Summary

Constructors

Constructor	Description
VisiblePdfSignatureUserInformation()
VisiblePdfSignatureUserInformation(VisiblePdfSignatureUserInformation.SignerName signerName, Map<String,String> fieldValues, Extension extension)

Method Summary

Modifier and Type	Method	Description
Extension	getExtension()	Returns the extension parameters for the instance.
Map<String,String>	getFieldValues()	Apart from the signer name and signing date, a template may use other fields.
VisiblePdfSignatureUserInformation.SignerName	getSignerName()	Gets the name of the signer to be represented in the visible image.
void	setExtension(Extension extension)	Assigns the extension parameters for the instance.
void	setFieldValues(Map<String,String> fieldValues)	Apart from the signer name and signing date, a template may use other fields.
void	setSignerName(VisiblePdfSignatureUserInformation.SignerName signerName)	Assigns the name of the signer to be represented in the visible image.
static VisiblePdfSignatureUserInformation.VisiblePdfSignatureUserInformationBuilder	toBuilder()
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

Field Details

extension

protected Extension extension

Extensions for the object.

Constructor Details

VisiblePdfSignatureUserInformation

public VisiblePdfSignatureUserInformation()

VisiblePdfSignatureUserInformation

public VisiblePdfSignatureUserInformation(VisiblePdfSignatureUserInformation.SignerName signerName,
 Map<String,String> fieldValues,
 Extension extension)

Method Details

getSignerName

public VisiblePdfSignatureUserInformation.SignerName getSignerName()

Gets the name of the signer to be represented in the visible image. This is typically a name of the signer but any suitable identity attribute value may be specified to be part of the signer name. This value is analogous to, and should hold the same value as, a present Name entry in the PDF signature dictionary. If the image template referenced requires a value for signerName, this field is mandatory, otherwise it is optional.

Returns:

the signer name

setSignerName

public void setSignerName(VisiblePdfSignatureUserInformation.SignerName signerName)

Assigns the name of the signer to be represented in the visible image. This is typically a name of the signer but any suitable identity attribute value may be specified to be part of the signer name. This value is analogous to, and should hold the same value as, a present Name entry in the PDF signature dictionary. If the image template referenced requires a value for signerName, this field is mandatory, otherwise it is optional.

Parameters:

signerName - the signer name

getFieldValues

public Map<String,String> getFieldValues()

Apart from the signer name and signing date, a template may use other fields. This map provides the requested fields and values.

Returns:

a map of fields and their values

setFieldValues

public void setFieldValues(Map<String,String> fieldValues)

Apart from the signer name and signing date, a template may use other fields. This map provides the requested fields and values.

Parameters:

fieldValues - a map of fields and their values

setExtension

public void setExtension(Extension extension)

Assigns the extension parameters for the instance.

Specified by:

setExtension in interface Extensible

Parameters:

extension - the extension

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

toBuilder

public static VisiblePdfSignatureUserInformation.VisiblePdfSignatureUserInformationBuilder toBuilder()

toString

public String toString()

Overrides:

toString in class Object