Package se.idsec.signservice.integration.signmessage

Class SignMessageParameters

java.lang.Object
se.idsec.signservice.integration.signmessage.SignMessageParameters
All Implemented Interfaces:
Serializable
public class SignMessageParameters extends Object implements Serializable
A representation of sign message parameters.
Author:
Martin Lindström (martin@idsec.se), Stefan Santesson (stefan@idsec.se)
See Also:

  • Constructor Details

    • SignMessageParameters

      public SignMessageParameters()

  • Method Details

    • getSignMessage

      public String getSignMessage()
      Gets the sign message (non encrypted) content according to specified mime type.
      Returns:
      the sign message

    • setSignMessage

      public void setSignMessage(String signMessage)
      Assigns the sign message (non encrypted) content according to specified mime type.
      Parameters:
      signMessage - the sign message

    • isPerformEncryption

      public boolean isPerformEncryption()
      Tells whether the supplied sign message should be encrypted with getDisplayEntity() as the recipient.
      Returns:
      tells whether encryption should be performed

    • setPerformEncryption

      public void setPerformEncryption(boolean performEncryption)
      Assigns whether the supplied sign message should be encrypted with getDisplayEntity() as the recipient.
      Parameters:
      performEncryption - Tells whether the supplied sign message should be encrypted

    • getMimeType

      public String getMimeType()
      Gets the sign message MIME type. See SignMessageMimeType for possible values.
      Returns:
      the MIME type, or null which defaults to SignMessageMimeType.TEXT.

    • setMimeType

      public void setMimeType(String mimeType)
      The sign message MIME type. See SignMessageMimeType for possible values.
      Parameters:
      mimeType - the MIME type

    • setMimeType

      public void setMimeType(SignMessageMimeType mimeType)
      The sign message MIME type.
      Parameters:
      mimeType - the MIME type

    • getMustShow

      public Boolean getMustShow()
      Specifies if the requester of the signature requires that the sign message is displayed to the user. If the Identity Provider cannot fulfill this requirement it must not proceed.
      Returns:
      the MustShow flag, or null

    • setMustShow

      public void setMustShow(Boolean mustShow)
      Specifies if the requester of the signature requires that the sign message is displayed to the user. If the Identity Provider cannot fulfill this requirement it must not proceed.
      Parameters:
      mustShow - the MustShow attribute

    • getDisplayEntity

      public String getDisplayEntity()
      Gets the ID (SAML entityID) of the entity (IdP) that should display this message.
      Returns:
      the entityID of the IdP that should display the message

    • setDisplayEntity

      public void setDisplayEntity(String displayEntity)
      Assigns the ID (SAML entityID) of the entity (IdP) that should display this message.

      Note: The DisplayEntity attribute of the SignMessage element is required if the sign message is to be encrypted. In almost all cases, except for some odd Proxy-IdP cases, this is the same value as the ID that is supplied in the authentication requirements (AuthnRequirements). Therefore, if this method returns null, and the message should be encrypted, the SignService Integration Service will use the AuthnRequirements.getAuthnServiceID() value.

      Parameters:
      displayEntity - the SAML entityID for the display entity