Package se.idsec.signservice.integration.signmessage

Class SignMessageParameters.SignMessageParametersBuilder

java.lang.Object

se.idsec.signservice.integration.signmessage.SignMessageParameters.SignMessageParametersBuilder

All Implemented Interfaces:

ObjectBuilder<SignMessageParameters>

Enclosing class:

SignMessageParameters

public static class SignMessageParameters.SignMessageParametersBuilder
extends Object
implements ObjectBuilder<SignMessageParameters>

A builder for SignMessageParameters.

Method Summary

Modifier and Type	Method	Description
SignMessageParameters	build()	Builds the object.
SignMessageParameters.SignMessageParametersBuilder	displayEntity(String displayEntity)	The ID (SAML entityID) of the entity (IdP) that should display this message.
SignMessageParameters.SignMessageParametersBuilder	mimeType(String mimeType)	The sign message MIME type.
SignMessageParameters.SignMessageParametersBuilder	mimeType(SignMessageMimeType mimeType)	The sign message MIME type.
SignMessageParameters.SignMessageParametersBuilder	mustShow(Boolean mustShow)	Specifies if the requester of the signature requires that the sign message is displayed to the user.
SignMessageParameters.SignMessageParametersBuilder	performEncryption(boolean performEncryption)	Tells whether the supplied sign message should be encrypted with SignMessageParameters.getDisplayEntity() as the recipient.
SignMessageParameters.SignMessageParametersBuilder	signMessage(String signMessage)	The sign message (non encrypted) content according to specified mime type.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

mimeType

public SignMessageParameters.SignMessageParametersBuilder mimeType(String mimeType)

The sign message MIME type.

Parameters:

mimeType - the MIME type

Returns:

the builder

mimeType

public SignMessageParameters.SignMessageParametersBuilder mimeType(SignMessageMimeType mimeType)

The sign message MIME type.

Parameters:

mimeType - the MIME type

Returns:

the builder

signMessage

public SignMessageParameters.SignMessageParametersBuilder signMessage(String signMessage)

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

Parameters:

signMessage - the sign message

Returns:

this.

performEncryption

public SignMessageParameters.SignMessageParametersBuilder performEncryption(boolean performEncryption)

Tells whether the supplied sign message should be encrypted with SignMessageParameters.getDisplayEntity() as the recipient.

Parameters:

performEncryption - Tells whether the supplied sign message should be encrypted

Returns:

this.

mustShow

public SignMessageParameters.SignMessageParametersBuilder mustShow(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

Returns:

this.

displayEntity

public SignMessageParameters.SignMessageParametersBuilder displayEntity(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

Returns:

this.

build

public SignMessageParameters build()

Description copied from interface: ObjectBuilder

Builds the object.

Specified by:

build in interface ObjectBuilder<SignMessageParameters>

Returns:

the object

toString

public String toString()

Overrides:

toString in class Object