Package org.springframework.boot.actuate.endpoint.web

Interface PathMappedEndpoint

All Known Subinterfaces:

ExposableControllerEndpoint, ExposableServletEndpoint, ExposableWebEndpoint

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 PathMappedEndpoint

Interface that can be implemented by an ExposableEndpoint that is mapped to a root web path.

Since:

2.0.0

Author:

Phillip Webb

See Also:

• PathMapper

Method Summary

Modifier and Type	Method	Description
default List<String>	getAdditionalPaths(WebServerNamespace webServerNamespace)	Return any additional paths (relative to the context) for the given WebServerNamespace.
String	getRootPath()	Return the root path of the endpoint (relative to the context and base path) that exposes it.

Method Details

getRootPath

String getRootPath()

Return the root path of the endpoint (relative to the context and base path) that exposes it. For example, a root path of example would be exposed under the URL "/{actuator-context}/example".

Returns:

the root path for the endpoint

See Also:

• PathMappedEndpoints.getBasePath()

getAdditionalPaths

default List<String> getAdditionalPaths(WebServerNamespace webServerNamespace)

Return any additional paths (relative to the context) for the given WebServerNamespace.

Parameters:

webServerNamespace - the web server namespace

Returns:

a list of additional paths

Since:

3.4.0