Package se.idsec.signservice.integration
Class SignatureResult
java.lang.Object
se.idsec.signservice.integration.SignatureResult
- All Implemented Interfaces:
Serializable
,Extensible
Representation of the result of a signature operation.
- Author:
- Martin Lindström (martin@idsec.se), Stefan Santesson (stefan@idsec.se)
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Builder forSignatureResult
objects. -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.SignatureResult
(String id, String correlationId, List<SignedDocument> signedDocuments, SignerAssertionInformation signerAssertionInformation, Extension extension) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionGets the correlation ID.Returns the extension parameters for the instance.getId()
Gets the ID for the signature operation.Gets the signed documents.Gets information about the signer's "authentication for signature" that was part of the signature operation.void
setCorrelationId
(String correlationId) Assigns the correlation ID.void
setExtension
(Extension extension) Assigns the extension parameters for the instance.void
Assigns the ID for the signature operation.void
setSignedDocuments
(List<SignedDocument> signedDocuments) Assigns the signed documents.void
setSignerAssertionInformation
(SignerAssertionInformation signerAssertionInformation) Assigns information about the signer's "authentication for signature" that was part of the signature operation.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface se.idsec.signservice.integration.core.Extensible
addExtensionValue, getExtensionValue
-
Constructor Details
-
SignatureResult
public SignatureResult()Default constructor. -
SignatureResult
public SignatureResult(String id, String correlationId, List<SignedDocument> signedDocuments, SignerAssertionInformation signerAssertionInformation, Extension extension) Constructor.- Parameters:
id
- the ID for the signature operationcorrelationId
- the correlation IDsignedDocuments
- the signed documentssignerAssertionInformation
- information about the signer's "authentication for signature" that was part of the signature operationextension
- extensions for the object
-
-
Method Details
-
getId
Gets the ID for the signature operation. This ID corresponds to the RequestID of the SignRequest and SignResponse.- Returns:
- the operation ID
-
setId
Assigns the ID for the signature operation. This ID corresponds to the RequestID of the SignRequest and SignResponse.- Parameters:
id
- the operation ID
-
getCorrelationId
Gets the correlation ID. This is the ID that is used in all logging events.- Returns:
- the correlation ID
-
setCorrelationId
Assigns the correlation ID. This is the ID that is used in all logging events.- Parameters:
correlationId
- the correlationId to use for this process
-
getSignedDocuments
Gets the signed documents.- Returns:
- the signed documents
-
setSignedDocuments
Assigns the signed documents.- Parameters:
signedDocuments
- the signed documents
-
getSignerAssertionInformation
Gets information about the signer's "authentication for signature" that was part of the signature operation.- Returns:
- the assertion information
-
setSignerAssertionInformation
Assigns information about the signer's "authentication for signature" that was part of the signature operation.- Parameters:
signerAssertionInformation
- assertion information
-
getExtension
Returns the extension parameters for the instance.- Specified by:
getExtension
in interfaceExtensible
- Returns:
- the extension, or
null
if no extensions are set
-
setExtension
Assigns the extension parameters for the instance.- Specified by:
setExtension
in interfaceExtensible
- Parameters:
extension
- the extension
-