Package org.springframework.security.saml2.provider.service.metadata

Class OpenSaml5MetadataResolver

java.lang.Object

org.springframework.security.saml2.provider.service.metadata.OpenSaml5MetadataResolver

All Implemented Interfaces:

Saml2MetadataResolver

public final class OpenSaml5MetadataResolver
extends Object
implements Saml2MetadataResolver

Resolves the SAML 2.0 Relying Party Metadata for a given RelyingPartyRegistration using the OpenSAML API.

Since:

5.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenSaml5MetadataResolver.EntityDescriptorParameters	A tuple containing an OpenSAML EntityDescriptor and its associated RelyingPartyRegistration

Constructor Summary

Constructors

Constructor	Description
OpenSaml5MetadataResolver()

Method Summary

Modifier and Type	Method	Description
String	resolve(Iterable<RelyingPartyRegistration> relyingPartyRegistrations)
String	resolve(RelyingPartyRegistration relyingPartyRegistration)	Resolve the given relying party's metadata
void	setEntityDescriptorCustomizer(Consumer<OpenSaml5MetadataResolver.EntityDescriptorParameters> entityDescriptorCustomizer)	Set a Consumer for modifying the OpenSAML EntityDescriptor
void	setSignMetadata(boolean signMetadata)	Configure whether to sign the metadata, defaults to false.
void	setUsePrettyPrint(boolean usePrettyPrint)	Configure whether to pretty-print the metadata XML.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSaml5MetadataResolver

public OpenSaml5MetadataResolver()

Method Details

resolve

public String resolve(RelyingPartyRegistration relyingPartyRegistration)

Description copied from interface: Saml2MetadataResolver

Resolve the given relying party's metadata

Specified by:

resolve in interface Saml2MetadataResolver

Parameters:

relyingPartyRegistration - the relying party

Returns:

the relying party's metadata

resolve

public String resolve(Iterable<RelyingPartyRegistration> relyingPartyRegistrations)

Specified by:

resolve in interface Saml2MetadataResolver

setEntityDescriptorCustomizer

public void setEntityDescriptorCustomizer(Consumer<OpenSaml5MetadataResolver.EntityDescriptorParameters> entityDescriptorCustomizer)

Set a Consumer for modifying the OpenSAML EntityDescriptor

Parameters:

entityDescriptorCustomizer - a consumer that accepts an OpenSaml5MetadataResolver.EntityDescriptorParameters

Since:

5.7

setUsePrettyPrint

public void setUsePrettyPrint(boolean usePrettyPrint)

Configure whether to pretty-print the metadata XML. This can be helpful when signing the metadata payload.

Since:

6.2

setSignMetadata

public void setSignMetadata(boolean signMetadata)

Configure whether to sign the metadata, defaults to false.

Since:

6.4