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

Class Saml2MetadataFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.security.saml2.provider.service.web.Saml2MetadataFilter

All Implemented Interfaces:

jakarta.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

public final class Saml2MetadataFilter
extends org.springframework.web.filter.OncePerRequestFilter

A Filter that returns the metadata for a Relying Party

Since:

5.4

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_METADATA_FILE_NAME

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Constructor Summary

Constructors

Constructor	Description
Saml2MetadataFilter(Saml2MetadataResponseResolver metadataResponseResolver)	Constructs an instance of Saml2MetadataFilter
Saml2MetadataFilter(RelyingPartyRegistrationRepository relyingPartyRegistrationRepository, Saml2MetadataResolver saml2MetadataResolver)	Constructs an instance of Saml2MetadataFilter using the provided parameters.
Saml2MetadataFilter(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver, Saml2MetadataResolver saml2MetadataResolver)

Method Summary

Modifier and Type	Method	Description
protected void	doFilterInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
void	setMetadataFilename(String metadataFilename)	Sets the metadata filename template containing the {registrationId} template variable.
void	setRequestMatcher(RequestMatcher requestMatcher)	Set the RequestMatcher that determines whether this filter should handle the incoming HttpServletRequest

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_METADATA_FILE_NAME

public static final String DEFAULT_METADATA_FILE_NAME

See Also:

• Constant Field Values

Constructor Details

Saml2MetadataFilter

public Saml2MetadataFilter(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver,
 Saml2MetadataResolver saml2MetadataResolver)

Saml2MetadataFilter

public Saml2MetadataFilter(RelyingPartyRegistrationRepository relyingPartyRegistrationRepository,
 Saml2MetadataResolver saml2MetadataResolver)

Constructs an instance of Saml2MetadataFilter using the provided parameters. The metadataResolver field will be initialized with a DefaultRelyingPartyRegistrationResolver instance using the provided RelyingPartyRegistrationRepository

Parameters:

relyingPartyRegistrationRepository - the RelyingPartyRegistrationRepository to use

saml2MetadataResolver - the Saml2MetadataResolver to use

Since:

6.1

Saml2MetadataFilter

public Saml2MetadataFilter(Saml2MetadataResponseResolver metadataResponseResolver)

Constructs an instance of Saml2MetadataFilter

Parameters:

metadataResponseResolver - the strategy for producing metadata

Since:

6.1

Method Details

doFilterInternal

protected void doFilterInternal(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)
                         throws jakarta.servlet.ServletException,
IOException

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

jakarta.servlet.ServletException

IOException

setRequestMatcher

public void setRequestMatcher(RequestMatcher requestMatcher)

Set the RequestMatcher that determines whether this filter should handle the incoming HttpServletRequest

Parameters:

requestMatcher - the RequestMatcher to identify requests for metadata

setMetadataFilename

public void setMetadataFilename(String metadataFilename)

Sets the metadata filename template containing the {registrationId} template variable.

The default value is saml-{registrationId}-metadata.xml

Parameters:

metadataFilename - metadata filename, must contain a {registrationId}

Since:

5.5