Package se.swedenconnect.spring.saml.idp.settings

Class MetadataSettings

java.lang.Object

se.swedenconnect.spring.saml.idp.settings.AbstractSettings

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

All Implemented Interfaces:

Serializable

public class MetadataSettings
extends AbstractSettings

Settings for the IdP metadata.

Author:

Martin Lindström

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MetadataSettings.Builder	A builder for MetadataSettings.
static class	MetadataSettings.ContactPersonSettings	Configuration for ContactPerson metadata element.
static enum	MetadataSettings.ContactPersonType	ContactPerson types.
static class	MetadataSettings.EncryptionMethodSettings	Configuration for EncryptionMethod metadata elements.
static class	MetadataSettings.OrganizationSettings	Configuration for Organization metadata element.
static class	MetadataSettings.SigningMethodSettings	Configuration for SigningMethod metadata elements.
static class	MetadataSettings.UIInfoSettings	Configuration for UIInfo metadata element.

Nested classes/interfaces inherited from class se.swedenconnect.spring.saml.idp.settings.AbstractSettings

AbstractSettings.AbstractBuilder<T extends AbstractSettings,B extends AbstractSettings.AbstractBuilder<T,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SAML_METADATA_CACHE_DURATION	Tells how long the published IdP metadata can remain in a cache.
static final Duration	SAML_METADATA_CACHE_DURATION_DEFAULT	Default cache duration.
static final String	SAML_METADATA_CONTACT_PERSONS	A Map where the keys are MetadataSettings.ContactPersonType and the values MetadataSettings.ContactPersonSettings.
static final String	SAML_METADATA_DIGEST_METHODS	The alg:DigestMethod elements that should be included in the metadata.
static final String	SAML_METADATA_DIGEST_METHODS_UNDER_ROLE	Whether alg:DigestMethod elements should be placed in an Extensions element under the role descriptor (i.e., the IDPSSODescriptor).
static final String	SAML_METADATA_ENCRYPTION_METHODS	The md:EncryptionMethod elements that should be included under the md:KeyDescriptor for the encryption key.
static final String	SAML_METADATA_ORGANIZATION	The Organization element.
static final String	SAML_METADATA_REQUESTED_PRINCIPAL_SELECTION	Attribute names that should be included under the RequestedPrincipalSelection metadata extension.
static final String	SAML_METADATA_SIGNING_METHODS	The alg:SigningMethod elements that should be included in the metadata.
static final String	SAML_METADATA_SIGNING_METHODS_UNDER_ROLE	Whether alg:SigningMethod elements should be placed in an Extensions element under the role descriptor (i.e., the IDPSSODescriptor).
static final String	SAML_METADATA_TEMPLATE	A template for the IdP metadata.
static final String	SAML_METADATA_UI_INFO	The UIInfo element.
static final String	SAML_METADATA_VALIDITY	Tells for how long a published metadata entry should be valid.
static final Duration	SAML_METADATA_VALIDITY_DEFAULT	Default metadata validity.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetadataSettings(Map<String,Object> settings)	Constructor.

Method Summary

Modifier and Type	Method	Description
static MetadataSettings.Builder	builder()	Constructs a new MetadataSettings.Builder with no settings.
Duration	getCacheDuration()	Tells how long the published IdP metadata can remain in a cache.
Map<MetadataSettings.ContactPersonType,MetadataSettings.ContactPersonSettings>	getContactPersons()	Gets a Map where the keys are MetadataSettings.ContactPersonType and the values MetadataSettings.ContactPersonSettings.
List<String>	getDigestMethods()	Gets the alg:DigestMethod elements that should be included in the metadata.
Boolean	getDigestMethodsUnderRole()	Tells whether alg:DigestMethod elements should be placed in an Extensions element under the role descriptor (i.e., the IDPSSODescriptor).
List<MetadataSettings.EncryptionMethodSettings>	getEncryptionMethods()	Gets the md:EncryptionMethod elements that should be included under the md:KeyDescriptor for the encryption key.
MetadataSettings.OrganizationSettings	getOrganization()	Gets the Organization element.
List<String>	getRequestedPrincipalSelection()	Gets the attribute names that should be included under the RequestedPrincipalSelection metadata extension.
List<MetadataSettings.SigningMethodSettings>	getSigningMethods()	Gets the alg:SigningMethod elements that should be included in the metadata.
Boolean	getSigningMethodsUnderRole()	Tells whether alg:SigningMethod elements should be placed in an Extensions element under the role descriptor (i.e., the IDPSSODescriptor).
Resource	getTemplate()	Gets the template for the IdP metadata.
MetadataSettings.UIInfoSettings	getUiInfo()	Gets the MetadataSettings.UIInfoSettings.
Duration	getValidityPeriod()	Tells for how long a published metadata entry should be valid.
static MetadataSettings.Builder	withSettings(Map<String,Object> settings)	Constructs a new MetadataSettings.Builder with the provided settings.

Methods inherited from class se.swedenconnect.spring.saml.idp.settings.AbstractSettings

equals, getSetting, getSettings, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SAML_METADATA_TEMPLATE

public static final String SAML_METADATA_TEMPLATE

A template for the IdP metadata. A Resource.

See Also:

• Constant Field Values

SAML_METADATA_CACHE_DURATION_DEFAULT

public static final Duration SAML_METADATA_CACHE_DURATION_DEFAULT

Default cache duration.

SAML_METADATA_CACHE_DURATION

public static final String SAML_METADATA_CACHE_DURATION

Tells how long the published IdP metadata can remain in a cache. A Duration.

See Also:

• Constant Field Values

SAML_METADATA_VALIDITY_DEFAULT

public static final Duration SAML_METADATA_VALIDITY_DEFAULT

Default metadata validity.

SAML_METADATA_VALIDITY

public static final String SAML_METADATA_VALIDITY

Tells for how long a published metadata entry should be valid. A Duration.

See Also:

• Constant Field Values

SAML_METADATA_DIGEST_METHODS

public static final String SAML_METADATA_DIGEST_METHODS

The alg:DigestMethod elements that should be included in the metadata. A List of strings.

See Also:

• Constant Field Values

SAML_METADATA_DIGEST_METHODS_UNDER_ROLE

public static final String SAML_METADATA_DIGEST_METHODS_UNDER_ROLE

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. A Boolean.

See Also:

• Constant Field Values

SAML_METADATA_SIGNING_METHODS

public static final String SAML_METADATA_SIGNING_METHODS

The alg:SigningMethod elements that should be included in the metadata. A List of MetadataSettings.SigningMethodSettings.

See Also:

• Constant Field Values

SAML_METADATA_SIGNING_METHODS_UNDER_ROLE

public static final String SAML_METADATA_SIGNING_METHODS_UNDER_ROLE

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. A Boolean.

See Also:

• Constant Field Values

SAML_METADATA_ENCRYPTION_METHODS

public static final String SAML_METADATA_ENCRYPTION_METHODS

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. List of MetadataSettings.EncryptionMethodSettings.

See Also:

• Constant Field Values

SAML_METADATA_UI_INFO

public static final String SAML_METADATA_UI_INFO

The UIInfo element. A MetadataSettings.UIInfoSettings.

See Also:

• Constant Field Values

SAML_METADATA_REQUESTED_PRINCIPAL_SELECTION

public static final String SAML_METADATA_REQUESTED_PRINCIPAL_SELECTION

Attribute names that should be included under the RequestedPrincipalSelection metadata extension. A List of Strings.

See Also:

• Constant Field Values

SAML_METADATA_ORGANIZATION

public static final String SAML_METADATA_ORGANIZATION

The Organization element. A MetadataSettings.OrganizationSettings.

See Also:

• Constant Field Values

SAML_METADATA_CONTACT_PERSONS

public static final String SAML_METADATA_CONTACT_PERSONS

A Map where the keys are MetadataSettings.ContactPersonType and the values MetadataSettings.ContactPersonSettings.

See Also:

• Constant Field Values

Constructor Details

MetadataSettings

protected MetadataSettings(Map<String,Object> settings)

Constructor.

Parameters:

settings - the settings

Method Details

getTemplate

public Resource getTemplate()

Gets the template for the IdP metadata.

Returns:

the template or null if not assigned.

getCacheDuration

public Duration getCacheDuration()

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

Returns:

a Duration

getValidityPeriod

public Duration getValidityPeriod()

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

Returns:

a Duration

getDigestMethods

public List<String> getDigestMethods()

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

Returns:

a list of algorithms

getDigestMethodsUnderRole

public Boolean getDigestMethodsUnderRole()

Tells 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.

Returns:

where to place elements

getSigningMethods

public List<MetadataSettings.SigningMethodSettings> getSigningMethods()

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

Returns:

a list of signing methods

getSigningMethodsUnderRole

public Boolean getSigningMethodsUnderRole()

Tells 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.

Returns:

where to place elements

getEncryptionMethods

public List<MetadataSettings.EncryptionMethodSettings> getEncryptionMethods()

Gets 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.

Returns:

a list of MetadataSettings.EncryptionMethodSettings

getUiInfo

public MetadataSettings.UIInfoSettings getUiInfo()

Gets the MetadataSettings.UIInfoSettings.

Returns:

MetadataSettings.UIInfoSettings or null

getRequestedPrincipalSelection

public List<String> getRequestedPrincipalSelection()

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

Returns:

list of attribute names

getOrganization

public MetadataSettings.OrganizationSettings getOrganization()

Gets the Organization element.

Returns:

a MetadataSettings.OrganizationSettings or null

getContactPersons

public Map<MetadataSettings.ContactPersonType,MetadataSettings.ContactPersonSettings> getContactPersons()

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

Returns:

a map of contact persons

builder

public static MetadataSettings.Builder builder()

Constructs a new MetadataSettings.Builder with no settings.

Returns:

the MetadataSettings.Builder

withSettings

public static MetadataSettings.Builder withSettings(Map<String,Object> settings)

Constructs a new MetadataSettings.Builder with the provided settings.

Parameters:

settings - the settings to initialize the builder

Returns:

the builder