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

Class IdentityProviderSettings.Builder

java.lang.Object

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

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

Enclosing class:

IdentityProviderSettings

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

A builder for IdentityProviderSettings.

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.
IdentityProviderSettings.Builder	assertionSettings(AssertionSettings assertionSettings)	Assigns the Identity Provider Assertion settings.
IdentityProviderSettings.Builder	baseUrl(String baseUrl)	Assigns the Identity Provider base URL, i.e., the protocol, domain and context path.
IdentityProviderSettings	buildObject()	Builds the IdentityProviderSettings.
IdentityProviderSettings.Builder	clockSkewAdjustment(Duration clockSkewAdjustment)	Assigns the clock skew adjustment (in both directions) to consider still acceptable messages.
IdentityProviderSettings.Builder	credentials(CredentialSettings credentials)	Assigns the Identity Provider credentials.
IdentityProviderSettings.Builder	endpoints(EndpointSettings endpoints)	Assigns the IdP endpoints.
IdentityProviderSettings.Builder	entityId(String entityId)	Assigns the SAML entityID of the Identity Provider.
IdentityProviderSettings.Builder	hokBaseUrl(String hokBaseUrl)	Assigns the Identity Provider base URL for Holder-of-key support, i.e., the protocol, domain and context path.
IdentityProviderSettings.Builder	maxMessageAge(Duration maxMessageAge)	Assigns the maximum allowed age of received messages.
IdentityProviderSettings.Builder	metadata(MetadataSettings metadata)	Assigns the IdP metadata settings.
IdentityProviderSettings.Builder	metadataProvider(org.opensaml.saml.metadata.resolver.MetadataResolver metadataProvider)	Assigns the Identity Provider metadata provider (resolver).
IdentityProviderSettings.Builder	metadataProviderConfiguration(MetadataProviderSettings... metadataProviders)	Assigns the IdP metadata provider configuration settings.
IdentityProviderSettings.Builder	requiresSignedRequests(Boolean requiresSignedRequests)	Assigns whether the IdP requires signed authentication requests.
IdentityProviderSettings.Builder	ssoDurationLimit(Duration ssoDurationLimit)	Assigns for how long may this authentication be re-used.
IdentityProviderSettings.Builder	supportsUserMessage(Boolean supportsUserMessage)	Assigns whether the IdP supports the UserMessage extension.

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

build, getSettings, getThis, setting, settings

Methods inherited from class java.lang.Object

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

Method Details

entityId

public IdentityProviderSettings.Builder entityId(String entityId)

Assigns the SAML entityID of the Identity Provider.

Parameters:

entityId - the entityID

Returns:

the builder

baseUrl

public IdentityProviderSettings.Builder baseUrl(String baseUrl)

Assigns the Identity Provider base URL, i.e., the protocol, domain and context path. Must not end with an '/'.

Parameters:

baseUrl - the IdP base URL

Returns:

the builder

hokBaseUrl

public IdentityProviderSettings.Builder hokBaseUrl(String hokBaseUrl)

Assigns the Identity Provider base URL for Holder-of-key support, i.e., the protocol, domain and context path. Must not end with an '/'.

This setting is optional, and if HoK is being used and that requires a different IdP domain or context path this setting represents this base URL.

Parameters:

hokBaseUrl - the HoK base URL

Returns:

the builder

requiresSignedRequests

public IdentityProviderSettings.Builder requiresSignedRequests(Boolean requiresSignedRequests)

Assigns whether the IdP requires signed authentication requests.

Parameters:

requiresSignedRequests - whether the IdP requires signed authentication requests

Returns:

the builder

clockSkewAdjustment

public IdentityProviderSettings.Builder clockSkewAdjustment(Duration clockSkewAdjustment)

Assigns the clock skew adjustment (in both directions) to consider still acceptable messages.

Parameters:

clockSkewAdjustment - a Duration

Returns:

the builder

maxMessageAge

public IdentityProviderSettings.Builder maxMessageAge(Duration maxMessageAge)

Assigns the maximum allowed age of received messages.

Parameters:

maxMessageAge - a Duration

Returns:

the builder

ssoDurationLimit

public IdentityProviderSettings.Builder ssoDurationLimit(Duration ssoDurationLimit)

Assigns for how long may this authentication be re-used.

Parameters:

ssoDurationLimit - a Duration

Returns:

the builder

supportsUserMessage

public IdentityProviderSettings.Builder supportsUserMessage(Boolean supportsUserMessage)

Assigns whether the IdP supports the UserMessage extension.

Parameters:

supportsUserMessage - whether the UserMessage extension is supported

Returns:

the builder

credentials

public IdentityProviderSettings.Builder credentials(CredentialSettings credentials)

Assigns the Identity Provider credentials.

Parameters:

credentials - the credentials

Returns:

the builder

endpoints

public IdentityProviderSettings.Builder endpoints(EndpointSettings endpoints)

Assigns the IdP endpoints.

Parameters:

endpoints - the endpoints

Returns:

the builder

assertionSettings

public IdentityProviderSettings.Builder assertionSettings(AssertionSettings assertionSettings)

Assigns the Identity Provider Assertion settings.

Parameters:

assertionSettings - the Identity Provider Assertion settings

Returns:

the builder

metadata

public IdentityProviderSettings.Builder metadata(MetadataSettings metadata)

Assigns the IdP metadata settings.

Parameters:

metadata - the IdP metadata settings

Returns:

the builder

metadataProvider

public IdentityProviderSettings.Builder metadataProvider(org.opensaml.saml.metadata.resolver.MetadataResolver metadataProvider)

Assigns the Identity Provider metadata provider (resolver).

A metadata provider may also be set up using metadataProviderConfiguration(MetadataProviderSettings...).

Parameters:

metadataProvider - the metadata resolver to use

Returns:

the builder

See Also:

• metadataProviderConfiguration(MetadataProviderSettings...)

metadataProviderConfiguration

public IdentityProviderSettings.Builder metadataProviderConfiguration(MetadataProviderSettings... metadataProviders)

Assigns the IdP metadata provider configuration settings.

A metadata provider may also be set up using metadataProvider(MetadataResolver).

Parameters:

metadataProviders - an array of metadata provider configuration settings

Returns:

the builder

See Also:

• metadataProvider(MetadataResolver)

buildObject

public IdentityProviderSettings buildObject()

Builds the IdentityProviderSettings.

Specified by:

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

Returns:

the IdentityProviderSettings

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<IdentityProviderSettings,IdentityProviderSettings.Builder>