org.springframework.boot.actuate.autoconfigure.security

Class EndpointRequest

java.lang.Object

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

public final class EndpointRequest
extends Object

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

Since:

2.0.0

Author:

Madhura Bhave, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EndpointRequest.EndpointRequestMatcher The request matcher used to match against actuator endpoints.

Method Summary

Modifier and Type	Method and 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.EndpointRequestMatcher	toAnyEndpoint() Returns a matcher that includes all actuator endpoints.

Methods inherited from class java.lang.Object

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

Method Detail

toAnyEndpoint

public static EndpointRequest.EndpointRequestMatcher toAnyEndpoint()

Returns a matcher that includes all actuator endpoints. The excluding method can be used to further remove specific endpoints if required. For example:

 EndpointRequestMatcher.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:

 EndpointRequestMatcher.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:

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

Parameters:

endpoints - the endpoints to include

Returns:

the configured RequestMatcher