Class EndpointRequest

java.lang.Object

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

public final class EndpointRequest
extends Object

Factory that can be used to create a RequestMatcher for actuator endpoint locations.

Since:

4.0.0

Author:

Madhura Bhave, Phillip Webb, Chris Bono

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EndpointRequest.AdditionalPathsEndpointRequestMatcher	The request matcher used to match against additional paths for actuator endpoints.
static final class	EndpointRequest.EndpointRequestMatcher	The request matcher used to match against actuator endpoints.
static final class	EndpointRequest.LinksRequestMatcher	The request matcher used to match against the links endpoint.

Method Summary

Modifier and Type	Method	Description
static EndpointRequest.EndpointRequestMatcher	to(Class<?>... endpoints)	Returns a matcher that includes the specified actuator endpoints.
static EndpointRequest.EndpointRequestMatcher	to(String... endpoints)	Returns a matcher that includes the specified actuator endpoints.
static EndpointRequest.AdditionalPathsEndpointRequestMatcher	toAdditionalPaths(WebServerNamespace webServerNamespace, Class<?>... endpoints)	Returns a matcher that includes additional paths under a WebServerNamespace for the specified actuator endpoints.
static EndpointRequest.AdditionalPathsEndpointRequestMatcher	toAdditionalPaths(WebServerNamespace webServerNamespace, String... endpoints)	Returns a matcher that includes additional paths under a WebServerNamespace for the specified actuator endpoints.
static EndpointRequest.EndpointRequestMatcher	toAnyEndpoint()	Returns a matcher that includes all actuator endpoints.
static EndpointRequest.LinksRequestMatcher	toLinks()	Returns a matcher that matches only on the links endpoint.

Methods inherited from class Object

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

Method Details

toAnyEndpoint

public static EndpointRequest.EndpointRequestMatcher toAnyEndpoint()

Returns a matcher that includes all actuator endpoints. It also includes the links endpoint which is present at the base path of the actuator endpoints. The excluding method can be used to further remove specific endpoints if required. For example:

EndpointRequest.toAnyEndpoint().excluding(ShutdownEndpoint.class)

Returns:

the configured RequestMatcher

to

public static EndpointRequest.EndpointRequestMatcher to(Class<?>... endpoints)

Returns a matcher that includes the specified actuator endpoints. For example:

EndpointRequest.to(ShutdownEndpoint.class, HealthEndpoint.class)

Parameters:

endpoints - the endpoints to include

Returns:

the configured RequestMatcher

to

public static EndpointRequest.EndpointRequestMatcher to(String... endpoints)

Returns a matcher that includes the specified actuator endpoints. For example:

EndpointRequest.to("shutdown", "health")

Parameters:

endpoints - the endpoints to include

Returns:

the configured RequestMatcher

toLinks

public static EndpointRequest.LinksRequestMatcher toLinks()

Returns a matcher that matches only on the links endpoint. It can be used when security configuration for the links endpoint is different from the other actuator endpoints. The excludingLinks method can be used in combination with this to remove the links endpoint from toAnyEndpoint. For example:

EndpointRequest.toLinks()

Returns:

the configured RequestMatcher

toAdditionalPaths

public static EndpointRequest.AdditionalPathsEndpointRequestMatcher toAdditionalPaths(WebServerNamespace webServerNamespace,
 Class<?>... endpoints)

Returns a matcher that includes additional paths under a WebServerNamespace for the specified actuator endpoints. For example:

EndpointRequest.toAdditionalPaths(WebServerNamespace.SERVER, "health")

Parameters:

webServerNamespace - the web server namespace

endpoints - the endpoints to include

Returns:

the configured RequestMatcher

toAdditionalPaths

public static EndpointRequest.AdditionalPathsEndpointRequestMatcher toAdditionalPaths(WebServerNamespace webServerNamespace,
 String... endpoints)

Returns a matcher that includes additional paths under a WebServerNamespace for the specified actuator endpoints. For example:

EndpointRequest.toAdditionalPaths(WebServerNamespace.SERVER, HealthEndpoint.class)

Parameters:

webServerNamespace - the web server namespace

endpoints - the endpoints to include

Returns:

the configured RequestMatcher