Class PathMappedEndpoints
java.lang.Object
org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
- All Implemented Interfaces:
Iterable<PathMappedEndpoint>
A collection of
path mapped endpoints
.- Since:
- 2.0.0
- Author:
- Phillip Webb
-
Constructor Summary
ConstructorDescriptionPathMappedEndpoints
(String basePath, Collection<EndpointsSupplier<?>> suppliers) Create a newPathMappedEndpoints
instance for the given suppliers.PathMappedEndpoints
(String basePath, EndpointsSupplier<?> supplier) Create a newPathMappedEndpoints
instance for the given supplier. -
Method Summary
Modifier and TypeMethodDescriptionReturn the full paths for each mapped endpoint.Return the root paths for each mapped endpoint.Return the base path for the endpoints.getEndpoint
(EndpointId endpointId) Return thePathMappedEndpoint
with the given ID ornull
if the endpoint cannot be found.getPath
(EndpointId endpointId) Return the full path for the endpoint with the given ID ornull
if the endpoint cannot be found.getRootPath
(EndpointId endpointId) Return the root path for the endpoint with the given ID ornull
if the endpoint cannot be found.iterator()
stream()
Stream allpath mapped endpoints
.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
PathMappedEndpoints
Create a newPathMappedEndpoints
instance for the given supplier.- Parameters:
basePath
- the base path of the endpointssupplier
- the endpoint supplier
-
PathMappedEndpoints
Create a newPathMappedEndpoints
instance for the given suppliers.- Parameters:
basePath
- the base path of the endpointssuppliers
- the endpoint suppliers
-
-
Method Details
-
getBasePath
Return the base path for the endpoints.- Returns:
- the base path
-
getRootPath
Return the root path for the endpoint with the given ID ornull
if the endpoint cannot be found.- Parameters:
endpointId
- the endpoint ID- Returns:
- the root path or
null
-
getPath
Return the full path for the endpoint with the given ID ornull
if the endpoint cannot be found.- Parameters:
endpointId
- the endpoint ID- Returns:
- the full path or
null
-
getAllRootPaths
Return the root paths for each mapped endpoint.- Returns:
- all root paths
-
getAllPaths
Return the full paths for each mapped endpoint.- Returns:
- all root paths
-
getEndpoint
Return thePathMappedEndpoint
with the given ID ornull
if the endpoint cannot be found.- Parameters:
endpointId
- the endpoint ID- Returns:
- the path mapped endpoint or
null
-
stream
Stream allpath mapped endpoints
.- Returns:
- a stream of endpoints
-
iterator
- Specified by:
iterator
in interfaceIterable<PathMappedEndpoint>
-