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

Class VisiblePdfSignatureUserInformation.SignerName

java.lang.Object

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

All Implemented Interfaces:

Serializable

Enclosing class:

VisiblePdfSignatureUserInformation

public static class VisiblePdfSignatureUserInformation.SignerName
extends Object
implements Serializable

Class representing the input needed to display the signer name in a visible PDF signature.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VisiblePdfSignatureUserInformation.SignerName.SignerNameBuilder	Builder for SignerName objects.

Constructor Summary

Constructors

Constructor	Description
SignerName()
SignerName(List<SignerIdentityAttribute> signerAttributes, String formatting)

Method Summary

Modifier and Type	Method	Description
static VisiblePdfSignatureUserInformation.SignerName.SignerNameBuilder	builder()
String	getFormatting()	Gets the string the may be supplied to change how the signer's information is displayed.
List<SignerIdentityAttribute>	getSignerAttributes()	Gets the list of attribute names that refer to some, or all, attributes supplied in AuthnRequirements.setRequestedSignerAttributes(List) that are the requirements that the signer requires to be validated as part of the signature operation.
void	setFormatting(String formatting)	Assigns the string the may be supplied to change how the signer's information is displayed.
void	setSignerAttributes(List<SignerIdentityAttribute> signerAttributes)	Assigns the list of attribute names that refer to some, or all, attributes supplied in AuthnRequirements.setRequestedSignerAttributes(List) that are the requirements that the signer requires to be validated as part of the signature operation.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SignerName

public SignerName()

SignerName

public SignerName(List<SignerIdentityAttribute> signerAttributes,
 String formatting)

Method Details

getSignerAttributes

public List<SignerIdentityAttribute> getSignerAttributes()

Gets the list of attribute names that refer to some, or all, attributes supplied in AuthnRequirements.setRequestedSignerAttributes(List) that are the requirements that the signer requires to be validated as part of the signature operation. The values of the given attributes will be part of the signer name field as they appear in the list (separated by a blank). It is possible to change how the information is displayed by assigning a formatting, see setFormatting(String).

Returns:

a list of attribute names whose values should be used to display the signer name in the visible PDF signature

setSignerAttributes

public void setSignerAttributes(List<SignerIdentityAttribute> signerAttributes)

Assigns the list of attribute names that refer to some, or all, attributes supplied in AuthnRequirements.setRequestedSignerAttributes(List) that are the requirements that the signer requires to be validated as part of the signature operation. The values of the given attributes will be part of the signer name field as they appear in the list (separated by a blank). It is possible to change how the information is displayed by assigning a formatting, see setFormatting(String).

Parameters:

signerAttributes - a list of attribute names whose values should be used to display the signer name in the visible PDF signature

getFormatting

public String getFormatting()

Gets the string the may be supplied to change how the signer's information is displayed. Each list item from getSignerAttributes() is referenced by its order (starting from 0) and prefixed by %. For example, the formatting string "%1 %2 (%3)" may display something like Jim Smith (ID12345).

Returns:

the formatting string or null

setFormatting

public void setFormatting(String formatting)

Assigns the string the may be supplied to change how the signer's information is displayed. Each list item from getSignerAttributes() is referenced by its order (starting from 0) and prefixed by %. For example, the formatting string "%1 %2 (%3)" may display something like Jim Smith (ID12345).

Parameters:

formatting - the formatting string

builder

public static VisiblePdfSignatureUserInformation.SignerName.SignerNameBuilder builder()

toString

public String toString()

Overrides:

toString in class Object