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:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SignMessageParameters.SignMessageParametersBuilder	A builder for SignMessageParameters.

Constructor Summary

Constructors

Constructor	Description
SignMessageParameters()
SignMessageParameters(String signMessage, boolean performEncryption, String mimeType, Boolean mustShow, String displayEntity)

Method Summary

Modifier and Type	Method	Description
static SignMessageParameters.SignMessageParametersBuilder	builder()
String	getDisplayEntity()	The ID (SAML entityID) of the entity (IdP) that should display this message.
String	getMimeType()	The sign message MIME type.
Boolean	getMustShow()	Specifies if the requester of the signature requires that the sign message is displayed to the user.
String	getSignMessage()	The sign message (non encrypted) content according to specified mime type.
boolean	isPerformEncryption()	Tells whether the supplied sign message should be encrypted with getDisplayEntity() as the recipient.
void	setDisplayEntity(String displayEntity)	The ID (SAML entityID) of the entity (IdP) that should display this message.
void	setMimeType(String mimeType)	The sign message MIME type.
void	setMimeType(SignMessageMimeType mimeType)	The sign message MIME type.
void	setMustShow(Boolean mustShow)	Specifies if the requester of the signature requires that the sign message is displayed to the user.
void	setPerformEncryption(boolean performEncryption)	Tells whether the supplied sign message should be encrypted with getDisplayEntity() as the recipient.
void	setSignMessage(String signMessage)	The sign message (non encrypted) content according to specified mime type.
SignMessageParameters.SignMessageParametersBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SignMessageParameters

public SignMessageParameters()

SignMessageParameters

public SignMessageParameters(String signMessage,
 boolean performEncryption,
 String mimeType,
 Boolean mustShow,
 String displayEntity)

Method Details

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

builder

public static SignMessageParameters.SignMessageParametersBuilder builder()

toBuilder

public SignMessageParameters.SignMessageParametersBuilder toBuilder()

toString

public String toString()

Overrides:

toString in class Object

setSignMessage

public void setSignMessage(String signMessage)

The sign message (non encrypted) content according to specified mime type.

Parameters:

signMessage - the sign message

getSignMessage

public String getSignMessage()

The sign message (non encrypted) content according to specified mime type.

Returns:

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)

Tells 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()

The sign message MIME type. See SignMessageMimeType for possible values.

Returns:

the MIME type, or null which defaults to SignMessageMimeType.TEXT.

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

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

setDisplayEntity

public void setDisplayEntity(String displayEntity)

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

getDisplayEntity

public String getDisplayEntity()

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.

Returns:

the entityID of the IdP that should display the message