Serialized Form
-
Package se.idsec.signservice.integration
-
Class se.idsec.signservice.integration.SignatureResult
class SignatureResult extends Object implements Serializable-
Serialized Fields
-
correlationId
String correlationId
The correlation ID. This is the ID that is used in all logging events. -
extension
Extension extension
Extensions for the object. -
id
String id
The ID for the signature operation. This ID corresponds to the RequestID of the SignRequest and SignResponse. -
signedDocuments
List<SignedDocument> signedDocuments
The signed documents. -
signerAssertionInformation
SignerAssertionInformation signerAssertionInformation
Contains information about the signer's "authentication for signature" that was part of the signature operation.
-
-
-
Class se.idsec.signservice.integration.SignRequestData
class SignRequestData extends Object implements Serializable-
Serialized Fields
-
binding
String binding
The identifier for the binding of the message that is to be sent. -
destinationUrl
String destinationUrl
The signature service URL to which the SignRequest should be posted. -
extension
Extension extension
Extensions for the object. -
relayState
String relayState
The relay state. -
signRequest
String signRequest
The Base64-encoded SignRequest message that is to be posted to the signature service. -
state
SignatureState state
State for a signature operation.
-
-
-
Class se.idsec.signservice.integration.SignRequestInput
class SignRequestInput extends Object implements Serializable-
Serialized Fields
-
authnRequirements
AuthnRequirements authnRequirements
The requirements that the sign requester has on the principal that is to perform the signature operation. -
certificateRequirements
SigningCertificateRequirements certificateRequirements
The requirements for the signature certificate that will be issued by the sign service. -
correlationId
String correlationId
The correlation ID to use for this process. -
destinationUrl
String destinationUrl
The signature service URL to where SignRequest messages should be posted. -
extension
Extension extension
Extensions for the object. -
policy
String policy
The SignService policy. -
returnUrl
String returnUrl
The URL to which the user agent along with the sign response message should be directed after a signature operation. -
signatureAlgorithm
String signatureAlgorithm
The algorithm identifier for the signature algorithm that should be used to sign the specified documents. -
signMessageParameters
SignMessageParameters signMessageParameters
The sign message parameters that is used to build the sign message element that is included in the SignRequest. -
signRequesterID
String signRequesterID
The entityID of the entity that requests a signature. -
tbsDocuments
List<TbsDocument> tbsDocuments
The document(s) to be signed along with a per document signing requirements and parameters.
-
-
-
Exception se.idsec.signservice.integration.SignResponseCancelStatusException
class SignResponseCancelStatusException extends SignResponseErrorStatusException implements Serializable -
Exception se.idsec.signservice.integration.SignResponseErrorStatusException
class SignResponseErrorStatusException extends Exception implements Serializable -
Class se.idsec.signservice.integration.SignResponseProcessingParameters
class SignResponseProcessingParameters extends Object implements Serializable-
Serialized Fields
-
extension
Extension extension
Extensions for the object. -
xmlSignatureLocation
XMLSignatureLocation xmlSignatureLocation
If an XML document is signed, the caller has the possibility to control where in the document theds:Signature
element should be inserted. Ifnull
, the signature element will be inserted as the last child of the document root element.
-
-
-
-
Package se.idsec.signservice.integration.authentication
-
Class se.idsec.signservice.integration.authentication.AuthnRequirements
class AuthnRequirements extends Object implements Serializable-
Serialized Fields
-
authnContextClassRefs
List<String> authnContextClassRefs
The authentication context reference identifier(s) (URI(s)) that identifies the context under which the signer should be authenticated. This identifier is often referred to as the "level of assurance" (LoA). -
authnProfile
String authnProfile
An opaque string that can be used to inform the Signing Service about specific requirements regarding the user authentication at the given Identity Provider. -
authnServiceID
String authnServiceID
The entityID of the authentication service (Identity Provider) that will authenticate the signer as part of the signature process. -
extension
Extension extension
Extensions for the object. -
requestedSignerAttributes
List<SignerIdentityAttributeValue> requestedSignerAttributes
A list of identity attribute values that the sign requestor requires the authentication service (IdP) to validate and deliver (and the signature service to assert).
-
-
-
Class se.idsec.signservice.integration.authentication.SignerAssertionInformation
class SignerAssertionInformation extends Object implements Serializable-
Serialized Fields
-
assertion
String assertion
The assertion issued for the user's "authentication for signature" operation (in Base64 encoded format). -
assertionReference
String assertionReference
Contains the unique ID of the assertion issued for the user's "authentication for signature" operation. -
authnContextRef
String authnContextRef
The authentication context reference identifier (an URI) that identifies the context under which the signer was authenticated. -
authnInstant
long authnInstant
The time (in millis since epoch) when the SignService authenticated the signer. -
authnServiceID
String authnServiceID
The entityID of the authentication service (Identity Provider) that will authenticated the signer as part of the signature process. -
authnType
String authnType
An optional identifier of the type of authentication that was used for the "authentication for signature" operation, e.g. "saml". -
extension
Extension extension
Extensions for the object. -
signerAttributes
List<SignerIdentityAttributeValue> signerAttributes
Identity attributes for the signer.
-
-
-
Class se.idsec.signservice.integration.authentication.SignerIdentityAttribute
class SignerIdentityAttribute extends AbstractIdentityAttribute implements Serializable -
Class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue
class SignerIdentityAttributeValue extends SignerIdentityAttribute implements Serializable-
Serialized Fields
-
attributeValueType
String attributeValueType
The type for the attribute value. When SAML attributes are represented, this holds the XSI type without the namespace prefix. -
nameFormat
String nameFormat
The name format for the attribute. -
value
String value
The attribute value (in its string representation).
-
-
-
-
Package se.idsec.signservice.integration.certificate
-
Class se.idsec.signservice.integration.certificate.CertificateAttributeMapping
class CertificateAttributeMapping extends Object implements Serializable-
Serialized Fields
-
destination
RequestedCertificateAttribute destination
The requested destination attribute gives information about which type of certificate attribute to create, and possibly its default value. -
sources
List<SignerIdentityAttribute> sources
A list of signer source attributes from where the sign service gets information in order to create the requested certificate attribute.
-
-
-
Class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
class RequestedCertificateAttribute extends AbstractIdentityAttribute implements Serializable -
Class se.idsec.signservice.integration.certificate.SigningCertificateRequirements
class SigningCertificateRequirements extends Object implements Serializable-
Serialized Fields
-
attributeMappings
List<CertificateAttributeMapping> attributeMappings
Defines mappings between the signer's authentication attributes and attributes that are to be placed in the issued signature certificate. -
certificateType
CertificateType certificateType
The requested certificate type. -
extension
Extension extension
Extensions for the object.
-
-
-
-
Package se.idsec.signservice.integration.config
-
Exception se.idsec.signservice.integration.config.PolicyNotFoundException
class PolicyNotFoundException extends BadRequestException implements Serializable
-
-
Package se.idsec.signservice.integration.core
-
Class se.idsec.signservice.integration.core.AbstractIdentityAttribute
class AbstractIdentityAttribute extends Object implements Serializable -
Class se.idsec.signservice.integration.core.Extension
-
Class se.idsec.signservice.integration.core.FileResource
class FileResource extends Object implements Serializable-
Serialized Fields
-
contents
String contents
The base64 encoded contents of the file resource. -
description
String description
Optional descriptive string for the file resource. -
eagerlyLoadContents
boolean eagerlyLoadContents
If theDefaultFileResource
object is initialized by a resource string the object can function in two modes; it either loads the contents directly when the object is created usingFileResource.afterPropertiesSet()
(eagerlyLoadContents = true
), or it loads the contents every time it is asked for (eagerlyLoadContents = false
). The latter is the default and should be used if large documents that are assigned to several configuration objects are handled. This will prevent a heavy memory usage at the cost of speed in fetching the document contents. -
resource
String resource
The resource string for the file/resource.
-
-
-
Class se.idsec.signservice.integration.core.RestClientSignatureState
class RestClientSignatureState extends Object implements Serializable-
Serialized Fields
-
id
String id
The signature operation ID. -
state
LinkedHashMap<String,
?> state The session state.
-
-
-
-
Package se.idsec.signservice.integration.core.error
-
Exception se.idsec.signservice.integration.core.error.BadRequestException
class BadRequestException extends SignServiceIntegrationCategoryException implements Serializable -
Class se.idsec.signservice.integration.core.error.ErrorCode
class ErrorCode extends Object implements Serializable -
Exception se.idsec.signservice.integration.core.error.InputValidationException
class InputValidationException extends BadRequestException implements Serializable -
Exception se.idsec.signservice.integration.core.error.NoAccessException
class NoAccessException extends SignServiceIntegrationException implements Serializable -
Exception se.idsec.signservice.integration.core.error.SignServiceIntegrationCategoryException
class SignServiceIntegrationCategoryException extends SignServiceIntegrationException implements Serializable -
Class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
class SignServiceIntegrationErrorBody extends Object implements Serializable-
Serialized Fields
-
dssError
SignServiceIntegrationErrorBody.DssError dssError
DSS error details. -
errorCode
String errorCode
The error code. -
exceptionClass
String exceptionClass
The name of the exception class that was thrown for this error. -
message
String message
The error message. -
path
String path
The requested path. -
status
int status
The HTTP status code. -
timestamp
long timestamp
The timestamp as milliseconds since epoch. -
validationError
SignServiceIntegrationErrorBody.ValidationError validationError
Validation error details.
-
-
-
Class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.DssError
class DssError extends Object implements Serializable -
Class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.ValidationError
class ValidationError extends Object implements Serializable -
Exception se.idsec.signservice.integration.core.error.SignServiceIntegrationException
class SignServiceIntegrationException extends Exception implements Serializable-
Serialized Fields
-
errorCode
ErrorCode errorCode
The error code for this exception.
-
-
-
-
Package se.idsec.signservice.integration.document
-
Class se.idsec.signservice.integration.document.SignedDocument
class SignedDocument extends Object implements Serializable-
Serialized Fields
-
extension
Extension extension
Extensions for the object. -
id
String id
The unique ID for this document (within the current operation). -
mimeType
String mimeType
The MIME type of the signed document. SeeDocumentType
for the supported types. -
signedContent
String signedContent
The signed document as a Base64-encoded byte string.
-
-
-
Class se.idsec.signservice.integration.document.TbsDocument
class TbsDocument extends Object implements Serializable-
Serialized Fields
-
adesRequirement
TbsDocument.EtsiAdesRequirement adesRequirement
Specifies of the resulting signature should use an ETSI AdES format. -
content
String content
The Base64-encoded byte string that is the content of the document that is to be signed. -
contentReference
String contentReference
A content reference may be used instead of supplying the actual content (TbsDocument.setContent(String)
). This is typically something that is useful when handling large documents. However, this feature is only useable if:- The SignService Integration Service profile is in "stateful mode", and,
- the document has previously been cached by the SignService Integration Service.
Typically, this is used if the SignService Integration Service is running as a standalone service. When using the API as an integrated Java library in the service it makes less sense.
-
extension
Extension extension
Extensions for the object. -
id
String id
The unique ID for this document (within the current request). If not supplied, the SignService Integration Service will generate one. -
mimeType
String mimeType
The MIME type of the document that is to be signed. SeeDocumentType
for the supported types. -
processingRules
String processingRules
Optional processing rules used by the sign service to process sign data. -
visiblePdfSignatureRequirement
VisiblePdfSignatureRequirement visiblePdfSignatureRequirement
If the document that is to be signed is a PDF document, the sign requester may require the resulting PDF to have a "visible PDF signature". TheVisiblePdfSignatureRequirement
specifies how this visible indication should be included.Note that a signature policy may have a default visible PDF signature requirement configued, which means that the
visiblePdfSignatureRequirement
does not have to be assigned, unless the signature policy default should be overridden. For the special case where a signature policy has a default requirement configured, and the caller does not want a visible PDF signature to be included at all, anVisiblePdfSignatureRequirement
instance with an extensionVisiblePdfSignatureRequirement.NULL_INDICATOR_EXTENSION
set totrue
should be assigned (seeVisiblePdfSignatureRequirement.createNullVisiblePdfSignatureRequirement()
).
-
-
-
Class se.idsec.signservice.integration.document.TbsDocument.EtsiAdesRequirement
class EtsiAdesRequirement extends Object implements Serializable- serialVersionUID:
- 3139149873709105674L
-
Serialized Fields
-
adesFormat
TbsDocument.AdesType adesFormat
The ETSI AdES type. -
adesObject
String adesObject
Optional AdES object as an Base64-encoded byte array.For XML signatures this object must be a
ds:Object
having as its only child axades:QualifyingProperties
element. -
extension
Extension extension
Extensions for the object. -
signaturePolicy
String signaturePolicy
The signature policy (required for EPES).
-
-
-
Package se.idsec.signservice.integration.document.pdf
-
Class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
class PdfSignatureImageTemplate extends Object implements Serializable-
Serialized Fields
-
extension
Extension extension
Extensions for the object. -
fields
Map<String,
String> fields A map of the field names that are required by the template in the fieldName map inVisiblePdfSignatureRequirement
. -
height
Integer height
The height (in pixels) for the pixel image that is generated from the template (and inserted into the PDF visible signature flow). -
includeSignerName
boolean includeSignerName
Flag telling whether the signer name will be included in the visible PDF signature. -
includeSigningTime
boolean includeSigningTime
Flag telling whether the signing time will be included in the visible PDF signature. -
reference
String reference
The unique reference for this image template. -
svgImageFile
FileResource svgImageFile
SVG image file that holds up the image template. -
width
Integer width
The width (in pixels) for the pixel image that is generated from the template (and inserted into the PDF visible signature flow).
-
-
-
Class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
class PdfSignaturePage extends Object implements Serializable-
Serialized Fields
-
columns
Integer columns
If it should be possible to add PDF sign images in several columns to this sign page document thecolumns
attribute should assigned to the desired number of columns. The default is1
. -
extension
Extension extension
Extensions for the object. -
id
String id
The unique ID for this PDF signature page. -
imagePlacementConfiguration
PdfSignaturePage.PdfSignatureImagePlacementConfiguration imagePlacementConfiguration
Configuration that tells where in the PDF signature page the PDF signature image(s) should be inserted. -
pdfDocument
FileResource pdfDocument
The file resource containing the PDF document that holds the PDF signature page. -
rows
Integer rows
If it should be possible to add PDF sign images in several rows to this sign page document therows
attribute should assigned to the desired number of rows. The default is1
. -
signatureImageReference
String signatureImageReference
A unique reference of the signature template image that is inserted into this PDF signature page. SeePdfSignatureImageTemplate
.
-
-
-
Class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
class PdfSignatureImagePlacementConfiguration extends Object implements Serializable-
Serialized Fields
-
extension
Extension extension
Extensions for the object. -
page
Integer page
If the PDF signature page document (seePdfSignaturePage.getContents()
) contains more than one page it is possible to use thepage
attribute to tell where the PDF signature image(s) should be inserted. A value of 1 represents the first page and a value of 0 represents the last page. The default is1
.Note: It is only possible to have PDF signature images inserted into one page of the PDF signature page document.
-
scale
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. Ifnull
, 0 is assumed. -
xIncrement
Integer xIncrement
If the PDF signature page supports more than one column (seePdfSignaturePage.getColumns()
) thexIncrement
property tells how many pixels that should be added to the previously usedxPosition
when inserting a PDF signature image in a new column.Note: If the PDF signature page only supports one column this property is ignored.
-
xPosition
Integer xPosition
The X coordinate position (in pixels) of where the first PDF visible signature image should be inserted on the PDF signature page. -
yIncrement
Integer yIncrement
If the PDF signature page supports more than one row (seePdfSignaturePage.getRows()
) theyIncrement
property tells how many pixels that should be added to the previously usedyPosition
when inserting a PDF signature image in a new row.Note: If the PDF signature page only supports one row this property is ignored.
-
yPosition
Integer yPosition
The Y coordinate position (in pixels) of where the first PDF visible signature image should be inserted on the PDF signature page.
-
-
-
Exception se.idsec.signservice.integration.document.pdf.PdfSignaturePageFullException
class PdfSignaturePageFullException extends SignServiceIntegrationException implements Serializable -
Class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
class PdfSignaturePagePreferences extends Object implements Serializable-
Serialized Fields
-
existingSignaturePageNumber
Integer existingSignaturePageNumber
In the cases where a PDF document already has been signed and a signature page has been inserted, and another signature image is to be added to this page, the caller may use theexistingSignaturePageNumber
property to inform the Sign Service support service about the document page number of the sign page. This page number corresponds to theVisiblePdfSignatureRequirement.getPage()
property from the initial call.If not set, the Sign Service support service will have to calculate the page number based on the
insertPageAt
property andsignaturePageReference
/signaturePage
. -
extension
Extension extension
Extensions for the object. -
failWhenSignPageFull
boolean failWhenSignPageFull
APdfSignaturePage
has a limit on how many PDF signature images it can hold (seePdfSignaturePage.getMaxSignatureImages()
). IfExtendedSignServiceIntegrationService.preparePdfSignaturePage(String, byte[], PdfSignaturePagePreferences)
is invoked with a PDF document that contains a number of signature that equals or exceeds the maximum number of allowed signature images (PdfSignaturePage.getMaxSignatureImages()
) for the current PDF signature page thefailWhenSignPageFull
property tells whetherpreparePdfSignaturePage
should fail (PdfSignaturePageFullException
) or whether it should allow proceeding with the signature operation where no PDF signature image is inserted (in that case the resultingPreparedPdfDocument
will contain a "null"VisiblePdfSignatureRequirement
(seeVisiblePdfSignatureRequirement.createNullVisiblePdfSignatureRequirement()
). -
insertPageAt
Integer insertPageAt
Tells where in a PDF document the PDF signature page should be inserted. A value of 1 represents the first page and a value of 0 (ornull
) represents the last page. The last page is the default.Note: If more than one signature image is added to the sign page and
existingSignaturePageNumber
is not set, the value ofinsertPageAt
MUST be the same between all calls. Thus, the value refers to the page number in the original document, before the sign page was added. -
returnDocumentReference
Boolean returnDocumentReference
A setting that tells that a document reference (PreparedPdfDocument.getUpdatedPdfDocumentReference()
) should be returned instead of the updated document itself. Later when the document is passed in a call toSignServiceIntegrationService.createSignRequest(se.idsec.signservice.integration.SignRequestInput)
theTbsDocument.setContentReference(String)
is used instead of adding the entire document. This way a potentially large document only has to be "uploaded" once.A document reference is only returned in the cases when the current SignService Integration policy profile is running in "stateful" mode. It is an error to request a document reference if the policy is stateless.
The default behaviour is that
returnDocumentReference
istrue
if the current policy is stateful andfalse
if it is stateless. -
signaturePage
PdfSignaturePage signaturePage
As an alternative to specifying asignPageReference
(seePdfSignaturePagePreferences.setSignaturePageReference(String)
) the actual sign page can be provided in the preferences.It is an error to specify both
signaturePageReference
andsignaturePage
. If neithersignaturePageReference
orsignaturePage
is given, the default signature page for the policy will be used, and if no signature page has been configured for the policy an error is reported. -
signaturePageReference
String signaturePageReference
Reference to a PDF signature page to be inserted (seePdfSignaturePage.getId()
). This signature page must be configured within the current policy. As an alternative to giving the reference an entirePdfSignaturePage
(seePdfSignaturePagePreferences.setSignaturePage(PdfSignaturePage)
).It is an error to specify both
signaturePageReference
andsignaturePage
. If neithersignaturePageReference
orsignaturePage
is given, the default signature page for the policy will be used, and if no signature page has been configured for the policy an error is reported. -
visiblePdfSignatureUserInformation
VisiblePdfSignatureUserInformation visiblePdfSignatureUserInformation
The input regarding the user information that is to be used when generating aVisiblePdfSignatureRequirement
object. Using the object's values (signer name and other field values) and combining with information regarding the PDF signature image found inPdfSignaturePagePreferences.getSignaturePageReference()
orPdfSignaturePagePreferences.getSignaturePage()
a completeVisiblePdfSignatureRequirement
object can be created.
-
-
-
Class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
class PreparedPdfDocument extends Object implements Serializable-
Serialized Fields
-
extension
Extension extension
Extensions for the object. -
policy
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 toExtendedSignServiceIntegrationService.preparePdfSignaturePage(String, byte[], PdfSignaturePagePreferences)
. -
updatedPdfDocument
String updatedPdfDocument
If the PDF document passed toExtendedSignServiceIntegrationService.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 bypreparePdfSignaturePage
.Note: This property is only assigned if
PdfSignaturePagePreferences.getReturnDocumentReference()
isfalse
. If document references should be used the reference for the updated document is obtained by callingPreparedPdfDocument.getUpdatedPdfDocumentReference()
. -
updatedPdfDocumentReference
String updatedPdfDocumentReference
IfPdfSignaturePagePreferences.getReturnDocumentReference()
istrue
the updated document will be returned as a reference instead of via aPreparedPdfDocument.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 toSignServiceIntegrationService.createSignRequest(se.idsec.signservice.integration.SignRequestInput)
the reference is set inTbsDocument.setContentReference(String)
.Note: If document references are used a reference is set in all cases (even if no update of the document was necessary).
-
visiblePdfSignatureRequirement
VisiblePdfSignatureRequirement visiblePdfSignatureRequirement
The resultingVisiblePdfSignatureRequirement
object that should be passed as a property in theTbsDocument
holding the PDF document that is passed toSignServiceIntegrationService.createSignRequest(se.idsec.signservice.integration.SignRequestInput)
.
-
-
-
Class se.idsec.signservice.integration.document.pdf.PreparePdfSignaturePageInput
class PreparePdfSignaturePageInput extends Object implements Serializable-
Serialized Fields
-
extension
Extension extension
Extensions for the object. -
pdfDocument
String pdfDocument
The contents of the PDF document that is to be prepared in Base64 encoded format. -
signaturePagePreferences
PdfSignaturePagePreferences signaturePagePreferences
The preferences of how to prepare the PDF document for a PDF signature page and signature image.
-
-
-
Class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
class VisiblePdfSignatureRequirement extends VisiblePdfSignatureUserInformation implements Serializable-
Serialized Fields
-
page
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 (ornull
) represents the last page. -
scale
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. Ifnull
, 0 is assumed. -
templateImageRef
String templateImageRef
A unique reference of the template image that should be by the SignService Integration Service when generating a PDF visible signature. SeePdfSignatureImageTemplate
. -
xPosition
Integer xPosition
The X coordinate position (in pixels) of the PDF visible signature image in the PDF document. -
yPosition
Integer yPosition
The Y coordinate position (in pixels) of the PDF visible signature image in the PDF document.
-
-
-
Class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation
class VisiblePdfSignatureUserInformation extends Object implements Serializable-
Serialized Fields
-
extension
Extension extension
Extensions for the object. -
fieldValues
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. -
signerName
VisiblePdfSignatureUserInformation.SignerName signerName
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.
-
-
-
Class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation.SignerName
class SignerName extends Object implements Serializable- serialVersionUID:
- -3259891506238725426L
-
Serialized Fields
-
formatting
String formatting
Optional string the may be supplied to change how the signer's information is displayed. Each list item fromVisiblePdfSignatureUserInformation.SignerName.getSignerAttributes()
is referenced by its order (starting from 0) and prefixed by %. For example, the formatting string"%1 %2 (%3)"
may display something likeJim Smith (ID12345)
. -
signerAttributes
List<SignerIdentityAttribute> signerAttributes
A list of attribute names that refer to some, or all, attributes supplied inAuthnRequirements.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, seeVisiblePdfSignatureUserInformation.SignerName.setFormatting(String)
.
-
-
-
Package se.idsec.signservice.integration.document.xml
-
Class se.idsec.signservice.integration.document.xml.XMLSignatureLocation
class XMLSignatureLocation extends Object implements Serializable-
Serialized Fields
-
-
-
Package se.idsec.signservice.integration.security
-
Class se.idsec.signservice.integration.security.EncryptionParameters.RSAOAEPParameters
class RSAOAEPParameters extends Object implements Serializable
-
-
Package se.idsec.signservice.integration.signmessage
-
Class se.idsec.signservice.integration.signmessage.SignMessageParameters
class SignMessageParameters extends Object implements Serializable-
Serialized Fields
-
displayEntity
String displayEntity
The ID (SAML entityID) of the entity (IdP) that should display this message.Note: The
DisplayEntity
attribute of theSignMessage
element is required if the sign message is to be encrypted. In almost all cases, except for some odd Proxy-IdP cases, this is the same value as the ID that is supplied in the authentication requirements (AuthnRequirements
). Therefore, if this method returnsnull
, and the message should be encrypted, the SignService Integration Service will use theAuthnRequirements.getAuthnServiceID()
value. -
mimeType
String mimeType
The sign message MIME type. SeeSignMessageMimeType
for possible values. -
mustShow
Boolean mustShow
Specifies if the requester of the signature requires that the sign message is displayed to the user. If the Identity Provider cannot fulfill this requirement it must not proceed. -
performEncryption
boolean performEncryption
Tells whether the supplied sign message should be encrypted withSignMessageParameters.getDisplayEntity()
as the recipient. -
signMessage
String signMessage
The sign message (non encrypted) content according to specified mime type.
-
-
-