org.springframework.boot.actuate.endpoint.web

Interface PathMapper

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface PathMapper

Strategy interface used to provide a mapping between an endpoint ID and the root path where it will be exposed.

Since:

2.0.0

Author:

Stephane Nicoll, Phillip Webb

Method Summary

Modifier and Type	Method and Description
default String	getRootPath(EndpointId endpointId) Resolve the root path for the endpoint with the specified endpointId.
String	getRootPath(String endpointId) Deprecated. since 2.0.6 in favor of getRootPath(EndpointId)
static PathMapper	useEndpointId() Returns an PathMapper that uses the endpoint ID as the path.

Method Detail

getRootPath

default String getRootPath(EndpointId endpointId)

Resolve the root path for the endpoint with the specified endpointId.

Parameters:

endpointId - the id of an endpoint

Returns:

the path of the endpoint

Since:

2.0.6

getRootPath

@Deprecated
String getRootPath(String endpointId)

Deprecated. since 2.0.6 in favor of getRootPath(EndpointId)

Resolve the root path for the endpoint with the specified endpointId.

Parameters:

endpointId - the id of an endpoint

Returns:

the path of the endpoint

useEndpointId

static PathMapper useEndpointId()

Returns an PathMapper that uses the endpoint ID as the path.

Returns:

an PathMapper that uses the lowercase endpoint ID as the path