Class MetadataSettings.Builder

java.lang.Object

se.swedenconnect.spring.saml.idp.settings.AbstractSettings.AbstractBuilder<MetadataSettings, MetadataSettings.Builder>

se.swedenconnect.spring.saml.idp.settings.MetadataSettings.Builder

Enclosing class:

MetadataSettings

public static final class MetadataSettings.Builder
extends AbstractSettings.AbstractBuilder<MetadataSettings, MetadataSettings.Builder>

A builder for MetadataSettings.

Author:

Martin Lindström

Method Summary

Modifier and Type	Method	Description
protected void	applyDefaultSettings()	Is invoked by AbstractSettings.AbstractBuilder.build() to apply default values to those settings that are mandatory and has not been assigned.
protected MetadataSettings	buildObject()	Is invoked by AbstractSettings.AbstractBuilder.build() and builds the settings object.
MetadataSettings.Builder	cacheDuration(Duration cacheDuration)	Assigns how long the published IdP metadata can remain in a cache.
MetadataSettings.Builder	contactPersons(Map<MetadataSettings.ContactPersonType, MetadataSettings.ContactPersonSettings> contactPersons)	Assigns a Map where the keys are MetadataSettings.ContactPersonType and the values MetadataSettings.ContactPersonSettings.
MetadataSettings.Builder	digestMethods(List<String> digestMethods)	Assigns the alg:DigestMethod elements that should be included in the metadata.
MetadataSettings.Builder	digestMethodsUnderRole(Boolean underRole)	Assigns whether alg:DigestMethod elements should be placed in an Extensions element under the role descriptor (i.e., the IDPSSODescriptor).
MetadataSettings.Builder	encryptionMethods(List<MetadataSettings.EncryptionMethodSettings> encryptionMethods)	Assigns the md:EncryptionMethod elements that should be included under the md:KeyDescriptor for the encryption key.
MetadataSettings.Builder	organization(MetadataSettings.OrganizationSettings organization)	Assigns the Organization element.
MetadataSettings.Builder	requestedPrincipalSelection(List<String> attributeNames)	Assigns the attribute names that should be included under the RequestedPrincipalSelection metadata extension.
MetadataSettings.Builder	signingMethods(List<MetadataSettings.SigningMethodSettings> signingMethods)	Assigns the alg:SigningMethod elements that should be included in the metadata.
MetadataSettings.Builder	signingMethodsUnderRole(Boolean underRole)	Assigns whether alg:SigningMethod elements should be placed in an Extensions element under the role descriptor (i.e., the IDPSSODescriptor).
MetadataSettings.Builder	template(Resource template)	Assigns the template for the IdP metadata.
MetadataSettings.Builder	uiInfo(MetadataSettings.UIInfoSettings uiInfo)	Assigns the MetadataSettings.UIInfoSettings.
MetadataSettings.Builder	validityPeriod(Duration validityPeriod)	Assigns for how long a published metadata entry should be valid.

Methods inherited from class AbstractSettings.AbstractBuilder

build, getSettings, getThis, setting, settings

Methods inherited from class Object

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

Method Details

template

public MetadataSettings.Builder template(Resource template)

Assigns the template for the IdP metadata.

Parameters:

template - the metadata template

Returns:

the builder

cacheDuration

public MetadataSettings.Builder cacheDuration(Duration cacheDuration)

Assigns how long the published IdP metadata can remain in a cache.

Parameters:

cacheDuration - the cache duration

Returns:

the builder

validityPeriod

public MetadataSettings.Builder validityPeriod(Duration validityPeriod)

Assigns for how long a published metadata entry should be valid.

Parameters:

validityPeriod - for how long a published metadata entry should be valid

Returns:

the builder

digestMethods

public MetadataSettings.Builder digestMethods(List<String> digestMethods)

Assigns the alg:DigestMethod elements that should be included in the metadata.

Parameters:

digestMethods - a list of algorithms

Returns:

the builder

digestMethodsUnderRole

public MetadataSettings.Builder digestMethodsUnderRole(Boolean underRole)

Assigns whether alg:DigestMethod elements should be placed in an Extensions element under the role descriptor (i.e., the IDPSSODescriptor). If false, the alg:DigestMethod elements are included as elements in the Extensions element of the EntityDescriptor.

Parameters:

underRole - assign under role

Returns:

where to place elements

signingMethods

public MetadataSettings.Builder signingMethods(List<MetadataSettings.SigningMethodSettings> signingMethods)

Assigns the alg:SigningMethod elements that should be included in the metadata.

Parameters:

signingMethods - the signing methods

Returns:

a list of signing methods

signingMethodsUnderRole

public MetadataSettings.Builder signingMethodsUnderRole(Boolean underRole)

Assigns whether alg:SigningMethod elements should be placed in an Extensions element under the role descriptor (i.e., the IDPSSODescriptor). If false, the alg:SigningMethod elements are included as elements in the Extensions element of the EntityDescriptor.

Parameters:

underRole - assign under role

Returns:

where to place elements

encryptionMethods

public MetadataSettings.Builder encryptionMethods(List<MetadataSettings.EncryptionMethodSettings> encryptionMethods)

Assigns the md:EncryptionMethod elements that should be included under the md:KeyDescriptor for the encryption key. Note that these algorithms must match the configured encryption key.

Parameters:

encryptionMethods - a list of MetadataSettings.EncryptionMethodSettings

Returns:

the builder

uiInfo

public MetadataSettings.Builder uiInfo(MetadataSettings.UIInfoSettings uiInfo)

Assigns the MetadataSettings.UIInfoSettings.

Parameters:

uiInfo - MetadataSettings.UIInfoSettings

Returns:

the builder

requestedPrincipalSelection

public MetadataSettings.Builder requestedPrincipalSelection(List<String> attributeNames)

Assigns the attribute names that should be included under the RequestedPrincipalSelection metadata extension.

Parameters:

attributeNames - list of attribute names

Returns:

the builder

organization

public MetadataSettings.Builder organization(MetadataSettings.OrganizationSettings organization)

Assigns the Organization element.

Parameters:

organization - an MetadataSettings.OrganizationSettings

Returns:

the builder

contactPersons

public MetadataSettings.Builder contactPersons(Map<MetadataSettings.ContactPersonType, MetadataSettings.ContactPersonSettings> contactPersons)

Assigns a Map where the keys are MetadataSettings.ContactPersonType and the values MetadataSettings.ContactPersonSettings.

Parameters:

contactPersons - a map of contact persons

Returns:

the builder

applyDefaultSettings

protected void applyDefaultSettings()

Is invoked by AbstractSettings.AbstractBuilder.build() to apply default values to those settings that are mandatory and has not been assigned.

Specified by:

applyDefaultSettings in class AbstractSettings.AbstractBuilder<MetadataSettings, MetadataSettings.Builder>

buildObject

protected MetadataSettings buildObject()

Is invoked by AbstractSettings.AbstractBuilder.build() and builds the settings object.

Specified by:

buildObject in class AbstractSettings.AbstractBuilder<MetadataSettings, MetadataSettings.Builder>

Returns:

the settings object