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

Class EndpointRequest

  • public final class EndpointRequest
extends Object
    Factory that can be used to create a RequestMatcher for actuator endpoint locations.
    Since:
    2.0.0

    • Method Detail

      • 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