Package org.springframework.security.config.annotation.web

Class AbstractRequestMatcherRegistry<C>

java.lang.Object
org.springframework.security.config.annotation.web.AbstractRequestMatcherRegistry<C>
Type Parameters:
C - The object that is returned or Chained after creating the RequestMatcher
Direct Known Subclasses:
AbstractConfigAttributeRequestMatcherRegistry, AuthorizeHttpRequestsConfigurer.AuthorizationManagerRequestMatcherRegistry, HttpSecurity.RequestMatcherConfigurer, WebSecurity.IgnoredRequestConfigurer
public abstract class AbstractRequestMatcherRegistry<C> extends Object
A base class for registering RequestMatcher's. For example, it might allow for specifying which RequestMatcher require a certain level of authorization.
Since:
3.2

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractRequestMatcherRegistry()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    C
    anyRequest()
    Maps any request.
    protected abstract C
    chainRequestMatchers(List<org.springframework.security.web.util.matcher.RequestMatcher> requestMatchers)
    Subclasses should implement this method for returning the object that is chained to the creation of the RequestMatcher instances.
    C
    dispatcherTypeMatchers(jakarta.servlet.DispatcherType... dispatcherTypes)
    Create a List of DispatcherTypeRequestMatcher instances that do not specify an HttpMethod.
    C
    dispatcherTypeMatchers(org.springframework.http.HttpMethod method, jakarta.servlet.DispatcherType... dispatcherTypes)
    Maps a List of DispatcherTypeRequestMatcher instances.
    protected final org.springframework.context.ApplicationContext
    getApplicationContext()
    Gets the ApplicationContext
    C
    requestMatchers(String... patterns)
    Match when the request URI matches one of patterns.
    C
    requestMatchers(org.springframework.http.HttpMethod method)
    Match when the HttpMethod is method
    C
    requestMatchers(org.springframework.http.HttpMethod method, String... patterns)
    Match when the HttpMethod is method and when the request URI matches one of patterns.
    C
    requestMatchers(org.springframework.security.web.util.matcher.RequestMatcher... requestMatchers)
    Associates a list of RequestMatcher instances with the AbstractRequestMatcherRegistry
    protected final void
    setApplicationContext(org.springframework.context.ApplicationContext context)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AbstractRequestMatcherRegistry

      public AbstractRequestMatcherRegistry()

  • Method Details

    • setApplicationContext

      protected final void setApplicationContext(org.springframework.context.ApplicationContext context)

    • getApplicationContext

      protected final org.springframework.context.ApplicationContext getApplicationContext()
      Gets the ApplicationContext
      Returns:
      the ApplicationContext

    • anyRequest

      public C anyRequest()
      Maps any request.
      Returns:
      the object that is chained after creating the RequestMatcher

    • dispatcherTypeMatchers

      public C dispatcherTypeMatchers(@Nullable org.springframework.http.HttpMethod method, jakarta.servlet.DispatcherType... dispatcherTypes)
      Maps a List of DispatcherTypeRequestMatcher instances.
      Parameters:
      method - the HttpMethod to use or null for any HttpMethod.
      dispatcherTypes - the dispatcher types to match against
      Returns:
      the object that is chained after creating the RequestMatcher

    • dispatcherTypeMatchers

      public C dispatcherTypeMatchers(jakarta.servlet.DispatcherType... dispatcherTypes)
      Create a List of DispatcherTypeRequestMatcher instances that do not specify an HttpMethod.
      Parameters:
      dispatcherTypes - the dispatcher types to match against
      Returns:
      the object that is chained after creating the RequestMatcher

    • requestMatchers

      public C requestMatchers(org.springframework.security.web.util.matcher.RequestMatcher... requestMatchers)
      Associates a list of RequestMatcher instances with the AbstractRequestMatcherRegistry
      Parameters:
      requestMatchers - the RequestMatcher instances
      Returns:
      the object that is chained after creating the RequestMatcher

    • requestMatchers

      public C requestMatchers(org.springframework.http.HttpMethod method, String... patterns)

      Match when the HttpMethod is method and when the request URI matches one of patterns. See PathPattern for matching rules.

      If a specific RequestMatcher must be specified, use requestMatchers(RequestMatcher...) instead

      Parameters:
      method - the HttpMethod to use or null for any HttpMethod.
      patterns - the patterns to match on
      Returns:
      the object that is chained after creating the RequestMatcher.
      Since:
      5.8

    • requestMatchers

      public C requestMatchers(String... patterns)

      Match when the request URI matches one of patterns. See PathPattern for matching rules.

      If a specific RequestMatcher must be specified, use requestMatchers(RequestMatcher...) instead

      Parameters:
      patterns - the patterns to match on
      Returns:
      the object that is chained after creating the RequestMatcher.
      Since:
      5.8

    • requestMatchers

      public C requestMatchers(org.springframework.http.HttpMethod method)

      Match when the HttpMethod is method

      If a specific RequestMatcher must be specified, use requestMatchers(RequestMatcher...) instead

      Parameters:
      method - the HttpMethod to use or null for any HttpMethod.
      Returns:
      the object that is chained after creating the RequestMatcher.
      Since:
      5.8

    • chainRequestMatchers

      protected abstract C chainRequestMatchers(List<org.springframework.security.web.util.matcher.RequestMatcher> requestMatchers)
      Subclasses should implement this method for returning the object that is chained to the creation of the RequestMatcher instances.
      Parameters:
      requestMatchers - the RequestMatcher instances that were created
      Returns:
      the chained Object for the subclass which allows association of something else to the RequestMatcher