Package se.idsec.signservice.integration

Class SignRequestInput

java.lang.Object
se.idsec.signservice.integration.SignRequestInput
All Implemented Interfaces:
Serializable, Extensible
public class SignRequestInput extends Object implements Extensible
Class that represents the input to a SignServiceIntegrationService.createSignRequest(SignRequestInput) operation.
Author:
Martin Lindström (martin@idsec.se), Stefan Santesson (stefan@idsec.se)
See Also:

  • Constructor Details

  • Method Details

    • getCorrelationId

      public String getCorrelationId()
      Gets the correlation ID for the process.

      See setCorrelationId(String) for more information about the correlation ID.

      Returns:
      the correlation ID or null if not has been assigned

    • setCorrelationId

      public void setCorrelationId(String correlationId)
      Assigns the correlation ID for the process.

      A sign requester may want to have the possibility to track an operation (via logs or by other means). Therefore, the use of correlation ID:s is supported by the SignService Integration Service. If a correlation ID is supplied this will be used in process and audit logs, and will be tied to the actual signature state ID that is generated by the SignService Integration Service.

      Note: The correlation ID is never sent to the sign service. It is only used within the SignService Integration Service.

      Parameters:
      correlationId - the correlation ID

    • getPolicy

      public String getPolicy()
      Gets the policy.
      Returns:
      the policy identifier for this operation, or null (that denotes the default policy)

    • setPolicy

      public void setPolicy(String policy)
      Assigns the policy to use.

      A SignService Integration Service may be running under different policies, where a policy tells which IntegrationServiceDefaultConfiguration that is active.

      Parameters:
      policy - the policy identifier to use for the operation

    • getSignRequesterID

      public String getSignRequesterID()
      Gets the entityID of the entity that requests a signature.
      Returns:
      the sign requester ID, or null if the default ID should be used

    • setSignRequesterID

      public void setSignRequesterID(String signRequesterID)
      Assigns the entityID of the entity that requests a signature.

      If not provided the SignatureService Integration Service will use the default sign requester ID (IntegrationServiceDefaultConfiguration.getDefaultSignRequesterID()).

      Parameters:
      signRequesterID - the sign requester ID

    • getReturnUrl

      public String getReturnUrl()
      Gets the URL to which the user agent along with the sign response message should be directed after a signature operation.
      Returns:
      the URL to which a sign response is to be returned, or null if the default URL should be used

    • setReturnUrl

      public void setReturnUrl(String returnUrl)
      Assigns the URL to which the user agent along with the sign response message should be directed after a signature operation.

      If not provided the SignatureService Integration Service will use the default return URL (IntegrationServiceDefaultConfiguration.getDefaultReturnUrl()).

      Parameters:
      returnUrl - the URL to which a sign response is to be returned

    • getDestinationUrl

      public String getDestinationUrl()
      Gets the signature service URL to where SignRequest messages should be posted.
      Returns:
      the signature service URL to where SignRequest messages should be posted, or null if the default should be used

    • setDestinationUrl

      public void setDestinationUrl(String destinationUrl)
      Assigns the signature service URL to where SignRequest messages should be posted.

      If not provided the SignatureService Integration Service will use the default return URL (IntegrationServiceDefaultConfiguration.getDefaultDestinationUrl()).

      Parameters:
      destinationUrl - the signature service URL to where SignRequest messages should be posted

    • getSignatureAlgorithm

      public String getSignatureAlgorithm()
      Gets the algorithm identifier for the signature algorithm that should be used to sign the specified documents.
      Returns:
      signature algorithm identifier, or null for default algorithm

    • setSignatureAlgorithm

      public void setSignatureAlgorithm(String signatureAlgorithm)
      Assigns the algorithm identifier for the signature algorithm that should be used to sign the specified documents.

      If not provided the SignatureService Integration Service will use the default signature algorithm (IntegrationServiceDefaultConfiguration.getDefaultSignatureAlgorithm()).

      Parameters:
      signatureAlgorithm - signature algorithm identifier

    • getAuthnRequirements

      public AuthnRequirements getAuthnRequirements()
      Gets the requirements that the sign requester has on the principal that is to perform the signature operation.
      Returns:
      the authentication requirements

    • setAuthnRequirements

      public void setAuthnRequirements(AuthnRequirements authnRequirements)
      Assigns the requirements that the sign requester has on the principal that is to perform the signature operation.
      Parameters:
      authnRequirements - authentication requirements

    • getCertificateRequirements

      public SigningCertificateRequirements getCertificateRequirements()
      Gets the requirements for the signature certificate that will be issued by the sign service.
      Returns:
      requirements for the signing certificate, or null for default requirements

    • setCertificateRequirements

      public void setCertificateRequirements(SigningCertificateRequirements certificateRequirements)
      Assigns the requirements for the signature certificate that will be issued by the sign service.

      If not provided the SignatureService Integration Service will use the default requirements (IntegrationServiceDefaultConfiguration.getDefaultCertificateRequirements()).

      Parameters:
      certificateRequirements - the requirements for the signing certificate

    • getTbsDocuments

      public List<TbsDocument> getTbsDocuments()
      Gets the document(s) to be signed along with a per document signing requirements and parameters.
      Returns:
      a list of To-be-signed documents

    • setTbsDocuments

      public void setTbsDocuments(List<TbsDocument> tbsDocuments)
      Assigns the document(s) to be signed along with a per document signing requirements and parameters. At least one document must be supplied.
      Parameters:
      tbsDocuments - a list of To-be-signed documents

    • getSignMessageParameters

      public SignMessageParameters getSignMessageParameters()
      Gets the sign message parameters that is used to build the sign message element that is included in the SignRequest.
      Returns:
      the sign message parameters

    • setSignMessageParameters

      public void setSignMessageParameters(SignMessageParameters signMessageParameters)
      Assigns the sign message parameters that is used to build the sign message element that is included in the SignRequest.
      Parameters:
      signMessageParameters - the sign message parameters

    • getExtension

      public Extension getExtension()
      Returns the extension parameters for the instance.
      Specified by:
      getExtension in interface Extensible
      Returns:
      the extension, or null if no extensions are set

    • setExtension

      public void setExtension(Extension extension)
      Assigns the extension parameters for the instance.
      Specified by:
      setExtension in interface Extensible
      Parameters:
      extension - the extension

    • builder

      public static SignRequestInput.SignRequestInputBuilder builder()

    • toBuilder

      public SignRequestInput.SignRequestInputBuilder toBuilder()

    • toString

      public String toString()
      Overrides:
      toString in class Object