Class MetadataProviderSettings.Builder

java.lang.Object

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

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

Enclosing class:

MetadataProviderSettings

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

A builder for MetadataProviderSettings.

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.
MetadataProviderSettings.Builder	backupLocation(File backupLocation)	Assigns the backup file.
protected MetadataProviderSettings	buildObject()	Is invoked by AbstractSettings.AbstractBuilder.build() and builds the settings object.
MetadataProviderSettings.Builder	httpProxy(MetadataProviderSettings.HttpProxySettings httpProxy)	Assigns the HTTP proxy settings.
MetadataProviderSettings.Builder	httpsTrustBundle(String httpsTrustBundle)	Assigns the Spring SSL Bundle that gives us the TLS trust settings to use during TLS verification.
MetadataProviderSettings.Builder	location(Resource location)	Assigns the location of the metadata.
MetadataProviderSettings.Builder	mdq(Boolean mdq)	Assigns whether MDQ should be used.
MetadataProviderSettings.Builder	skipHostnameVerification(Boolean skip)	Tells whether to skip hostname verification in the TLS connection (useful during testing).
MetadataProviderSettings.Builder	validationCertificate(X509Certificate validationCertificate)	Assigns the certificate used to validate the metadata.

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

location

public MetadataProviderSettings.Builder location(Resource location)

Assigns the location of the metadata. Can be a URL, a file, or even a classpath resource.

Parameters:

location - the metadata location

Returns:

the builder

httpsTrustBundle

public MetadataProviderSettings.Builder httpsTrustBundle(String httpsTrustBundle)

Assigns the Spring SSL Bundle that gives us the TLS trust settings to use during TLS verification. If not specified, the Java trust default will be used.

Only relevant if the location is an HTTPS resource.

Parameters:

httpsTrustBundle - name for a trust SSL bundle

Returns:

the builder

skipHostnameVerification

public MetadataProviderSettings.Builder skipHostnameVerification(Boolean skip)

Tells whether to skip hostname verification in the TLS connection (useful during testing).

Parameters:

skip - true if hostname verification should be skipped

Returns:

the builder

backupLocation

public MetadataProviderSettings.Builder backupLocation(File backupLocation)

Assigns the backup file.

If the location setting is an URL, a "backup location" may be assigned to store downloaded metadata.

Parameters:

backupLocation - the backup location file

Returns:

the builder

mdq

public MetadataProviderSettings.Builder mdq(Boolean mdq)

Assigns whether MDQ should be used.

If the location setting is an URL, setting the MDQ-flag means that the metadata MDQ (https://www.ietf.org/id/draft-young-md-query-17.html) protocol is used.

Parameters:

mdq - whether MDQ should be used

Returns:

the builder

validationCertificate

public MetadataProviderSettings.Builder validationCertificate(X509Certificate validationCertificate)

Assigns the certificate used to validate the metadata.

Parameters:

validationCertificate - the validation certificate

Returns:

the builder

httpProxy

public MetadataProviderSettings.Builder httpProxy(MetadataProviderSettings.HttpProxySettings httpProxy)

Assigns the HTTP proxy settings.

Parameters:

httpProxy - the proxy settings

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

buildObject

protected MetadataProviderSettings buildObject()

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

Specified by:

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

Returns:

the settings object