Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractIdentityAttribute - Class in se.idsec.signservice.integration.core
-
A base class for identity attributes.
- AbstractIdentityAttribute() - Constructor for class se.idsec.signservice.integration.core.AbstractIdentityAttribute
-
Default constructor.
- AbstractIdentityAttribute(String, String) - Constructor for class se.idsec.signservice.integration.core.AbstractIdentityAttribute
-
Constructor setting the type and name.
- addExtensionValue(String, String) - Method in interface se.idsec.signservice.integration.core.Extensible
-
Adds an extension.
- afterPropertiesSet() - Method in class se.idsec.signservice.integration.core.FileResource
-
Checks that the file resource is correctly initialized, and if
eagerlyLoadContents
istrue
it also loads the contents (if necessary). - ApiVersion - Class in se.idsec.signservice.integration
-
Internal class used for representation of the API version.
- ApiVersion() - Constructor for class se.idsec.signservice.integration.ApiVersion
- authnContextRef(String) - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements.AuthnRequirementsBuilder
-
Deprecated.
- AuthnRequirements - Class in se.idsec.signservice.integration.authentication
-
A sign requester specifies a set of authentication requirements regarding the signer when sending a SignRequest message.
- AuthnRequirements() - Constructor for class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Default constructor.
- AuthnRequirements(String, String, List<String>, List<SignerIdentityAttributeValue>, Extension) - Constructor for class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Constructor.
- AuthnRequirements.AuthnRequirementsBuilder - Class in se.idsec.signservice.integration.authentication
-
Builder for
AuthnRequirements
objects. - AuthnRequirementsBuilder() - Constructor for class se.idsec.signservice.integration.authentication.AuthnRequirements.AuthnRequirementsBuilder
B
- BAD_REQUEST_ERROR_CATEGORY - Static variable in exception class se.idsec.signservice.integration.core.error.BadRequestException
-
The identifier for a bad request category.
- BadRequestException - Exception Class in se.idsec.signservice.integration.core.error
-
Class that represents a bad request to the SignService Integration Service.
- BadRequestException(ErrorCode.Code, String) - Constructor for exception class se.idsec.signservice.integration.core.error.BadRequestException
-
Constructor.
- BadRequestException(ErrorCode.Code, String, Throwable) - Constructor for exception class se.idsec.signservice.integration.core.error.BadRequestException
-
Constructor.
- BES - Enum constant in enum class se.idsec.signservice.integration.document.TbsDocument.AdesType
-
ETSI Basic Electronic Signature format
- build() - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute.RequestedCertificateAttributeBuilder
-
Builds the object.
- build() - Method in class se.idsec.signservice.integration.core.Extension.ExtensionBuilder
-
Builds the object.
- build() - Method in interface se.idsec.signservice.integration.core.ObjectBuilder
-
Builds the object.
- builder() - Static method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
-
Returns a builder for
RequestedCertificateAttribute
objects. - builder() - Static method in class se.idsec.signservice.integration.core.Extension
-
Returns a builder for extension builder.
C
- Category() - Constructor for class se.idsec.signservice.integration.core.error.ErrorCode.Category
- CertificateAttributeMapping - Class in se.idsec.signservice.integration.certificate
-
Describes how a signer's identity attribute(s) are mapped to a certificate attribute to be placed in the issued signature certificate.
- CertificateAttributeMapping() - Constructor for class se.idsec.signservice.integration.certificate.CertificateAttributeMapping
-
Default constructor.
- CertificateAttributeMapping(List<SignerIdentityAttribute>, RequestedCertificateAttribute) - Constructor for class se.idsec.signservice.integration.certificate.CertificateAttributeMapping
-
Constructor.
- CertificateAttributeMapping.CertificateAttributeMappingBuilder - Class in se.idsec.signservice.integration.certificate
-
Builder for
CertificateAttributeMapping
objects. - CertificateAttributeMappingBuilder() - Constructor for class se.idsec.signservice.integration.certificate.CertificateAttributeMapping.CertificateAttributeMappingBuilder
- CertificateType - Enum Class in se.idsec.signservice.integration.certificate
-
Representation of the different certificate types that are supported by a SignService.
- childPosition(String) - Method in class se.idsec.signservice.integration.document.xml.XMLSignatureLocation.XMLSignatureLocationBuilder
- childPosition(XMLSignatureLocation.ChildPosition) - Method in class se.idsec.signservice.integration.document.xml.XMLSignatureLocation.XMLSignatureLocationBuilder
- Code() - Constructor for class se.idsec.signservice.integration.core.error.ErrorCode.Code
- ContentLoader - Interface in se.idsec.signservice.integration.core
-
Interface for loading the content from a file resource.
- ContentLoaderSingleton - Class in se.idsec.signservice.integration.core
-
A singleton to be used internally for loading resources.
- createNullVisiblePdfSignatureRequirement() - Static method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Creates a "null" visible PDF signature requirement.
- createSignRequest(SignRequestInput) - Method in interface se.idsec.signservice.integration.SignServiceIntegrationService
- createSignRequest(SignRequestInput, String) - Method in interface se.idsec.signservice.integration.SignServiceIntegrationService
-
Creates a SignRequest message that is to be posted to the signature service.
D
- dateFormat(String) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate.PdfSignatureImageTemplateBuilder
- DEFAULT - Static variable in class se.idsec.signservice.integration.document.pdf.PdfPrepareSettings
-
A
PdfPrepareSettings
with default settings. - DEFAULT_ATTRIBUTE_VALUE_TYPE - Static variable in class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue
-
The default attribute value type to use.
- DEFAULT_BINDING - Static variable in class se.idsec.signservice.integration.SignRequestData
-
The default binding.
- DEFAULT_NAME_FORMAT - Static variable in class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue
-
The default name format to use.
- DEFAULT_POLICY_NAME - Static variable in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
The default policy name.
- DefaultContentLoader - Class in se.idsec.signservice.integration.core
-
A
ContentLoader
that is used to load file resource contents. - DefaultContentLoader() - Constructor for class se.idsec.signservice.integration.core.DefaultContentLoader
-
Constructor.
- defaultValue(String) - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute.RequestedCertificateAttributeBuilder
-
Adds the attribute default value
- DIRECTORY_NAME - Enum constant in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
Directory name
- DNS_NAME - Enum constant in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
DNS name, for example a host name.
- DocumentType - Enum Class in se.idsec.signservice.integration.document
-
Representation of document types (documents for signing).
- DssError() - Constructor for class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.DssError
-
Default constructor.
- DssError(String, String) - Constructor for class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.DssError
-
Constructor.
E
- EDI_PARTY_NAME - Enum constant in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
EDI party name.
- EncryptionParameters - Interface in se.idsec.signservice.integration.security
-
Representation of encryption algorithms to be used when encrypting a sign message for an Identity Provider.
- EncryptionParameters.RSAOAEPParameters - Class in se.idsec.signservice.integration.security
-
Representation of parameters for RSA OAEP key transport algorithm(s).
- EPES - Enum constant in enum class se.idsec.signservice.integration.document.TbsDocument.AdesType
-
ETSI Extended Policy Electronic Signature format
- error(String, String) - Static method in class se.idsec.signservice.integration.core.error.ErrorCode
-
Utility method for creating an
ErrorCode
. - ERROR_CODE - Static variable in exception class se.idsec.signservice.integration.core.error.InputValidationException
-
The error code for this type of error.
- ERROR_CODE - Static variable in exception class se.idsec.signservice.integration.core.error.NoAccessException
-
The error code for this type of error.
- ERROR_CODE_PREFIX - Static variable in class se.idsec.signservice.integration.core.error.ErrorCode
-
Prefix for all errors.
- errorCode - Static variable in exception class se.idsec.signservice.integration.document.pdf.PdfAConsistencyCheckException
-
The error code for this exception.
- errorCode - Static variable in exception class se.idsec.signservice.integration.document.pdf.PdfContainsAcroformException
-
The error code for this exception.
- errorCode - Static variable in exception class se.idsec.signservice.integration.document.pdf.PdfContainsEncryptionDictionaryException
-
The error code for this exception.
- errorCode - Static variable in exception class se.idsec.signservice.integration.document.pdf.PdfSignaturePageFullException
-
The error code for this exception.
- ErrorCode - Class in se.idsec.signservice.integration.core.error
-
When using the SignService Integration Service via a REST API we report errors using error codes (and of course messages).
- ErrorCode() - Constructor for class se.idsec.signservice.integration.core.error.ErrorCode
-
Default constructor.
- ErrorCode(String) - Constructor for class se.idsec.signservice.integration.core.error.ErrorCode
-
Constructor taking a complete error code string on the format "error.category.code".
- ErrorCode(String, String) - Constructor for class se.idsec.signservice.integration.core.error.ErrorCode
-
Constructor taking the category and the code.
- ErrorCode.Category - Class in se.idsec.signservice.integration.core.error
-
A typed category (for use in exceptions).
- ErrorCode.Code - Class in se.idsec.signservice.integration.core.error
-
A typed code (for use in exceptions).
- EtsiAdesRequirement() - Constructor for class se.idsec.signservice.integration.document.TbsDocument.EtsiAdesRequirement
- EtsiAdesRequirementBuilder() - Constructor for class se.idsec.signservice.integration.document.TbsDocument.EtsiAdesRequirement.EtsiAdesRequirementBuilder
- ExtendedSignServiceIntegrationService - Interface in se.idsec.signservice.integration
-
An extension to the interface describing the API for the SignService Integration Service.
- Extensible - Interface in se.idsec.signservice.integration.core
-
Interface that may be inherited for domain objects that should be extensible with name-value pair parameters.
- extension - Variable in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation
-
Extensions for the object.
- Extension - Class in se.idsec.signservice.integration.core
-
Represents an extension to a domain object.
- Extension() - Constructor for class se.idsec.signservice.integration.core.Extension
-
Default constructor.
- Extension(Map<? extends String, ? extends String>) - Constructor for class se.idsec.signservice.integration.core.Extension
-
Copy constructor.
- Extension.ExtensionBuilder - Class in se.idsec.signservice.integration.core
-
Builder for
Extension
objects.
F
- fieldValue(String, String) - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement.VisiblePdfSignatureRequirementBuilder
- FileResource - Class in se.idsec.signservice.integration.core
-
A
FileResource
class is a generic class for handling file resources used in configuration of a SignService Integration Service. - FileResource() - Constructor for class se.idsec.signservice.integration.core.FileResource
-
Default constructor.
- FileResource(String, String, String, boolean) - Constructor for class se.idsec.signservice.integration.core.FileResource
-
Constructor.
- FileResource.FileResourceBuilder - Class in se.idsec.signservice.integration.core
-
Builder class for
FileResource
. - FileResourceBuilder() - Constructor for class se.idsec.signservice.integration.core.FileResource.FileResourceBuilder
- FIRST - Enum constant in enum class se.idsec.signservice.integration.document.xml.XMLSignatureLocation.ChildPosition
-
Insert the signature as the first child of the selected parent node.
- FLATTENED_ACROFORM - Enum constant in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareActions
-
The document was unsigned but had an AcroForm with user input form fields.
- friendlyName(String) - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute.RequestedCertificateAttributeBuilder
-
Adds the attribute friendly name
- fromIndex(int) - Static method in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
Finds the enum constant based on its index number.
- fromMimeType(String) - Static method in enum class se.idsec.signservice.integration.document.DocumentType
-
Given a MIME type the method returns the corresponding enum constant.
- fromMimeType(String) - Static method in enum class se.idsec.signservice.integration.signmessage.SignMessageMimeType
-
Given a MIME type's textual representation, the method returns its enum value.
- fromPosition(String) - Static method in enum class se.idsec.signservice.integration.document.xml.XMLSignatureLocation.ChildPosition
-
Given a position in its string representation the method returns the corresponding enum constant.
- fromType(String) - Static method in enum class se.idsec.signservice.integration.certificate.CertificateType
-
Given a type string the corresponding enum constant is returned.
- fromType(String) - Static method in enum class se.idsec.signservice.integration.certificate.RequestedCertificateAttributeType
-
Maps the given type to an enum constant.
- fromTypeName(String) - Static method in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
If the supplied name matches
SubjectAlternativeNameType.getTypeName()
orEnum.name()
the corresponding enum constant is returned. - fromValue(String) - Static method in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareActions
-
Creates a
PdfPrepareReport.PrepareActions
from its string value. - fromValue(String) - Static method in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareWarnings
-
Creates a
PdfPrepareReport.PrepareWarnings
from its string value.
G
- getActions() - Method in class se.idsec.signservice.integration.document.pdf.PdfPrepareReport
-
Gets the actions that were completed during the prepare operation.
- getAdesFormat() - Method in class se.idsec.signservice.integration.document.TbsDocument.EtsiAdesRequirement
-
Gets the ETSI AdES type.
- getAdesObject() - Method in class se.idsec.signservice.integration.document.TbsDocument.EtsiAdesRequirement
-
Gets the AdES object as a Base64-encoded byte array.
- getAdesRequirement() - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Tells whether the resulting signature should use an ETSI AdES format.
- getAssertion() - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Gets the assertion issued for the user's "authentication for signature" operation (in Base64 encoded format).
- getAssertionReference() - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Gets the unique ID of the assertion issued for the user's "authentication for signature" operation.
- getAttributeMappings() - Method in class se.idsec.signservice.integration.certificate.SigningCertificateRequirements
-
Gets the mappings between the signer's authentication attributes and attributes that are to be placed in the issued signature certificate.
- getAttributeValueType() - Method in class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue
-
Gets the type for the attribute value.
- getAuthnContextClassRefs() - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Gets the authentication context reference identifier(s) (URI(s)) that identifies the context under which the signer should be authenticated.
- getAuthnContextRef() - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Gets the authentication context reference identifier (a URI) that identifies the context under which the signer was authenticated.
- getAuthnInstant() - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Gets the time (in millis since epoch) when the SignService authenticated the signer.
- getAuthnProfile() - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Gets the authentication profile.
- getAuthnRequirements() - Method in class se.idsec.signservice.integration.SignRequestInput
-
Gets the requirements that the sign requester has on the principal that is to perform the signature operation.
- getAuthnServiceID() - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Gets the entityID of the authentication service (Identity Provider) that will authenticate the signer as part of the signature process.
- getAuthnServiceID() - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Gets the entityID of the authentication service (Identity Provider) that will authenticate the signer as part of the signature process.
- getAuthnType() - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Gets the identifier for the type of authentication that was used for the "authentication for signature" operation, e.g.
- getBinding() - Method in class se.idsec.signservice.integration.SignRequestData
-
Gets the identifier for the binding of the message that is to be sent.
- getCategory() - Method in exception class se.idsec.signservice.integration.core.error.BadRequestException
- getCategory() - Method in class se.idsec.signservice.integration.core.error.ErrorCode
-
Gets the category of the error.
- getCategory() - Method in exception class se.idsec.signservice.integration.core.error.SignServiceIntegrationException
-
Override this method if a subclass is tied to a specific error category.
- getCertificateRequirements() - Method in class se.idsec.signservice.integration.SignRequestInput
-
Gets the requirements for the signature certificate that will be issued by the sign service.
- getCertificateType() - Method in class se.idsec.signservice.integration.certificate.SigningCertificateRequirements
-
Gets the requested certificate type.
- getChildPosition() - Method in class se.idsec.signservice.integration.document.xml.XMLSignatureLocation
-
Gets the indicator for first or last child of a selected parent node.
- getCode() - Method in class se.idsec.signservice.integration.core.error.ErrorCode
-
Gets the error code within the given category.
- getColumns() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
If it should be possible to add PDF sign images in several columns to this sign page document the
columns
attribute should be assigned to the desired number of columns. - getConfiguration(String) - Method in interface se.idsec.signservice.integration.SignServiceIntegrationService
-
Given the name of a SignService Integration policy, the method returns the default settings used for this policy.
- getContent() - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Gets the Base64-encoded byte string that is the content of the document that is to be signed.
- getContentReference() - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Gets the content reference may be used instead of supplying the actual content (
TbsDocument.setContent(String)
). - getContents() - Method in class se.idsec.signservice.integration.core.FileResource
-
Gets the contents of the file resource as a base64 encoded string.
- getContents() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
A utility method that can be used to get the raw bytes of the PDF document holding the PDF signature page.
- getCorrelationId() - Method in class se.idsec.signservice.integration.SignatureResult
-
Gets the correlation ID.
- getCorrelationId() - Method in class se.idsec.signservice.integration.SignRequestInput
-
Gets the correlation ID for the process.
- getDataEncryptionAlgorithm() - Method in interface se.idsec.signservice.integration.security.EncryptionParameters
-
Returns the data encryption algorithm that should be used when encrypting the sign message for a given Identity Provider.
- getDateFormat() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Gets the Java date format to use for signing time strings.
- getDefaultAuthnContextRef() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
In a setup where all users are authenticated according to the same authentication contect, a default value could be used.
- getDefaultAuthnServiceID() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
In a setup where only one authentication service (IdP) is used to authenticate users, a default value could be used.
- getDefaultCertificateRequirements() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the default signing certificate requirements to use for SignRequest messages created under this policy/configuration.
- getDefaultDestinationUrl() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the default signature service URL to where SignRequest messages should be posted.
- getDefaultEncryptionParameters() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the default encryption parameters (algorithms) that is used by the SignService Integration Service when encrypting a SignMessage.
- getDefaultReturnUrl() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the default URL to which the user agent along with the sign response message should be directed after a signature operation.
- getDefaultSignatureAlgorithm() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the default algorithm identifier for the signature algorithm that should be used during signing of specified tasks.
- getDefaultSignRequesterID() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the default ID of the entity that requests a signature.
- getDefaultValue() - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
-
Gets the default value to use if no mapping can be found.
- getDefaultVisiblePdfSignatureRequirement() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
A policy may be configured to include a default "visible PDF signature requirement" for all PDF documents that are signed under this policy.
- getDescription() - Method in class se.idsec.signservice.integration.core.FileResource
-
Gets the description of the file resource.
- getDestination() - Method in class se.idsec.signservice.integration.certificate.CertificateAttributeMapping
-
Gets the requested destination attribute gives information about which type of certificate attribute to create, and possibly its default value.
- getDestinationUrl() - Method in class se.idsec.signservice.integration.SignRequestData
-
Gets the signature service URL to which the SignRequest should be posted.
- getDestinationUrl() - Method in class se.idsec.signservice.integration.SignRequestInput
-
Gets the signature service URL to where SignRequest messages should be posted.
- getDetails() - Method in exception class se.idsec.signservice.integration.core.error.InputValidationException
-
Gets the details for the validation error.
- getDetails() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.ValidationError
-
Gets the underlying errors (field names and error messages).
- getDisplayEntity() - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters
-
Gets the ID (SAML entityID) of the entity (IdP) that should display this message.
- getDssError() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Gets the DSS error details.
- getErrorCode() - Method in class se.idsec.signservice.integration.core.error.ErrorCode
-
Gets the error code in string representation.
- getErrorCode() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Gets the error code.
- getErrorCode() - Method in exception class se.idsec.signservice.integration.core.error.SignServiceIntegrationException
-
Gets the error code for this exception
- getExceptionClass() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Gets the name of the exception class that was thrown for this error.
- getExistingSignaturePageNumber() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
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 the
existingSignaturePageNumber
property to inform the Sign Service support service about the document page number of the sign page. - getExtension() - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.certificate.SigningCertificateRequirements
-
Returns the extension parameters for the instance.
- getExtension() - Method in interface se.idsec.signservice.integration.core.Extensible
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.document.pdf.PreparePdfSignaturePageInput
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.document.SignedDocument
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.document.TbsDocument.EtsiAdesRequirement
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.document.xml.XMLSignatureLocation
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.SignatureResult
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.SignRequestData
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.SignRequestInput
-
Returns the extension parameters for the instance.
- getExtension() - Method in class se.idsec.signservice.integration.SignResponseProcessingParameters
-
Returns the extension parameters for the instance.
- getExtensionValue(String) - Method in interface se.idsec.signservice.integration.core.Extensible
-
Gets an extension value.
- getFields() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Gets the map of the field names that are required by the template in the fieldName map in
VisiblePdfSignatureRequirement
. - getFieldValues() - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation
-
Apart from the signer name and signing date, a template may use other fields.
- getFormatting() - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation.SignerName
-
Gets the string the may be supplied to change how the signer's information is displayed.
- getFriendlyName() - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
-
Gets the friendly name of attribute.
- getHeight() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Gets the height (in pixels) for the pixel image that is generated from the template (and inserted into the PDF visible signature flow).
- getHttpStatus() - Method in exception class se.idsec.signservice.integration.config.PolicyNotFoundException
-
If the SignService Integration Service is used from a REST API, the HTTP status may be useful when reporting errors.
- getHttpStatus() - Method in exception class se.idsec.signservice.integration.core.error.BadRequestException
-
If the SignService Integration Service is used from a REST API, the HTTP status may be useful when reporting errors.
- getHttpStatus() - Method in exception class se.idsec.signservice.integration.core.error.NoAccessException
-
If the SignService Integration Service is used from a REST API, the HTTP status may be useful when reporting errors.
- getHttpStatus() - Method in exception class se.idsec.signservice.integration.core.error.SignServiceIntegrationException
-
If the SignService Integration Service is used from a REST API, the HTTP status may be useful when reporting errors.
- getHttpStatus() - Method in exception class se.idsec.signservice.integration.document.pdf.PdfAConsistencyCheckException
-
If the SignService Integration Service is used from a REST API, the HTTP status may be useful when reporting errors.
- getHttpStatus() - Method in exception class se.idsec.signservice.integration.document.pdf.PdfContainsAcroformException
-
If the SignService Integration Service is used from a REST API, the HTTP status may be useful when reporting errors.
- getHttpStatus() - Method in exception class se.idsec.signservice.integration.document.pdf.PdfContainsEncryptionDictionaryException
-
If the SignService Integration Service is used from a REST API, the HTTP status may be useful when reporting errors.
- getHttpStatus() - Method in exception class se.idsec.signservice.integration.document.pdf.PdfSignaturePageFullException
-
If the SignService Integration Service is used from a REST API, the HTTP status may be useful when reporting errors.
- getId() - Method in class se.idsec.signservice.integration.core.RestClientSignatureState
-
Returns the unique identifier for the signature operation.
- getId() - Method in interface se.idsec.signservice.integration.core.SignatureState
-
Returns the unique identifier for the signature operation.
- getId() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
Gets the unique ID for this PDF signature page.
- getId() - Method in class se.idsec.signservice.integration.document.SignedDocument
-
Gets the unique ID for this document (within the current operation).
- getId() - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Gets the unique ID for this document (within the current request).
- getId() - Method in class se.idsec.signservice.integration.SignatureResult
-
Gets the ID for the signature operation.
- getImage() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Gets the SVG image expressed as an XML string.
- getImagePlacementConfiguration() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
Gets the configuration that tells where in the PDF signature page the PDF signature image(s) should be inserted.
- getIndex() - Method in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
Returns the index (mapping to the ASN.1
GeneralName
choice). - getInsertPageAt() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
Tells where in a PDF document the PDF signature page should be inserted.
- getInstance() - Static method in class se.idsec.signservice.integration.core.ContentLoaderSingleton
-
Gets the singleton instance of the global content loader.
- getKeyTransportEncryptionAlgorithm() - Method in interface se.idsec.signservice.integration.security.EncryptionParameters
-
Returns the key transport encryption algorithm that should be used when encrypting the sign message for a given Identity Provider.
- getMajorCode() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.DssError
-
Gets the DSS major result code.
- getMajorCode() - Method in exception class se.idsec.signservice.integration.SignResponseErrorStatusException
-
Gets the DSS major status code.
- getMaxSignatureImages() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
Tells how many PDF signature images that may be displayed in the PDF signature page.
- getMessage() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Gets the error message.
- getMimeType() - Method in enum class se.idsec.signservice.integration.document.DocumentType
-
Returns the MIME type for the document type.
- getMimeType() - Method in class se.idsec.signservice.integration.document.SignedDocument
-
Gets the MIME type of the signed document.
- getMimeType() - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Gets the MIME type of the document that is to be signed.
- getMimeType() - Method in enum class se.idsec.signservice.integration.signmessage.SignMessageMimeType
-
Gets the textual representation of the MIME type.
- getMimeType() - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters
-
Gets the sign message MIME type.
- getMinorCode() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.DssError
-
Gets the DSS minor result code.
- getMinorCode() - Method in exception class se.idsec.signservice.integration.SignResponseErrorStatusException
-
Gets the DSS minor status code.
- getMustShow() - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters
-
Specifies if the requester of the signature requires that the sign message is displayed to the user.
- getName() - Method in class se.idsec.signservice.integration.core.AbstractIdentityAttribute
-
Gets the attribute name.
- getNameFormat() - Method in class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue
-
Gets the name format for the attribute.
- getObject() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.ValidationError
-
Gets the name of the object that validation failed for.
- getObjectName() - Method in exception class se.idsec.signservice.integration.core.error.InputValidationException
-
Gets the name of the object that was validated.
- getPage() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Gets the signature page document page number.
- getPage() - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Gets the number of the page where the visible signature should appear.
- getParameters() - Method in class se.idsec.signservice.integration.ProcessSignResponseInput
-
Gets the optional processing parameters giving directives about the processing.
- getPath() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Gets the requested path.
- getPdfDocument() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
Gets the file resource containing the PDF document that holds the PDF signature page.
- getPdfDocument() - Method in class se.idsec.signservice.integration.document.pdf.PreparePdfSignaturePageInput
-
Gets the contents of the PDF document that is to be prepared in Base64 encoded format.
- getPdfDocumentReference() - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
If the service is running in stateful mode and the call to
ExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
was made with thereturnDocumentReference
parameter set, this field will hold the reference to the PDF document stored by the service. - getPdfPrepareSettings() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the settings for preparing PDF documents.
- getPdfSignatureImageTemplates() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
A policy may have one, or more, image templates for visible PDF signatures in its configuration.
- getPdfSignaturePages() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
A policy may have one, or more, configured PDF signature pages.
- getPolicies() - Method in interface se.idsec.signservice.integration.SignServiceIntegrationService
-
Returns a list of names of the policies that are defined for this instance of the SignService Integration Service.
- getPolicy() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the integration policy name for which this configuration applies.
- getPolicy() - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
Gets the policy under which the data held in this class may be used.
- getPolicy() - Method in class se.idsec.signservice.integration.SignRequestInput
-
Gets the policy.
- getPosition() - Method in enum class se.idsec.signservice.integration.document.xml.XMLSignatureLocation.ChildPosition
-
Gets the position in its string representation.
- getPrepareReport() - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
Gets the actions and warnings for the operation.
- getProcessingRules() - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Gets the Optional processing rules used by the sign service to process sign data.
- getReference() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Gets the unique reference for this image template.
- getRelayState() - Method in class se.idsec.signservice.integration.ProcessSignResponseInput
-
Gets the relayState (read from the RelayState POST parameter).
- getRelayState() - Method in class se.idsec.signservice.integration.SignRequestData
-
Gets the relay state.
- getRequestedSignerAttributes() - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Gets the list of identity attribute values that the sign requester requires the authentication service (IdP) to validate and deliver (and the signature service to assert).
- getRequired() - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
-
Gets whether this attribute must be provided.
- getResource() - Method in class se.idsec.signservice.integration.core.FileResource
-
If the
FileResource
object was initialized with aresource
string this method returns this string. - getReturnDocumentReference() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getReturnUrl() - Method in class se.idsec.signservice.integration.SignRequestInput
-
Gets the URL to which the user agent along with the sign response message should be directed after a signature operation.
- getRows() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
If it should be possible to add PDF sign images in several rows to this sign page document the
rows
attribute should be assigned to the desired number of rows. - getRsaOaepParameters() - Method in interface se.idsec.signservice.integration.security.EncryptionParameters
-
If
EncryptionParameters.getKeyTransportEncryptionAlgorithm()
returnshttp://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
orhttp://www.w3.org/2009/xmlenc11#rsa-oaep
, this method returns the RSA OAEP parameters to use. - getScale() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Gets the scale of the final visible signature image expressed as zoom percentage.
- getScale() - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Gets the scale of the final visible signature image expressed as zoom percentage.
- getSignatureAlgorithm() - Method in class se.idsec.signservice.integration.SignRequestInput
-
Gets the algorithm identifier for the signature algorithm that should be used to sign the specified documents.
- getSignatureCertificate() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the signing certificate that the SignService Integration Service uses to sign SignRequest messages.
- getSignatureImageReference() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
Gets the unique reference of the signature template image that is inserted into this PDF signature page.
- getSignaturePage() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
Gets the signature page.
- getSignaturePagePreferences() - Method in class se.idsec.signservice.integration.document.pdf.PreparePdfSignaturePageInput
-
Gets the preferences of how to prepare the PDF document for a PDF signature page and signature image.
- getSignaturePageReference() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
Gets the reference to a PDF signature page to be inserted (see
PdfSignaturePage.getId()
). - getSignaturePolicy() - Method in class se.idsec.signservice.integration.document.TbsDocument.EtsiAdesRequirement
-
Gets the signature policy (required for EPES).
- getSignedContent() - Method in class se.idsec.signservice.integration.document.SignedDocument
-
Gets the signed document as a Base64-encoded byte string.
- getSignedDocuments() - Method in class se.idsec.signservice.integration.SignatureResult
-
Gets the signed documents.
- getSignerAssertionInformation() - Method in class se.idsec.signservice.integration.SignatureResult
-
Gets information about the signer's "authentication for signature" that was part of the signature operation.
- getSignerAttributes() - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Gets the identity attributes for the signer.
- getSignerAttributes() - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation.SignerName
-
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. - getSignerName() - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation
-
Gets the name of the signer to be represented in the visible image.
- getSignMessage() - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters
-
Gets the sign message (non encrypted) content according to specified mime type.
- getSignMessageParameters() - Method in class se.idsec.signservice.integration.SignRequestInput
-
Gets the sign message parameters that is used to build the sign message element that is included in the SignRequest.
- getSignRequest() - Method in class se.idsec.signservice.integration.SignRequestData
-
Gets the Base64-encoded SignRequest message that is to be posted to the signature service.
- getSignRequesterID() - Method in class se.idsec.signservice.integration.SignRequestInput
-
Gets the entityID of the entity that requests a signature.
- getSignResponse() - Method in class se.idsec.signservice.integration.ProcessSignResponseInput
-
Gets the Base64-encoded SignResponse message (read from the EidSignResponse POST parameter).
- getSignServiceCertificates() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the signature service signing certificate(s) used by the signature service to sign
SignResponse
messages. - getSignServiceID() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the entityID of the signature service.
- getSources() - Method in class se.idsec.signservice.integration.certificate.CertificateAttributeMapping
-
Gets the list of signer source attributes from where the sign service gets information in order to create the requested certificate attribute.
- getState() - Method in class se.idsec.signservice.integration.core.RestClientSignatureState
-
Holds the session state.
- getState() - Method in interface se.idsec.signservice.integration.core.SignatureState
-
Holds the session state.
- getState() - Method in class se.idsec.signservice.integration.ProcessSignResponseInput
-
Gets the signature state.
- getState() - Method in class se.idsec.signservice.integration.SignRequestData
-
Gets the state for a signature operation.
- getStatus() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Gets the HTTP status code.
- getSvgImageFile() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Gets the file resource that holds the SVG image file for this template.
- getTbsDocuments() - Method in class se.idsec.signservice.integration.SignRequestInput
-
Gets the document(s) to be signed along with a per-document signing requirements and parameters.
- getTemplateImageRef() - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Gets the unique reference of the template image that should be by the SignService Integration Service when generating a PDF visible signature.
- getTimestamp() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Gets the timestamp as milliseconds since epoch.
- getTimeZoneId() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Gets the identifier for the time zone associated with this template.
- getTrustAnchors() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Gets the trust anchor certificate(s) of the SignService CA (Certificate Authority).
- getType() - Method in enum class se.idsec.signservice.integration.certificate.CertificateType
-
Gets the type.
- getType() - Method in enum class se.idsec.signservice.integration.certificate.RequestedCertificateAttributeType
-
Returns the type of certificate attribute.
- getType() - Method in class se.idsec.signservice.integration.core.AbstractIdentityAttribute
-
Gets the identity attribute type.
- getTypeName() - Method in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
Returns the name.
- getUpdatedPdfDocument() - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
If the PDF document passed to
ExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
was updated this property holds the updated PDf document (in its Base64 encoded form). - getUpdatedPdfDocumentReference() - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
Deprecated.
- getValidationError() - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Gets the validation error details.
- getValue() - Method in class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue
-
Gets the attribute value (in its string representation).
- getValue() - Method in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareActions
-
Gets the string value.
- getValue() - Method in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareWarnings
-
Gets the string value.
- getVersion() - Static method in class se.idsec.signservice.integration.ApiVersion
-
Gets the version string.
- getVersion() - Method in interface se.idsec.signservice.integration.SignServiceIntegrationService
-
Returns the version identifier for the current version of the SignService Integration Service.
- getVisiblePdfSignatureRequirement() - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
Gets the resulting
VisiblePdfSignatureRequirement
object that should be passed as a property in theTbsDocument
holding the PDF document that is passed toSignServiceIntegrationService.createSignRequest(se.idsec.signservice.integration.SignRequestInput)
. - getVisiblePdfSignatureRequirement() - Method in class se.idsec.signservice.integration.document.TbsDocument
-
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".
- getVisiblePdfSignatureUserInformation() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
Gets the input regarding the user information that is to be used when generating a
VisiblePdfSignatureRequirement
object. - getWarnings() - Method in class se.idsec.signservice.integration.document.pdf.PdfPrepareReport
-
Gets the warnings detected during the prepare operation.
- getWidth() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Gets the width (in pixels) for the pixel image that is generated from the template (and inserted into the PDF visible signature flow).
- getXIncrement() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Gets the signature page document page number.
- getXmlSignatureLocation() - Method in class se.idsec.signservice.integration.SignResponseProcessingParameters
-
For signed XML documents the method tells where the XML signature is inserted.
- getxPath() - Method in class se.idsec.signservice.integration.document.xml.XMLSignatureLocation
-
Gets the XPath expression for selecting the parent node (or
null
which means the parent node is the document root element). - getXPosition() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Gets the X coordinate position (in pixels) of where the first PDF visible signature image should be inserted on the PDF signature page.
- getXPosition() - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Gets the X coordinate position (in pixels) of the PDF visible signature image in the PDF document.
- getXPositison() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
- getYIncrement() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Gets the additional increment of Y coordinate position (in pixels) that should be added to the previously used
yPosition
when inserting a PDF signature image in a new row. - getYPosition() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Gets the Y coordinate position (in pixels) of where the first PDF visible signature image should be inserted on the PDF signature page.
- getYPosition() - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Gets the Y coordinate position (in pixels) of the PDF visible signature image in the PDF document.
H
- HTML - Enum constant in enum class se.idsec.signservice.integration.signmessage.SignMessageMimeType
-
Mime type for HTML
I
- InputValidationException - Exception Class in se.idsec.signservice.integration.core.error
-
Exception class for input validation errors.
- InputValidationException(String) - Constructor for exception class se.idsec.signservice.integration.core.error.InputValidationException
-
Constructor taking the name of the object being validated.
- InputValidationException(String, String) - Constructor for exception class se.idsec.signservice.integration.core.error.InputValidationException
-
Constructor taking the name of the object being validated and an error message.
- InputValidationException(String, String, Throwable) - Constructor for exception class se.idsec.signservice.integration.core.error.InputValidationException
-
Constructor taking the name of the object being validated and an error message.
- InputValidationException(String, String, Map<String, String>) - Constructor for exception class se.idsec.signservice.integration.core.error.InputValidationException
-
Constructor taking the name of the object being validated, an error message and underlying errors details (field names and error messages).
- InputValidationException(String, String, Map<String, String>, Throwable) - Constructor for exception class se.idsec.signservice.integration.core.error.InputValidationException
-
Constructor taking the name of the object being validated, an error message and underlying errors details (field names and error messages).
- InputValidationException(String, Throwable) - Constructor for exception class se.idsec.signservice.integration.core.error.InputValidationException
-
Constructor taking the name of the object being validated.
- InputValidationException(String, Map<String, String>) - Constructor for exception class se.idsec.signservice.integration.core.error.InputValidationException
-
Constructor taking the name of the object being validated and underlying errors details (field names and error messages).
- InputValidationException(String, Map<String, String>, Throwable) - Constructor for exception class se.idsec.signservice.integration.core.error.InputValidationException
-
Constructor taking the name of the object being validated and underlying errors details (field names and error messages).
- IntegrationServiceDefaultConfiguration - Interface in se.idsec.signservice.integration.config
-
Interface that represents the default settings of a SignService Integration Service policy/instance.
- IP_ADDRESS - Enum constant in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
An IP address.
- isAllowFlattenAcroForms() - Method in class se.idsec.signservice.integration.document.pdf.PdfPrepareSettings
-
Tells whether the prepare PDF functions should flatten PDF acroforms in the document being signed.
- isAllowRemoveEncryptionDictionary() - Method in class se.idsec.signservice.integration.document.pdf.PdfPrepareSettings
-
Tells if documents with an encryption dictionary should have it removed.
- isEnforcePdfaConsistency() - Method in class se.idsec.signservice.integration.document.pdf.PdfPrepareSettings
-
Tells whether a PDF/A consistency check is done when adding a sign page to a document to be signed.
- isFailWhenSignPageFull() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
A
PdfSignaturePage
has a limit on how many PDF signature images it can hold (seePdfSignaturePage.getMaxSignatureImages()
). - isIncludeSignerName() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Gets the flag telling whether the signer name will be included in the visible PDF signature.
- isIncludeSigningTime() - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Gets the flag telling whether the signing time will be included in the visible PDF signature.
- isPerformEncryption() - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters
-
Tells whether the supplied sign message should be encrypted with
SignMessageParameters.getDisplayEntity()
as the recipient. - isStateless() - Method in interface se.idsec.signservice.integration.config.IntegrationServiceDefaultConfiguration
-
Tells whether the SignService Integration Service is running in stateless mode or not.
J
- JSON - Enum constant in enum class se.idsec.signservice.integration.document.DocumentType
-
JSON document.
L
- LAST - Enum constant in enum class se.idsec.signservice.integration.document.xml.XMLSignatureLocation.ChildPosition
-
Insert the signature as the last child of the selected parent node.
- loadContent(String) - Method in interface se.idsec.signservice.integration.core.ContentLoader
-
Loads the contents of the given resource.
- loadContent(String) - Method in class se.idsec.signservice.integration.core.ContentLoaderSingleton
-
Loads the contents of the given resource.
- loadContent(String) - Method in class se.idsec.signservice.integration.core.DefaultContentLoader
-
Loads the contents of the given resource.
M
- MARKDOWN - Enum constant in enum class se.idsec.signservice.integration.signmessage.SignMessageMimeType
-
Mime type for markdown
- mimeType(String) - Method in class se.idsec.signservice.integration.document.TbsDocument.TbsDocumentBuilder
- mimeType(String) - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters.SignMessageParametersBuilder
-
The sign message MIME type.
- mimeType(DocumentType) - Method in class se.idsec.signservice.integration.document.TbsDocument.TbsDocumentBuilder
- mimeType(SignMessageMimeType) - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters.SignMessageParametersBuilder
-
The sign message MIME type.
N
- name - Variable in class se.idsec.signservice.integration.core.AbstractIdentityAttribute
-
The attribute name.
- name(String) - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute.RequestedCertificateAttributeBuilder
-
Adds the attribute name.
- NoAccessException - Exception Class in se.idsec.signservice.integration.core.error
-
Exception class to report that the caller does not have access on a given resource.
- NoAccessException(String) - Constructor for exception class se.idsec.signservice.integration.core.error.NoAccessException
-
Constructor assigning the error message.
- NoAccessException(String, Throwable) - Constructor for exception class se.idsec.signservice.integration.core.error.NoAccessException
-
Constructor assigning the error message and the cause of the error.
- NULL_INDICATOR_EXTENSION - Static variable in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Constant for an extension that denotes a "null" visible PDF signature requirement.
O
- ObjectBuilder<T> - Interface in se.idsec.signservice.integration.core
-
Interface for a builder.
P
- PDF - Enum constant in enum class se.idsec.signservice.integration.document.DocumentType
-
PDF document.
- PDFA_INCONSISTENCY - Enum constant in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareWarnings
-
The document is PDF/A, but the sign page is not.
- PdfAConsistencyCheckException - Exception Class in se.idsec.signservice.integration.document.pdf
-
An exception that is reported by
ExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
if a sign page that is not PDF/A is added to a PDF/A document. - PdfAConsistencyCheckException(String) - Constructor for exception class se.idsec.signservice.integration.document.pdf.PdfAConsistencyCheckException
-
Constructor.
- PdfAConsistencyCheckException(String, Throwable) - Constructor for exception class se.idsec.signservice.integration.document.pdf.PdfAConsistencyCheckException
-
Constructor.
- PdfContainsAcroformException - Exception Class in se.idsec.signservice.integration.document.pdf
-
An exception that is reported by
ExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
if a PDF document contains an Acroform and the policy states that it should not be flattened. - PdfContainsAcroformException(String) - Constructor for exception class se.idsec.signservice.integration.document.pdf.PdfContainsAcroformException
-
Constructor.
- PdfContainsAcroformException(String, Throwable) - Constructor for exception class se.idsec.signservice.integration.document.pdf.PdfContainsAcroformException
-
Constructor.
- PdfContainsEncryptionDictionaryException - Exception Class in se.idsec.signservice.integration.document.pdf
-
An exception that is reported by
ExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
if a PDF document contains an encryption dictionary and the policy states that it should not be removed. - PdfContainsEncryptionDictionaryException(String) - Constructor for exception class se.idsec.signservice.integration.document.pdf.PdfContainsEncryptionDictionaryException
-
Constructor.
- PdfContainsEncryptionDictionaryException(String, Throwable) - Constructor for exception class se.idsec.signservice.integration.document.pdf.PdfContainsEncryptionDictionaryException
-
Constructor.
- PdfPrepareReport - Class in se.idsec.signservice.integration.document.pdf
- PdfPrepareReport() - Constructor for class se.idsec.signservice.integration.document.pdf.PdfPrepareReport
- PdfPrepareReport.PrepareActions - Enum Class in se.idsec.signservice.integration.document.pdf
-
Enumeration of prepare actions that were completed by the prepare method.
- PdfPrepareReport.PrepareWarnings - Enum Class in se.idsec.signservice.integration.document.pdf
-
Enumeration of warnings found during the prepare operation.
- PdfPrepareSettings - Class in se.idsec.signservice.integration.document.pdf
-
Represents the profile settings for how a PDF document is prepared.
- PdfPrepareSettings() - Constructor for class se.idsec.signservice.integration.document.pdf.PdfPrepareSettings
- PdfPrepareSettings.PdfPrepareSettingsBuilder - Class in se.idsec.signservice.integration.document.pdf
-
Builder for
PdfPrepareSettings
objects. - PdfPrepareSettingsBuilder() - Constructor for class se.idsec.signservice.integration.document.pdf.PdfPrepareSettings.PdfPrepareSettingsBuilder
- PdfSignatureImagePlacementConfiguration() - Constructor for class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
- PdfSignatureImagePlacementConfigurationBuilder() - Constructor for class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration.PdfSignatureImagePlacementConfigurationBuilder
- PdfSignatureImageTemplate - Class in se.idsec.signservice.integration.document.pdf
-
Representation of an image template that is used for visible PDF signatures.
- PdfSignatureImageTemplate() - Constructor for class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
- PdfSignatureImageTemplate.PdfSignatureImageTemplateBuilder - Class in se.idsec.signservice.integration.document.pdf
-
Builder for
PdfSignatureImageTemplate
objects. - PdfSignatureImageTemplateBuilder() - Constructor for class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate.PdfSignatureImageTemplateBuilder
- PdfSignaturePage - Class in se.idsec.signservice.integration.document.pdf
-
Representation of a "PDF signature page".
- PdfSignaturePage() - Constructor for class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
- PdfSignaturePage.PdfSignatureImagePlacementConfiguration - Class in se.idsec.signservice.integration.document.pdf
-
Representation of the configuration of where in a PDF signature page PDF signature images should be inserted.
- PdfSignaturePage.PdfSignatureImagePlacementConfiguration.PdfSignatureImagePlacementConfigurationBuilder - Class in se.idsec.signservice.integration.document.pdf
-
Builder for
PdfSignatureImagePlacementConfiguration
objects. - PdfSignaturePage.PdfSignaturePageBuilder - Class in se.idsec.signservice.integration.document.pdf
-
Builder for
PdfSignPagePreferences
objects. - PdfSignaturePageBuilder() - Constructor for class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignaturePageBuilder
- PdfSignaturePageFullException - Exception Class in se.idsec.signservice.integration.document.pdf
-
An exception that is reported by
ExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
if there is no more room in a PDF signature page to insert a PDF signature image. - PdfSignaturePageFullException(String) - Constructor for exception class se.idsec.signservice.integration.document.pdf.PdfSignaturePageFullException
-
Constructor.
- PdfSignaturePageFullException(String, Throwable) - Constructor for exception class se.idsec.signservice.integration.document.pdf.PdfSignaturePageFullException
-
Constructor.
- PdfSignaturePagePreferences - Class in se.idsec.signservice.integration.document.pdf
-
Representation of preferences for adding or modifying a
PdfSignaturePage
. - PdfSignaturePagePreferences() - Constructor for class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
- PdfSignaturePagePreferences.PdfSignaturePagePreferencesBuilder - Class in se.idsec.signservice.integration.document.pdf
-
Builder for
PdfSignaturePagePreferences
objects. - PdfSignaturePagePreferencesBuilder() - Constructor for class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences.PdfSignaturePagePreferencesBuilder
- PKC - Enum constant in enum class se.idsec.signservice.integration.certificate.CertificateType
-
Public Key Certificate that is not a Qualified Certificate.
- POLICY_NOT_FOUND_CODE - Static variable in exception class se.idsec.signservice.integration.config.PolicyNotFoundException
-
The error code for the error.
- PolicyNotFoundException - Exception Class in se.idsec.signservice.integration.config
-
Exception class for references to a non-existing policy.
- PolicyNotFoundException(String) - Constructor for exception class se.idsec.signservice.integration.config.PolicyNotFoundException
-
Constructor.
- PolicyNotFoundException(String, Throwable) - Constructor for exception class se.idsec.signservice.integration.config.PolicyNotFoundException
-
Constructor.
- PreparedPdfDocument - Class in se.idsec.signservice.integration.document.pdf
-
The
PreparedPdfDocument
is the representation of the object that is returned fromExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
. - PreparedPdfDocument() - Constructor for class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
- PreparedPdfDocument.PreparedPdfDocumentBuilder - Class in se.idsec.signservice.integration.document.pdf
-
Builder for
PreparedPdfDocument
objects. - PreparedPdfDocumentBuilder() - Constructor for class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument.PreparedPdfDocumentBuilder
- preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String) - Method in interface se.idsec.signservice.integration.ExtendedSignServiceIntegrationService
-
A utility method that can be used to prepare a PDF document for signing.
- PreparePdfSignaturePageInput - Class in se.idsec.signservice.integration.document.pdf
-
Class that represents the input to
ExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
when implemented as a REST endpoint. - PreparePdfSignaturePageInput() - Constructor for class se.idsec.signservice.integration.document.pdf.PreparePdfSignaturePageInput
- PreparePdfSignaturePageInput.PreparePdfSignaturePageInputBuilder - Class in se.idsec.signservice.integration.document.pdf
-
Builder for
PreparePdfSignaturePageInput
. - PreparePdfSignaturePageInputBuilder() - Constructor for class se.idsec.signservice.integration.document.pdf.PreparePdfSignaturePageInput.PreparePdfSignaturePageInputBuilder
- processSignResponse(String, String, SignatureState, SignResponseProcessingParameters) - Method in interface se.idsec.signservice.integration.SignServiceIntegrationService
- processSignResponse(String, String, SignatureState, SignResponseProcessingParameters, String) - Method in interface se.idsec.signservice.integration.SignServiceIntegrationService
-
When the service that has ordered the signing operation receives the sign response message it should invoke this method to process this response.
- ProcessSignResponseInput - Class in se.idsec.signservice.integration
-
The
ProceessSignResponseInput
class is intended to be used when the SignService Integration service is implemented as a REST service. - ProcessSignResponseInput() - Constructor for class se.idsec.signservice.integration.ProcessSignResponseInput
-
Default constructor.
- ProcessSignResponseInput(String, String, SignatureState, SignResponseProcessingParameters) - Constructor for class se.idsec.signservice.integration.ProcessSignResponseInput
-
Constructor.
- ProcessSignResponseInput.ProcessSignResponseInputBuilder - Class in se.idsec.signservice.integration
-
Builder for
ProcessSignResponseInput
objects. - ProcessSignResponseInputBuilder() - Constructor for class se.idsec.signservice.integration.ProcessSignResponseInput.ProcessSignResponseInputBuilder
Q
- QC - Enum constant in enum class se.idsec.signservice.integration.certificate.CertificateType
-
Qualified Certificate.
- QC_SSCD - Enum constant in enum class se.idsec.signservice.integration.certificate.CertificateType
-
Qualified Certificate associated with a private key held in a Qualified Signature Creation Device according to eIDAS.
R
- RDN - Enum constant in enum class se.idsec.signservice.integration.certificate.RequestedCertificateAttributeType
-
Represents an attribute that is a Relative Distinguished Name in the subject field of the certificate.
- REGISTERED_ID - Enum constant in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
Registered ID.
- REMOVED_ENCRYPTION_DICTIONARY - Enum constant in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareActions
-
The document contained an encryption dictionary.
- RequestedCertificateAttribute - Class in se.idsec.signservice.integration.certificate
-
Represents a requested certificate attribute.
- RequestedCertificateAttribute() - Constructor for class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
-
Default constructor.
- RequestedCertificateAttribute(RequestedCertificateAttributeType) - Constructor for class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
-
Constructor creating the object with the given type.
- RequestedCertificateAttribute.RequestedCertificateAttributeBuilder - Class in se.idsec.signservice.integration.certificate
-
Builder for
RequestedCertificateAttribute
objects. - RequestedCertificateAttributeType - Enum Class in se.idsec.signservice.integration.certificate
-
Represents the types of requested certificate attributes.
- required(Boolean) - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute.RequestedCertificateAttributeBuilder
-
Tells whether the attribute is a required attribute
- RestClientSignatureState - Class in se.idsec.signservice.integration.core
-
When the Sign Service Integration service is running as a REST service the clients need to have a concrete class so that JSON deserialization will work.
- RestClientSignatureState() - Constructor for class se.idsec.signservice.integration.core.RestClientSignatureState
-
Default constructor.
- RFC822_NAME - Enum constant in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
An RFC 822 name, typically an email address.
- RSAOAEPParameters() - Constructor for class se.idsec.signservice.integration.security.EncryptionParameters.RSAOAEPParameters
S
- SAML_TYPE - Static variable in class se.idsec.signservice.integration.authentication.SignerIdentityAttribute
-
Type indicator for SAML attribute.
- SAN - Enum constant in enum class se.idsec.signservice.integration.certificate.RequestedCertificateAttributeType
-
Represents an attribute that is a value placed in a Subject Alternative Names extension of the certificate.
- SDA - Enum constant in enum class se.idsec.signservice.integration.certificate.RequestedCertificateAttributeType
-
Represents an attribute that is a value placed in a Subject Directory Attribute extension of the certificate.
- se.idsec.signservice.integration - package se.idsec.signservice.integration
-
API and domain classed for the SignService Integration Service.
- se.idsec.signservice.integration.authentication - package se.idsec.signservice.integration.authentication
-
Interfaces and classes for the authentication of a signer/principal.
- se.idsec.signservice.integration.certificate - package se.idsec.signservice.integration.certificate
-
Interfaces and classes that represent domain classes and operations for the signing certificate that is issued by the SignService.
- se.idsec.signservice.integration.config - package se.idsec.signservice.integration.config
-
Interfaces and definitions for how the SignService Integration Service is configured.
- se.idsec.signservice.integration.core - package se.idsec.signservice.integration.core
-
Core and utility interfaces and classes for the SignService Integration API.
- se.idsec.signservice.integration.core.error - package se.idsec.signservice.integration.core.error
-
Interfaces and classes for error handling and representation of errors.
- se.idsec.signservice.integration.document - package se.idsec.signservice.integration.document
-
Classes and interfaces handling documents that are to be signed, or have been signed.
- se.idsec.signservice.integration.document.pdf - package se.idsec.signservice.integration.document.pdf
-
PDF-specific classes.
- se.idsec.signservice.integration.document.xml - package se.idsec.signservice.integration.document.xml
-
XML-specific interfaces and classes.
- se.idsec.signservice.integration.security - package se.idsec.signservice.integration.security
-
Security related classes and interfaces.
- se.idsec.signservice.integration.signmessage - package se.idsec.signservice.integration.signmessage
-
Definitions for SignMessage handling.
- setActions(List<PdfPrepareReport.PrepareActions>) - Method in class se.idsec.signservice.integration.document.pdf.PdfPrepareReport
-
Assigns the actions that were completed during the prepare operation.
- setAdesFormat(TbsDocument.AdesType) - Method in class se.idsec.signservice.integration.document.TbsDocument.EtsiAdesRequirement
-
Assigns the ETSI AdES type.
- setAdesObject(String) - Method in class se.idsec.signservice.integration.document.TbsDocument.EtsiAdesRequirement
-
Assigns the AdES object as a Base64-encoded byte array.
- setAdesRequirement(TbsDocument.EtsiAdesRequirement) - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Specifies whether the resulting signature should use an ETSI AdES format.
- setAllowFlattenAcroForms(boolean) - Method in class se.idsec.signservice.integration.document.pdf.PdfPrepareSettings
-
Assigns whether the prepare PDF functions should flatten PDF acroforms in the document being signed.
- setAllowRemoveEncryptionDictionary(boolean) - Method in class se.idsec.signservice.integration.document.pdf.PdfPrepareSettings
-
Assigns if documents with an encryption dictionary should have it removed.
- setAssertion(String) - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Assigns the assertion issued for the user's "authentication for signature" operation (in Base64 encoded format).
- setAssertionReference(String) - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Assigns the unique ID of the assertion issued for the user's "authentication for signature" operation.
- setAttributeMappings(List<CertificateAttributeMapping>) - Method in class se.idsec.signservice.integration.certificate.SigningCertificateRequirements
-
Assigns the mappings between the signer's authentication attributes and attributes that are to be placed in the issued signature certificate.
- setAttributeValueType(String) - Method in class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue
-
Assigns the type for the attribute value.
- setAuthnContextClassRefs(List<String>) - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Assigns the authentication context reference identifier(s) (URI(s)) that identifies the context under which the signer should be authenticated.
- setAuthnContextRef(String) - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Deprecated.
- setAuthnContextRef(String) - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Assigns the authentication context reference identifier (a URI) that identifies the context under which the signer was authenticated.
- setAuthnInstant(long) - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Assigns the time (in millis since epoch) when the SignService authenticated the signer.
- setAuthnProfile(String) - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Assigns the authentication profile.
- setAuthnRequirements(AuthnRequirements) - Method in class se.idsec.signservice.integration.SignRequestInput
-
Assigns the requirements that the sign requester has on the principal that is to perform the signature operation.
- setAuthnServiceID(String) - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Assigns the entityID of the authentication service (Identity Provider) that will authenticate the signer as part of the signature process.
- setAuthnServiceID(String) - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Assigns the entityID of the authentication service (Identity Provider) that will authenticate the signer as part of the signature process.
- setAuthnType(String) - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Assigns the identifier for the type of authentication that was used for the "authentication for signature" operation, e.g.
- setBinding(String) - Method in class se.idsec.signservice.integration.SignRequestData
-
Assigns the identifier for the binding of the message that is to be sent.
- setCertificateRequirements(SigningCertificateRequirements) - Method in class se.idsec.signservice.integration.SignRequestInput
-
Assigns the requirements for the signature certificate that will be issued by the sign service.
- setCertificateType(CertificateType) - Method in class se.idsec.signservice.integration.certificate.SigningCertificateRequirements
-
Assigns the requested certificate type.
- setChildPosition(String) - Method in class se.idsec.signservice.integration.document.xml.XMLSignatureLocation
-
Sets the position in the selected parent node where the signature element should be installed (first or last).
- setChildPosition(XMLSignatureLocation.ChildPosition) - Method in class se.idsec.signservice.integration.document.xml.XMLSignatureLocation
-
Sets the position in the selected parent node where the signature element should be installed (first or last).
- setColumns(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
If it should be possible to add PDF sign images in several columns to this sign page document the
columns
attribute should be assigned to the desired number of columns. - setContent(String) - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Assigns the Base64-encoded byte string that is the content of the document that is to be signed.
- setContentLoader(ContentLoader) - Method in class se.idsec.signservice.integration.core.ContentLoaderSingleton
-
If the global
ContentLoader
should be something else thanDefaultContentLoader
this method should be used to assign this. - setContentReference(String) - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Assigns a content reference may be used instead of supplying the actual content (
TbsDocument.setContent(String)
). - setContents(byte[]) - Method in class se.idsec.signservice.integration.core.FileResource
-
Assigns the raw file resource contents.
- setContents(String) - Method in class se.idsec.signservice.integration.core.FileResource
-
Assigns the file resource contents as a base64 encoded string.
- setCorrelationId(String) - Method in class se.idsec.signservice.integration.SignatureResult
-
Assigns the correlation ID.
- setCorrelationId(String) - Method in class se.idsec.signservice.integration.SignRequestInput
-
Assigns the correlation ID for the process.
- setDateFormat(String) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Assigns the date format to use for signing time strings.
- setDefaultValue(String) - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
-
Assigns te default value to use if no mapping can be found.
- setDescription(String) - Method in class se.idsec.signservice.integration.core.FileResource
-
Assigns the description of the file resource.
- setDestination(RequestedCertificateAttribute) - Method in class se.idsec.signservice.integration.certificate.CertificateAttributeMapping
-
Assigns the requested destination attribute gives information about which type of certificate attribute to create, and possibly its default value.
- setDestinationUrl(String) - Method in class se.idsec.signservice.integration.SignRequestData
-
Assigns the signature service URL to which the SignRequest should be posted.
- setDestinationUrl(String) - Method in class se.idsec.signservice.integration.SignRequestInput
-
Assigns the signature service URL to where SignRequest messages should be posted.
- setDetails(Map<String, String>) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.ValidationError
-
Assigns the underlying errors (field names and error messages).
- setDisplayEntity(String) - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters
-
Assigns the ID (SAML entityID) of the entity (IdP) that should display this message.
- setDssError(SignServiceIntegrationErrorBody.DssError) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Assigns the DSS error details.
- setEagerlyLoadContents(boolean) - Method in class se.idsec.signservice.integration.core.FileResource
-
If the
FileResource
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
). - setEnforcePdfaConsistency(boolean) - Method in class se.idsec.signservice.integration.document.pdf.PdfPrepareSettings
-
Defines if PDF/A consistency check is done when adding a sign page to a document to be signed.
- setErrorCode(String) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Assigns the error code.
- setExceptionClass(String) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Assigns the name of the exception class that was thrown for this error.
- setExistingSignaturePageNumber(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
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 the
existingSignaturePageNumber
property to inform the Sign Service support service about the document page number of the sign page. - setExtension(Extension) - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.certificate.SigningCertificateRequirements
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in interface se.idsec.signservice.integration.core.Extensible
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.document.pdf.PreparePdfSignaturePageInput
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.document.SignedDocument
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.document.TbsDocument.EtsiAdesRequirement
-
Assigns the extensions for the object.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.document.xml.XMLSignatureLocation
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.SignatureResult
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.SignRequestData
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.SignRequestInput
-
Assigns the extension parameters for the instance.
- setExtension(Extension) - Method in class se.idsec.signservice.integration.SignResponseProcessingParameters
-
Assigns the extension parameters for the instance.
- setFailWhenSignPageFull(boolean) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
A
PdfSignaturePage
has a limit on how many PDF signature images it can hold (seePdfSignaturePage.getMaxSignatureImages()
). - setFields(Map<String, String>) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Assigns the map of the field names that are required by the template in the fieldName map in
VisiblePdfSignatureRequirement
. - setFieldValues(Map<String, String>) - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation
-
Apart from the signer name and signing date, a template may use other fields.
- setFormatting(String) - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation.SignerName
-
Assigns the string the may be supplied to change how the signer's information is displayed.
- setFriendlyName(String) - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
-
Assigns the friendly name of attribute.
- setHeight(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Assigns the height (in pixels) for the pixel image that is generated from the template (and inserted into the PDF visible signature flow).
- setId(String) - Method in class se.idsec.signservice.integration.core.RestClientSignatureState
-
Assigns the unique identifier for the signature operation.
- setId(String) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
Assigns the unique ID for this PDF signature page
- setId(String) - Method in class se.idsec.signservice.integration.document.SignedDocument
-
Assigns the unique ID for this document (within the current operation).
- setId(String) - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Assigns unique ID for this document (within the current request).
- setId(String) - Method in class se.idsec.signservice.integration.SignatureResult
-
Assigns the ID for the signature operation.
- setImage(String) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Deprecated.since 1.1.0. Use
PdfSignatureImageTemplate.setSvgImageFile(FileResource)
instead - setImagePlacementConfiguration(PdfSignaturePage.PdfSignatureImagePlacementConfiguration) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
Assigns the configuration that tells where in the PDF signature page the PDF signature image(s) should be inserted.
- setIncludeSignerName(boolean) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Assigns the flag telling whether the signer name will be included in the visible PDF signature.
- setIncludeSigningTime(boolean) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Sets the flag telling whether the signing time will be included in the visible PDF signature.
- setInsertPageAt(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
Tells where in a PDF document the PDF signature page should be inserted.
- setMajorCode(String) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.DssError
-
Assigns the DSS major result code.
- setMessage(String) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Assigns the error message.
- setMimeType(String) - Method in class se.idsec.signservice.integration.document.SignedDocument
-
Assigns the MIME type of the signed document.
- setMimeType(String) - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Assigns the MIME type of the document that is to be signed.
- setMimeType(String) - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters
-
The sign message MIME type.
- setMimeType(DocumentType) - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Assigns The document type of the document that is to be signed.
- setMimeType(SignMessageMimeType) - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters
-
The sign message MIME type.
- setMinorCode(String) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.DssError
-
Assigns the DSS minor result code.
- setMustShow(Boolean) - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters
-
Specifies if the requester of the signature requires that the sign message is displayed to the user.
- setName(String) - Method in class se.idsec.signservice.integration.core.AbstractIdentityAttribute
-
Sets the attribute name.
- setNameFormat(String) - Method in class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue
-
Assigns the name format for the attribute.
- setObject(String) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.ValidationError
-
Assigns the name of the object that validation failed for.
- setPage(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Sets the signature page document page number.
- setPage(Integer) - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Assigns the number of the page where the visible signature should appear.
- setParameters(SignResponseProcessingParameters) - Method in class se.idsec.signservice.integration.ProcessSignResponseInput
-
Assigns the processing parameters giving directives about the processing.
- setPath(String) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Assigns the requested path.
- setPdfDocument(String) - Method in class se.idsec.signservice.integration.document.pdf.PreparePdfSignaturePageInput
-
Assigns the contents of the PDF document that is to be prepared in Base64 encoded format.
- setPdfDocument(FileResource) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
Assigns the file resource containing the PDF document that holds the PDF signature page.
- setPdfDocumentReference(String) - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
If the service is running in stateful mode and the call to
ExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
was made with thereturnDocumentReference
parameter set, this field will hold the reference to the PDF document stored by the service. - setPerformEncryption(boolean) - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters
-
Assigns whether the supplied sign message should be encrypted with
SignMessageParameters.getDisplayEntity()
as the recipient. - setPolicy(String) - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
Assigns the policy under which the data held in this class may be used.
- setPolicy(String) - Method in class se.idsec.signservice.integration.SignRequestInput
-
Assigns the policy to use.
- setPrepareReport(PdfPrepareReport) - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
Assigns the actions and warnings for the operation.
- setProcessingRules(String) - Method in class se.idsec.signservice.integration.document.TbsDocument
-
Assigns processing rules used by the sign service to process sign data.
- setReference(String) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Assigns the unique reference for this image template.
- setRelayState(String) - Method in class se.idsec.signservice.integration.ProcessSignResponseInput
-
Assigns the relayState (read from the RelayState POST parameter).
- setRelayState(String) - Method in class se.idsec.signservice.integration.SignRequestData
-
Assigns the relay state.
- setRequestedSignerAttributes(List<SignerIdentityAttributeValue>) - Method in class se.idsec.signservice.integration.authentication.AuthnRequirements
-
Assigns the list of identity attribute values that the sign requester requires the authentication service (IdP) to validate and deliver (and the signature service to assert).
- setRequired(Boolean) - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
-
Assigns whether this attribute must be provided.
- setResource(String) - Method in class se.idsec.signservice.integration.core.FileResource
-
Assigns a resource string.
- setReturnDocumentReference(Boolean) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
Deprecated, for removal: This API element is subject to removal in a future version.assign the
returnDocumentReference
parameter of theExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
method instead - setReturnUrl(String) - Method in class se.idsec.signservice.integration.SignRequestInput
-
Assigns the URL to which the user agent along with the sign response message should be directed after a signature operation.
- setRows(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
If it should be possible to add PDF sign images in several rows to this sign page document the
rows
attribute should be assigned to the desired number of rows. - setScale(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Assigns the scale of the final visible signature image expressed as zoom percentage.
- setScale(Integer) - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Assigns the scale of the final visible signature image expressed as zoom percentage.
- setSignatureAlgorithm(String) - Method in class se.idsec.signservice.integration.SignRequestInput
-
Assigns the algorithm identifier for the signature algorithm that should be used to sign the specified documents.
- setSignatureImageReference(String) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
Assigns the unique reference of the signature template image that is inserted into this PDF signature page.
- setSignaturePage(PdfSignaturePage) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
As an alternative to specifying a
signPageReference
(seePdfSignaturePagePreferences.setSignaturePageReference(String)
) the actual sign page can be provided in the preferences. - setSignaturePagePreferences(PdfSignaturePagePreferences) - Method in class se.idsec.signservice.integration.document.pdf.PreparePdfSignaturePageInput
-
Assigns the preferences of how to prepare the PDF document for a PDF signature page and signature image.
- setSignaturePageReference(String) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
Assigns a reference to a PDF signature page to be inserted (see
PdfSignaturePage.getId()
). - setSignaturePolicy(String) - Method in class se.idsec.signservice.integration.document.TbsDocument.EtsiAdesRequirement
-
Assigns the signature policy (required for EPES).
- setSignedContent(String) - Method in class se.idsec.signservice.integration.document.SignedDocument
-
Assigns the signed document as a Base64-encoded byte string.
- setSignedDocuments(List<SignedDocument>) - Method in class se.idsec.signservice.integration.SignatureResult
-
Assigns the signed documents.
- setSignerAssertionInformation(SignerAssertionInformation) - Method in class se.idsec.signservice.integration.SignatureResult
-
Assigns information about the signer's "authentication for signature" that was part of the signature operation.
- setSignerAttributes(List<SignerIdentityAttribute>) - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation.SignerName
-
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. - setSignerAttributes(List<SignerIdentityAttributeValue>) - Method in class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Assigns the identity attributes for the signer.
- setSignerName(VisiblePdfSignatureUserInformation.SignerName) - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation
-
Assigns the name of the signer to be represented in the visible image.
- setSignMessage(String) - Method in class se.idsec.signservice.integration.signmessage.SignMessageParameters
-
Assigns the sign message (non encrypted) content according to specified mime type.
- setSignMessageParameters(SignMessageParameters) - Method in class se.idsec.signservice.integration.SignRequestInput
-
Assigns the sign message parameters that is used to build the sign message element that is included in the SignRequest.
- setSignRequest(String) - Method in class se.idsec.signservice.integration.SignRequestData
-
Assigns the Base64-encoded SignRequest message that is to be posted to the signature service.
- setSignRequesterID(String) - Method in class se.idsec.signservice.integration.SignRequestInput
-
Assigns the entityID of the entity that requests a signature.
- setSignResponse(String) - Method in class se.idsec.signservice.integration.ProcessSignResponseInput
-
Assigns the Base64-encoded SignResponse message (read from the EidSignResponse POST parameter).
- setSources(List<SignerIdentityAttribute>) - Method in class se.idsec.signservice.integration.certificate.CertificateAttributeMapping
-
Assigns the list of signer source attributes from where the sign service gets information in order to create the requested certificate attribute.
- setState(LinkedHashMap<String, ?>) - Method in class se.idsec.signservice.integration.core.RestClientSignatureState
-
Assigns the session state.
- setState(SignatureState) - Method in class se.idsec.signservice.integration.ProcessSignResponseInput
-
Assigns the signature state.
- setState(SignatureState) - Method in class se.idsec.signservice.integration.SignRequestData
-
Assigns the state for a signature operation.
- setStatus(int) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Assigns the HTTP status code.
- setSvgImageFile(FileResource) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Assigns the file resource that holds the SVG image file for this template.
- setTbsDocuments(List<TbsDocument>) - Method in class se.idsec.signservice.integration.SignRequestInput
-
Assigns the document(s) to be signed along with a per-document signing requirements and parameters.
- setTemplateImageRef(String) - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Assigns the unique reference of the template image that should be by the SignService Integration Service when generating a PDF visible signature.
- setTimestamp(long) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Assigns the timestamp as milliseconds since epoch.
- setTimeZoneId(String) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Assigns the time zone identifier for this template.
- setType(String) - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
-
Assigns the identity attribute type.
- setType(String) - Method in class se.idsec.signservice.integration.core.AbstractIdentityAttribute
-
Assigns the identity attribute type.
- setType(RequestedCertificateAttributeType) - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute
-
Assigns the attribute type.
- setUpdatedPdfDocument(String) - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
If the PDF document passed to
ExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
was updated this property holds the updated PDf document (in its Base64 encoded form). - setUpdatedPdfDocumentReference(String) - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
Deprecated, for removal: This API element is subject to removal in a future version.
- setValidationError(SignServiceIntegrationErrorBody.ValidationError) - Method in class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Assigns the validation error details.
- setValue(String) - Method in class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue
-
Assigns the attribute value (in its string representation).
- setVisiblePdfSignatureRequirement(VisiblePdfSignatureRequirement) - Method in class se.idsec.signservice.integration.document.pdf.PreparedPdfDocument
-
Assigns the resulting
VisiblePdfSignatureRequirement
object that should be passed as a property in theTbsDocument
holding the PDF document that is passed toSignServiceIntegrationService.createSignRequest(se.idsec.signservice.integration.SignRequestInput)
. - setVisiblePdfSignatureRequirement(VisiblePdfSignatureRequirement) - Method in class se.idsec.signservice.integration.document.TbsDocument
-
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".
- setVisiblePdfSignatureUserInformation(VisiblePdfSignatureUserInformation) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePagePreferences
-
Assigns the input regarding the user information that is to be used when generating a
VisiblePdfSignatureRequirement
object. - setWarnings(List<PdfPrepareReport.PrepareWarnings>) - Method in class se.idsec.signservice.integration.document.pdf.PdfPrepareReport
-
Assigns warnings detected during the prepare operation.
- setWidth(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Assigns the width (in pixels) for the pixel image that is generated from the template (and inserted into the PDF visible signature flow).
- setXIncrement(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Sets the signature page document page number.
- setXmlSignatureLocation(XMLSignatureLocation) - Method in class se.idsec.signservice.integration.SignResponseProcessingParameters
-
For XML documents, this method assigned where the signature should be inserted.
- setxPath(String) - Method in class se.idsec.signservice.integration.document.xml.XMLSignatureLocation
-
Assigns the XPath expression for selecting the parent node (or
null
which means the parent node is the document root element). - setXPosition(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Assigns the X coordinate position (in pixels) of where the first PDF visible signature image should be inserted on the PDF signature page.
- setXPosition(Integer) - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Assigns the X coordinate position (in pixels) of the PDF visible signature image in the PDF document.
- setXPositison(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
- setYIncrement(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Sets the additional increment of Y coordinate position (in pixels) that should be added to the previously used
yPosition
when inserting a PDF signature image in a new row. - setYPosition(Integer) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage.PdfSignatureImagePlacementConfiguration
-
Assigns the Y coordinate position (in pixels) of where the first PDF visible signature image should be inserted on the PDF signature page.
- setYPosition(Integer) - Method in class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Assigns the Y coordinate position (in pixels) of the PDF visible signature image in the PDF document.
- SignatureDestinationType - Enum Class in se.idsec.signservice.integration.document
-
An enum that is used when stating how an XML signed document should be compiled.
- signatureImageReference - Variable in class se.idsec.signservice.integration.document.pdf.PdfSignaturePage
-
A unique reference of the signature template image that is inserted into this PDF signature page.
- SignatureResult - Class in se.idsec.signservice.integration
-
Representation of the result of a signature operation.
- SignatureResult() - Constructor for class se.idsec.signservice.integration.SignatureResult
-
Default constructor.
- SignatureResult(String, String, List<SignedDocument>, SignerAssertionInformation, Extension) - Constructor for class se.idsec.signservice.integration.SignatureResult
-
Constructor.
- SignatureResult.SignatureResultBuilder - Class in se.idsec.signservice.integration
-
Builder for
SignatureResult
objects. - SignatureResultBuilder() - Constructor for class se.idsec.signservice.integration.SignatureResult.SignatureResultBuilder
- SignatureState - Interface in se.idsec.signservice.integration.core
-
The
SignatureState
is used to represent the state of an ongoing signature operation. - SignedDocument - Class in se.idsec.signservice.integration.document
-
Represents a signed document.
- SignedDocument() - Constructor for class se.idsec.signservice.integration.document.SignedDocument
- SignedDocument.SignedDocumentBuilder - Class in se.idsec.signservice.integration.document
-
Builder for
SignedDocument
objects. - SignedDocumentBuilder() - Constructor for class se.idsec.signservice.integration.document.SignedDocument.SignedDocumentBuilder
- SIGNER_NAME_FIELD_NAME - Static variable in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Constant for the name of the special purpose field "signerName".
- SignerAssertionInformation - Class in se.idsec.signservice.integration.authentication
-
A representation of the assertion info for the signer's "authentication for signature" that was performed during a signature operation.
- SignerAssertionInformation() - Constructor for class se.idsec.signservice.integration.authentication.SignerAssertionInformation
-
Constructor.
- SignerAssertionInformation.SignerAssertionInformationBuilder - Class in se.idsec.signservice.integration.authentication
-
Builder for
SignerAssertionInformation
objects. - SignerAssertionInformationBuilder() - Constructor for class se.idsec.signservice.integration.authentication.SignerAssertionInformation.SignerAssertionInformationBuilder
- SignerIdentityAttribute - Class in se.idsec.signservice.integration.authentication
-
Representation of a signer identity attribute.
- SignerIdentityAttribute() - Constructor for class se.idsec.signservice.integration.authentication.SignerIdentityAttribute
-
Default constructor.
- SignerIdentityAttribute(String, String) - Constructor for class se.idsec.signservice.integration.authentication.SignerIdentityAttribute
-
Constructor.
- SignerIdentityAttribute.SignerIdentityAttributeBuilder - Class in se.idsec.signservice.integration.authentication
-
Builder for
SignerIdentityAttribute
objects. - SignerIdentityAttributeBuilder() - Constructor for class se.idsec.signservice.integration.authentication.SignerIdentityAttribute.SignerIdentityAttributeBuilder
- SignerIdentityAttributeValue - Class in se.idsec.signservice.integration.authentication
-
Representation of the value of a signer attribute.
- SignerIdentityAttributeValue() - Constructor for class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue
-
Default constructor.
- SignerIdentityAttributeValue(String, String, String, String, String) - Constructor for class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue
-
Constructor.
- SignerIdentityAttributeValue.SignerIdentityAttributeValueBuilder - Class in se.idsec.signservice.integration.authentication
-
Builder for
SignerIdentityAttributeValue
objects. - SignerIdentityAttributeValueBuilder() - Constructor for class se.idsec.signservice.integration.authentication.SignerIdentityAttributeValue.SignerIdentityAttributeValueBuilder
- SignerName() - Constructor for class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation.SignerName
- SignerNameBuilder() - Constructor for class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation.SignerName.SignerNameBuilder
- SIGNING_TIME_FIELD_NAME - Static variable in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate
-
Constant for the name of the special purpose field "signingTime".
- SigningCertificateRequirements - Class in se.idsec.signservice.integration.certificate
-
When sending a SignRequest, a sign requester specifies a set of requirements for the signature certificate that is generated by the sign service.
- SigningCertificateRequirements() - Constructor for class se.idsec.signservice.integration.certificate.SigningCertificateRequirements
-
Default constructor.
- SigningCertificateRequirements(CertificateType, List<CertificateAttributeMapping>, Extension) - Constructor for class se.idsec.signservice.integration.certificate.SigningCertificateRequirements
-
Constructor.
- SigningCertificateRequirements.SigningCertificateRequirementsBuilder - Class in se.idsec.signservice.integration.certificate
-
Builder for
SigningCertificateRequirements
objects - SigningCertificateRequirementsBuilder() - Constructor for class se.idsec.signservice.integration.certificate.SigningCertificateRequirements.SigningCertificateRequirementsBuilder
- SignMessageMimeType - Enum Class in se.idsec.signservice.integration.signmessage
-
Enum representing a MIME type for sign messages.
- SignMessageParameters - Class in se.idsec.signservice.integration.signmessage
-
A representation of sign message parameters.
- SignMessageParameters() - Constructor for class se.idsec.signservice.integration.signmessage.SignMessageParameters
- SignMessageParameters.SignMessageParametersBuilder - Class in se.idsec.signservice.integration.signmessage
-
A builder for
SignMessageParameters
. - SignMessageParametersBuilder() - Constructor for class se.idsec.signservice.integration.signmessage.SignMessageParameters.SignMessageParametersBuilder
- SignRequestData - Class in se.idsec.signservice.integration
-
Domain class representing the result of a
SignServiceIntegrationService.createSignRequest(SignRequestInput)
call. - SignRequestData() - Constructor for class se.idsec.signservice.integration.SignRequestData
-
Default constructor.
- SignRequestData(SignatureState, String, String, String, String, Extension) - Constructor for class se.idsec.signservice.integration.SignRequestData
-
Constructor.
- SignRequestData.SignRequestDataBuilder - Class in se.idsec.signservice.integration
-
Builder for
SignRequestData
objects. - SignRequestDataBuilder() - Constructor for class se.idsec.signservice.integration.SignRequestData.SignRequestDataBuilder
- SignRequestInput - Class in se.idsec.signservice.integration
-
Class that represents the input to a
SignServiceIntegrationService.createSignRequest(SignRequestInput)
operation. - SignRequestInput() - Constructor for class se.idsec.signservice.integration.SignRequestInput
-
Constructor.
- SignRequestInput.SignRequestInputBuilder - Class in se.idsec.signservice.integration
-
Builder for
SignRequestInput
. - SignRequestInputBuilder() - Constructor for class se.idsec.signservice.integration.SignRequestInput.SignRequestInputBuilder
- SignResponseCancelStatusException - Exception Class in se.idsec.signservice.integration
-
Dedicated exception class to represent a user cancel.
- SignResponseCancelStatusException() - Constructor for exception class se.idsec.signservice.integration.SignResponseCancelStatusException
-
Constructor.
- SignResponseErrorStatusException - Exception Class in se.idsec.signservice.integration
-
Exception class that represents non-successful DSS operations.
- SignResponseErrorStatusException(String, String) - Constructor for exception class se.idsec.signservice.integration.SignResponseErrorStatusException
-
Constructor.
- SignResponseErrorStatusException(String, String, String) - Constructor for exception class se.idsec.signservice.integration.SignResponseErrorStatusException
-
Constructor.
- SignResponseProcessingParameters - Class in se.idsec.signservice.integration
-
Class representing the processing parameters for a call to
SignServiceIntegrationService.processSignResponse(String, String, se.idsec.signservice.integration.core.SignatureState, SignResponseProcessingParameters)
. - SignResponseProcessingParameters() - Constructor for class se.idsec.signservice.integration.SignResponseProcessingParameters
-
Default constructor.
- SignResponseProcessingParameters(XMLSignatureLocation, Extension) - Constructor for class se.idsec.signservice.integration.SignResponseProcessingParameters
-
Constructor.
- SignResponseProcessingParameters.SignResponseProcessingParametersBuilder - Class in se.idsec.signservice.integration
-
Builder for
SignResponseProcessingParameters
objects. - SignResponseProcessingParametersBuilder() - Constructor for class se.idsec.signservice.integration.SignResponseProcessingParameters.SignResponseProcessingParametersBuilder
- SignServiceIntegrationCategoryException - Exception Class in se.idsec.signservice.integration.core.error
-
Abstract class for exception that reports errors for a given category.
- SignServiceIntegrationCategoryException(ErrorCode.Code, String) - Constructor for exception class se.idsec.signservice.integration.core.error.SignServiceIntegrationCategoryException
-
Constructor.
- SignServiceIntegrationCategoryException(ErrorCode.Code, String, Throwable) - Constructor for exception class se.idsec.signservice.integration.core.error.SignServiceIntegrationCategoryException
-
Constructor.
- SignServiceIntegrationErrorBody - Class in se.idsec.signservice.integration.core.error
-
The
SignServiceIntegrationErrorBody
is a representation of a SignService Integration error message when the service is implemented as a REST service. - SignServiceIntegrationErrorBody() - Constructor for class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
Default constructor.
- SignServiceIntegrationErrorBody(int, long, String, SignServiceIntegrationErrorBody.ValidationError, SignServiceIntegrationErrorBody.DssError, String, String, String) - Constructor for class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody
-
All-args constructor.
- SignServiceIntegrationErrorBody.DssError - Class in se.idsec.signservice.integration.core.error
-
For DSS errors.
- SignServiceIntegrationErrorBody.ValidationError - Class in se.idsec.signservice.integration.core.error
-
Representation of validation errors.
- SignServiceIntegrationException - Exception Class in se.idsec.signservice.integration.core.error
-
Base class for Sign Service Integration exceptions.
- SignServiceIntegrationException(ErrorCode.Code, String) - Constructor for exception class se.idsec.signservice.integration.core.error.SignServiceIntegrationException
-
Constructor.
- SignServiceIntegrationException(ErrorCode.Code, String, Throwable) - Constructor for exception class se.idsec.signservice.integration.core.error.SignServiceIntegrationException
-
Constructor.
- SignServiceIntegrationException(ErrorCode, String) - Constructor for exception class se.idsec.signservice.integration.core.error.SignServiceIntegrationException
-
Constructor.
- SignServiceIntegrationException(ErrorCode, String, Throwable) - Constructor for exception class se.idsec.signservice.integration.core.error.SignServiceIntegrationException
-
Constructor.
- SignServiceIntegrationService - Interface in se.idsec.signservice.integration
-
Interface describing the API for the SignService Integration Service.
- SubjectAlternativeNameType - Enum Class in se.idsec.signservice.integration.certificate
-
An enum that represents the different name types that can be stored in an X.509 subject alternative name certificate extension.
T
- TbsDocument - Class in se.idsec.signservice.integration.document
-
Represents a document that is to be signed along with the per-document requirements and parameters.
- TbsDocument() - Constructor for class se.idsec.signservice.integration.document.TbsDocument
- TbsDocument.AdesType - Enum Class in se.idsec.signservice.integration.document
-
Enum reprenting an ETSI AdES format.
- TbsDocument.EtsiAdesRequirement - Class in se.idsec.signservice.integration.document
-
Representation of an ETSI AdES signature requirement.
- TbsDocument.EtsiAdesRequirement.EtsiAdesRequirementBuilder - Class in se.idsec.signservice.integration.document
-
Builder for
TbsDocument.EtsiAdesRequirement
. - TbsDocument.TbsDocumentBuilder - Class in se.idsec.signservice.integration.document
-
Builder for
TbsDocument
objects. - TbsDocumentBuilder() - Constructor for class se.idsec.signservice.integration.document.TbsDocument.TbsDocumentBuilder
- TEXT - Enum constant in enum class se.idsec.signservice.integration.signmessage.SignMessageMimeType
-
Mime type for text
- timeZoneId(String) - Method in class se.idsec.signservice.integration.document.pdf.PdfSignatureImageTemplate.PdfSignatureImageTemplateBuilder
- toString() - Method in class se.idsec.signservice.integration.core.error.ErrorCode
- toString() - Method in class se.idsec.signservice.integration.core.FileResource
- toString() - Method in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareActions
- toString() - Method in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareWarnings
- type - Variable in class se.idsec.signservice.integration.core.AbstractIdentityAttribute
-
The type of attribute.
- type(RequestedCertificateAttributeType) - Method in class se.idsec.signservice.integration.certificate.RequestedCertificateAttribute.RequestedCertificateAttributeBuilder
-
Adds the attribute type.
U
- UNIFORM_RESOURCE_IDENTIFIER - Enum constant in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
An URI.
V
- ValidationError() - Constructor for class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.ValidationError
-
Default constructor.
- ValidationError(String, Map<String, String>) - Constructor for class se.idsec.signservice.integration.core.error.SignServiceIntegrationErrorBody.ValidationError
-
Constructor.
- valueOf(String) - Static method in enum class se.idsec.signservice.integration.certificate.CertificateType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class se.idsec.signservice.integration.certificate.RequestedCertificateAttributeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class se.idsec.signservice.integration.document.DocumentType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareActions
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareWarnings
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class se.idsec.signservice.integration.document.SignatureDestinationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class se.idsec.signservice.integration.document.TbsDocument.AdesType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class se.idsec.signservice.integration.document.xml.XMLSignatureLocation.ChildPosition
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class se.idsec.signservice.integration.signmessage.SignMessageMimeType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class se.idsec.signservice.integration.certificate.CertificateType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class se.idsec.signservice.integration.certificate.RequestedCertificateAttributeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class se.idsec.signservice.integration.document.DocumentType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareActions
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class se.idsec.signservice.integration.document.pdf.PdfPrepareReport.PrepareWarnings
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class se.idsec.signservice.integration.document.SignatureDestinationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class se.idsec.signservice.integration.document.TbsDocument.AdesType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class se.idsec.signservice.integration.document.xml.XMLSignatureLocation.ChildPosition
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class se.idsec.signservice.integration.signmessage.SignMessageMimeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VisiblePdfSignatureRequirement - Class in se.idsec.signservice.integration.document.pdf
-
Class that represents the requirement for including a visible indication stating that a PDF document has been signed, and by whom.
- VisiblePdfSignatureRequirement(VisiblePdfSignatureUserInformation) - Constructor for class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
-
Constructor that accepts a
VisiblePdfSignatureUserInformation
object and initializes the properties from this object. - VisiblePdfSignatureRequirement(VisiblePdfSignatureUserInformation.SignerName, Map<String, String>, Extension, String, Integer, Integer, Integer, Integer) - Constructor for class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement
- VisiblePdfSignatureRequirement.VisiblePdfSignatureRequirementBuilder - Class in se.idsec.signservice.integration.document.pdf
-
Builder for
VisiblePdfSignatureRequirement
objects. - VisiblePdfSignatureRequirementBuilder() - Constructor for class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureRequirement.VisiblePdfSignatureRequirementBuilder
- VisiblePdfSignatureUserInformation - Class in se.idsec.signservice.integration.document.pdf
-
Representation of the user information that is injected into a PDF signature image.
- VisiblePdfSignatureUserInformation() - Constructor for class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation
- VisiblePdfSignatureUserInformation.SignerName - Class in se.idsec.signservice.integration.document.pdf
-
Class representing the input needed to display the signer name in a visible PDF signature.
- VisiblePdfSignatureUserInformation.SignerName.SignerNameBuilder - Class in se.idsec.signservice.integration.document.pdf
-
Builder for
SignerName
objects. - VisiblePdfSignatureUserInformation.VisiblePdfSignatureUserInformationBuilder - Class in se.idsec.signservice.integration.document.pdf
-
Builder for
VisiblePdfSignatureUserInformation
objects. - VisiblePdfSignatureUserInformationBuilder() - Constructor for class se.idsec.signservice.integration.document.pdf.VisiblePdfSignatureUserInformation.VisiblePdfSignatureUserInformationBuilder
X
- X400_ADDRESS - Enum constant in enum class se.idsec.signservice.integration.certificate.SubjectAlternativeNameType
-
X.400 address, see X.400.
- XML - Enum constant in enum class se.idsec.signservice.integration.document.DocumentType
-
XML document.
- XML_NODE_LOCATION - Enum constant in enum class se.idsec.signservice.integration.document.SignatureDestinationType
-
The value "first" or "last" to specify the signature node location within the parent node.
- XML_PARENT_XPATH - Enum constant in enum class se.idsec.signservice.integration.document.SignatureDestinationType
-
The XPath expression for the parent node under which the signature should be inserted.
- XML_SCHEMA - Enum constant in enum class se.idsec.signservice.integration.document.SignatureDestinationType
-
A Base64 encoded XML Schema for the signed XML document
- XML_SCHEMA_NS - Enum constant in enum class se.idsec.signservice.integration.document.SignatureDestinationType
-
An XML Schema name space URI for the signed XML document
- XMLSignatureLocation - Class in se.idsec.signservice.integration.document.xml
-
Tells where in an XML document the signature should be inserted.
- XMLSignatureLocation() - Constructor for class se.idsec.signservice.integration.document.xml.XMLSignatureLocation
-
Default constructor.
- XMLSignatureLocation(String, String, Extension) - Constructor for class se.idsec.signservice.integration.document.xml.XMLSignatureLocation
-
Constructor.
- XMLSignatureLocation.ChildPosition - Enum Class in se.idsec.signservice.integration.document.xml
-
Enum for indicating the insertion point within a selected parent node.
- XMLSignatureLocation.XMLSignatureLocationBuilder - Class in se.idsec.signservice.integration.document.xml
-
Builder for
XMLSignatureLocation
objects. - XMLSignatureLocationBuilder() - Constructor for class se.idsec.signservice.integration.document.xml.XMLSignatureLocation.XMLSignatureLocationBuilder
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
returnDocumentReference
parameter of theExtendedSignServiceIntegrationService.preparePdfDocument(String, byte[], PdfSignaturePagePreferences, Boolean, String)
method instead