Package org.springframework.boot.actuate.autoconfigure.security.servlet

Class EndpointRequest.EndpointRequestMatcher

java.lang.Object

org.springframework.boot.security.servlet.ApplicationContextRequestMatcher<WebApplicationContext>

org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest.EndpointRequestMatcher

All Implemented Interfaces:

RequestMatcher

Enclosing class:

EndpointRequest

public static final class EndpointRequest.EndpointRequestMatcher
extends ApplicationContextRequestMatcher<WebApplicationContext>

The request matcher used to match against actuator endpoints.

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.security.web.util.matcher.RequestMatcher

RequestMatcher.MatchResult

Method Summary

Modifier and Type	Method	Description
protected RequestMatcher	createDelegate(WebApplicationContext context, org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest.RequestMatcherFactory requestMatcherFactory)
EndpointRequest.EndpointRequestMatcher	excluding(Class<?>... endpoints)
EndpointRequest.EndpointRequestMatcher	excluding(String... endpoints)
EndpointRequest.EndpointRequestMatcher	excludingLinks()
protected final List<RequestMatcher>	getDelegateMatchers(org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest.RequestMatcherFactory requestMatcherFactory, RequestMatcherProvider matcherProvider, Set<String> paths)
protected final EndpointId	getEndpointId(Object source)
protected List<RequestMatcher>	getLinksMatchers(org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest.RequestMatcherFactory requestMatcherFactory, RequestMatcherProvider matcherProvider, String basePath)
protected RequestMatcherProvider	getRequestMatcherProvider(WebApplicationContext context)
protected final boolean	hasWebServerNamespace(ApplicationContext applicationContext, WebServerNamespace webServerNamespace)
protected boolean	ignoreApplicationContext(WebApplicationContext applicationContext)	Returns if the WebApplicationContext should be ignored and not used for matching.
protected boolean	ignoreApplicationContext(WebApplicationContext applicationContext, ManagementPortType managementPortType)
protected final void	initialized(Supplier<WebApplicationContext> context)	Method that can be implemented by subclasses that wish to initialize items the first time that the matcher is called.
protected final boolean	matches(HttpServletRequest request, Supplier<WebApplicationContext> context)	Decides whether the rule implemented by the strategy matches the supplied request.
String	toString()
protected final String	toString(List<Object> endpoints, String emptyValue)

Methods inherited from class org.springframework.boot.security.servlet.ApplicationContextRequestMatcher

matches

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.security.web.util.matcher.RequestMatcher

matcher

Method Details

excluding

public EndpointRequest.EndpointRequestMatcher excluding(Class<?>... endpoints)

excluding

public EndpointRequest.EndpointRequestMatcher excluding(String... endpoints)

excludingLinks

public EndpointRequest.EndpointRequestMatcher excludingLinks()

createDelegate

protected RequestMatcher createDelegate(WebApplicationContext context,
 org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest.RequestMatcherFactory requestMatcherFactory)

toString

public String toString()

Overrides:

toString in class Object

ignoreApplicationContext

protected boolean ignoreApplicationContext(WebApplicationContext applicationContext)

Description copied from class: ApplicationContextRequestMatcher

Returns if the WebApplicationContext should be ignored and not used for matching. If this method returns true then the context will not be used and the matches method will return false.

Overrides:

ignoreApplicationContext in class ApplicationContextRequestMatcher<WebApplicationContext>

Parameters:

applicationContext - the candidate web application context

Returns:

if the application context should be ignored

ignoreApplicationContext

protected boolean ignoreApplicationContext(WebApplicationContext applicationContext,
 ManagementPortType managementPortType)

hasWebServerNamespace

protected final boolean hasWebServerNamespace(ApplicationContext applicationContext,
 WebServerNamespace webServerNamespace)

initialized

protected final void initialized(Supplier<WebApplicationContext> context)

Description copied from class: ApplicationContextRequestMatcher

Method that can be implemented by subclasses that wish to initialize items the first time that the matcher is called. This method will be called only once and only if ApplicationContextRequestMatcher.ignoreApplicationContext(WebApplicationContext) returns false. Note that the supplied context will be based on the first request sent to the matcher.

Overrides:

initialized in class ApplicationContextRequestMatcher<WebApplicationContext>

Parameters:

context - a supplier for the initialized context (may throw an exception)

See Also:

• ApplicationContextRequestMatcher.ignoreApplicationContext(WebApplicationContext)

matches

protected final boolean matches(HttpServletRequest request,
 Supplier<WebApplicationContext> context)

Description copied from class: ApplicationContextRequestMatcher

Decides whether the rule implemented by the strategy matches the supplied request.

Specified by:

matches in class ApplicationContextRequestMatcher<WebApplicationContext>

Parameters:

request - the source request

context - a supplier for the initialized context (may throw an exception)

Returns:

if the request matches

getDelegateMatchers

protected final List<RequestMatcher> getDelegateMatchers(org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest.RequestMatcherFactory requestMatcherFactory,
 RequestMatcherProvider matcherProvider,
 Set<String> paths)

getLinksMatchers

protected List<RequestMatcher> getLinksMatchers(org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest.RequestMatcherFactory requestMatcherFactory,
 RequestMatcherProvider matcherProvider,
 String basePath)

getRequestMatcherProvider

protected RequestMatcherProvider getRequestMatcherProvider(WebApplicationContext context)

toString

protected final String toString(List<Object> endpoints,
 String emptyValue)

getEndpointId

protected final EndpointId getEndpointId(Object source)