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

Class Saml2MetadataFilter

  • All Implemented Interfaces:
    javax.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 java.lang.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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void doFilterInternal​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)  
      void setMetadataFilename​(java.lang.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 Detail

      • DEFAULT_METADATA_FILE_NAME

        public static final java.lang.String DEFAULT_METADATA_FILE_NAME
        See Also:
        Constant Field Values

    • Constructor Detail

      • Saml2MetadataFilter

        public Saml2MetadataFilter​(org.springframework.core.convert.converter.Converter<javax.servlet.http.HttpServletRequest,​RelyingPartyRegistration> relyingPartyRegistrationConverter,
                           Saml2MetadataResolver saml2MetadataResolver)

    • Method Detail

      • doFilterInternal

        protected void doFilterInternal​(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                javax.servlet.FilterChain chain)
                         throws javax.servlet.ServletException,
                                java.io.IOException
        Specified by:
        doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter
        Throws:
        javax.servlet.ServletException
        java.io.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​(java.lang.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