Class EndpointRequest.EndpointServerWebExchangeMatcher

java.lang.Object

org.springframework.boot.security.web.reactive.ApplicationContextServerWebExchangeMatcher<PathMappedEndpoints>

org.springframework.boot.security.autoconfigure.actuate.web.reactive.EndpointRequest.EndpointServerWebExchangeMatcher

All Implemented Interfaces:

ServerWebExchangeMatcher

Enclosing class:

EndpointRequest

public static final class EndpointRequest.EndpointServerWebExchangeMatcher
extends ApplicationContextServerWebExchangeMatcher<PathMappedEndpoints>

The ServerWebExchangeMatcher used to match against actuator endpoints.

Since:

4.0.0

Author:

Madhura Bhave, Phillip Webb, Chris Bono

Nested Class Summary

Nested classes/interfaces inherited from interface ServerWebExchangeMatcher

ServerWebExchangeMatcher.MatchResult

Method Summary

Modifier and Type	Method	Description
protected ServerWebExchangeMatcher	createDelegate(PathMappedEndpoints endpoints)
EndpointRequest.EndpointServerWebExchangeMatcher	excluding(Class<?>... endpoints)
EndpointRequest.EndpointServerWebExchangeMatcher	excluding(String... endpoints)
EndpointRequest.EndpointServerWebExchangeMatcher	excludingLinks()
protected final List<ServerWebExchangeMatcher>	getDelegateMatchers(Set<String> paths, @Nullable HttpMethod httpMethod)
protected final EndpointId	getEndpointId(Object source)
protected final boolean	hasWebServerNamespace(@Nullable ApplicationContext applicationContext, WebServerNamespace webServerNamespace)
protected boolean	ignoreApplicationContext(@Nullable ApplicationContext applicationContext)	Returns if the ApplicationContext should be ignored and not used for matching.
protected boolean	ignoreApplicationContext(@Nullable ApplicationContext applicationContext, ManagementPortType managementPortType)
protected void	initialized(Supplier<PathMappedEndpoints> supplier)	Called once the context has been initialized.
protected reactor.core.publisher.Mono<ServerWebExchangeMatcher.MatchResult>	matches(ServerWebExchange exchange, Supplier<PathMappedEndpoints> context)	Decides whether the rule implemented by the strategy matches the supplied exchange.
String	toString()
protected final String	toString(List<Object> endpoints, String emptyValue)
EndpointRequest.EndpointServerWebExchangeMatcher	withHttpMethod(HttpMethod httpMethod)	Restricts the matcher to only consider requests with a particular http method.

Methods inherited from class ApplicationContextServerWebExchangeMatcher

getContext, matches

Methods inherited from class Object

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

Method Details

excluding

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

excluding

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

excludingLinks

public EndpointRequest.EndpointServerWebExchangeMatcher excludingLinks()

withHttpMethod

public EndpointRequest.EndpointServerWebExchangeMatcher withHttpMethod(HttpMethod httpMethod)

Restricts the matcher to only consider requests with a particular http method.

Parameters:

httpMethod - the http method to include

Returns:

a copy of the matcher further restricted to only match requests with the specified http method

createDelegate

protected ServerWebExchangeMatcher createDelegate(PathMappedEndpoints endpoints)

toString

public String toString()

Overrides:

toString in class Object

initialized

protected void initialized(Supplier<PathMappedEndpoints> supplier)

Description copied from class: ApplicationContextServerWebExchangeMatcher

Called once the context has been initialized.

Overrides:

initialized in class ApplicationContextServerWebExchangeMatcher<C>

Parameters:

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

getDelegateMatchers

protected final List<ServerWebExchangeMatcher> getDelegateMatchers(Set<String> paths,
 @Nullable HttpMethod httpMethod)

matches

protected reactor.core.publisher.Mono<ServerWebExchangeMatcher.MatchResult> matches(ServerWebExchange exchange,
 Supplier<PathMappedEndpoints> context)

Description copied from class: ApplicationContextServerWebExchangeMatcher

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

Specified by:

matches in class ApplicationContextServerWebExchangeMatcher<C>

Parameters:

exchange - the source exchange

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

Returns:

if the exchange matches

ignoreApplicationContext

protected boolean ignoreApplicationContext(@Nullable ApplicationContext applicationContext)

Description copied from class: ApplicationContextServerWebExchangeMatcher

Returns if the ApplicationContext 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 ApplicationContextServerWebExchangeMatcher<C>

Parameters:

applicationContext - the candidate application context

Returns:

if the application context should be ignored

ignoreApplicationContext

protected boolean ignoreApplicationContext(@Nullable ApplicationContext applicationContext,
 ManagementPortType managementPortType)

hasWebServerNamespace

protected final boolean hasWebServerNamespace(@Nullable ApplicationContext applicationContext,
 WebServerNamespace webServerNamespace)

toString

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

getEndpointId

protected final EndpointId getEndpointId(Object source)