Class VisiblePdfSignatureUserInformation
java.lang.Object
se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation
- All Implemented Interfaces:
Serializable
,Extensible
- Direct Known Subclasses:
VisiblePdfSignatureRequirement
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Class representing the input needed to display the signer name in a visible PDF signature.static class
Builder forVisiblePdfSignatureUserInformation
objects. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the extension parameters for the instance.Apart from the signer name and signing date, a template may use other fields.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
Assigns the name of the signer to be represented in the visible image.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface se.idsec.signservice.integration.core.Extensible
addExtensionValue, getExtensionValue
-
Field Details
-
extension
Extensions for the object.
-
-
Constructor Details
-
VisiblePdfSignatureUserInformation
public VisiblePdfSignatureUserInformation()
-
-
Method Details
-
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
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
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
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
Assigns the extension parameters for the instance.- Specified by:
setExtension
in interfaceExtensible
- Parameters:
extension
- the extension
-
getExtension
Returns the extension parameters for the instance.- Specified by:
getExtension
in interfaceExtensible
- Returns:
- the extension, or
null
if no extensions are set
-