Class EndpointRequest
- java.lang.Object
- org.springframework.boot.actuate.autoconfigure.security.reactive.EndpointRequest
public final class EndpointRequest extends Object
Factory that can be used to create aServerWebExchangeMatcher
for actuator endpoint locations.- Since:
- 2.0.0
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EndpointRequest.EndpointServerWebExchangeMatcher
TheServerWebExchangeMatcher
used to match againstactuator endpoints
.static class
EndpointRequest.LinksServerWebExchangeMatcher
TheServerWebExchangeMatcher
used to match against the links endpoint.
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static EndpointRequest.EndpointServerWebExchangeMatcher
to(Class<?>... endpoints)
Returns a matcher that includes the specifiedactuator endpoints
.static EndpointRequest.EndpointServerWebExchangeMatcher
to(String... endpoints)
Returns a matcher that includes the specifiedactuator endpoints
.static EndpointRequest.EndpointServerWebExchangeMatcher
toAnyEndpoint()
Returns a matcher that includes allactuator endpoints
.static EndpointRequest.LinksServerWebExchangeMatcher
toLinks()
Returns a matcher that matches only on the links endpoint.
Method Detail
toAnyEndpoint
public static EndpointRequest.EndpointServerWebExchangeMatcher toAnyEndpoint()
Returns a matcher that includes allactuator endpoints
. It also includes the links endpoint which is present at the base path of the actuator endpoints. Theexcluding
method can be used to further remove specific endpoints if required. For example:EndpointRequest.toAnyEndpoint().excluding(ShutdownEndpoint.class)
- Returns:
- the configured
ServerWebExchangeMatcher
to
public static EndpointRequest.EndpointServerWebExchangeMatcher to(Class<?>... endpoints)
Returns a matcher that includes the specifiedactuator endpoints
. For example:EndpointRequest.to(ShutdownEndpoint.class, HealthEndpoint.class)
- Parameters:
endpoints
- the endpoints to include- Returns:
- the configured
ServerWebExchangeMatcher
to
public static EndpointRequest.EndpointServerWebExchangeMatcher to(String... endpoints)
Returns a matcher that includes the specifiedactuator endpoints
. For example:EndpointRequest.to("shutdown", "health")
- Parameters:
endpoints
- the endpoints to include- Returns:
- the configu