Package se.swedenconnect.spring.saml.idp.extensions

Class SignatureMessageExtension

java.lang.Object

se.swedenconnect.spring.saml.idp.extensions.SignatureMessageExtension

All Implemented Interfaces:

Serializable

public class SignatureMessageExtension
extends Object
implements Serializable

A representation of the SignMessage extension as specified in section 3.1.2 of DSS Extension for Federated Central Signing Services.

The {code SignatureMessageExtension} holds the decrypted version of a SignMessage object.

Author:

Martin Lindström

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SignatureMessageExtension(String message, se.swedenconnect.opensaml.sweid.saml2.signservice.dss.SignMessageMimeTypeEnum mimeType, Boolean mustShow)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Gets the (base64 encoded) sign message.
se.swedenconnect.opensaml.sweid.saml2.signservice.dss.SignMessageMimeTypeEnum	getMimeType()	Gets the MIME type of the sign message.
String	getProcessedMessage()	Gets the processed message.
boolean	isMustShow()	Whether the caller has indicated that the sign message MUST be displayed for the user.
void	setProcessedMessage(String processedMessage)	Assigns the processed message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SignatureMessageExtension

public SignatureMessageExtension(String message,
 se.swedenconnect.opensaml.sweid.saml2.signservice.dss.SignMessageMimeTypeEnum mimeType,
 Boolean mustShow)

Constructor.

Parameters:

message - the unencrypted sign message (in base64)

mimeType - the message MIME type - if null, SignMessageMimeTypeEnum.TEXT is assumed

mustShow - whether the caller has indicated that the sign message MUST be displayed for the user

Method Details

getMessage

public String getMessage()

Gets the (base64 encoded) sign message.

Returns:

the sign message

getMimeType

public se.swedenconnect.opensaml.sweid.saml2.signservice.dss.SignMessageMimeTypeEnum getMimeType()

Gets the MIME type of the sign message. Defaults to SignMessageMimeTypeEnum.TEXT.

Returns:

the sign message MIME type

isMustShow

public boolean isMustShow()

Whether the caller has indicated that the sign message MUST be displayed for the user.

Returns:

true if the message must be displayed for the user and false otherwise

getProcessedMessage

public String getProcessedMessage()

Gets the processed message. If a SignatureMessagePreprocessor is installed, the processedMessage will contain the result from this processing, i.e., a string that is prepared for display (on a web page, on a device, ...).

Returns:

a message prepared for display

setProcessedMessage

public void setProcessedMessage(String processedMessage)

Assigns the processed message. If a SignatureMessagePreprocessor is installed, the processedMessage will contain the result from this processing, i.e., a string that is prepared for display (on a web page, on a device, ...).

Parameters:

processedMessage - a message prepared for display