java.lang.Object
- org.springframework.boot.actuate.health.HealthWebEndpointResponseMapper

public class HealthWebEndpointResponseMapper
extends Object

Maps a Health to a WebEndpointResponse.

Since:: 2.0.0

Constructor Summary
Constructors
Constructor Description
HealthWebEndpointResponseMapper(HealthStatusHttpMapper statusHttpMapper, ShowDetails showDetails, Set<String> authorizedRoles)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`WebEndpointResponse<Health>`	`map(Health health, SecurityContext securityContext)`	Maps the given `health` to a `WebEndpointResponse`, honouring the mapper's default `ShowDetails` using the given `securityContext`.
`WebEndpointResponse<Health>`	`map(Health health, SecurityContext securityContext, ShowDetails showDetails)`	Maps the given `health` to a `WebEndpointResponse`, honouring the given `showDetails` using the given `securityContext`.
`WebEndpointResponse<Health>`	`mapDetails(Supplier<Health> health, SecurityContext securityContext)`	Maps the given `health` details to a `WebEndpointResponse`, honouring the mapper's default `ShowDetails` using the given `securityContext`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HealthWebEndpointResponseMapper

public HealthWebEndpointResponseMapper(HealthStatusHttpMapper statusHttpMapper,
                                       ShowDetails showDetails,
                                       Set<String> authorizedRoles)

Method Detail
- mapDetails
```
public WebEndpointResponse<Health> mapDetails(Supplier<Health> health,
                                              SecurityContext securityContext)
```
  Maps the given health details to a WebEndpointResponse, honouring the mapper's default ShowDetails using the given securityContext.
  If the current user does not have the right to see the details, the Supplier is not invoked and a 404 response is returned instead.
  Parameters:
  health - the provider of health details, invoked if the current user has the right to see them
  securityContext - the security context
  Returns:
  the mapped response
- map
```
public WebEndpointResponse<Health> map(Health health,
                                       SecurityContext securityContext)
```
  Maps the given health to a WebEndpointResponse, honouring the mapper's default ShowDetails using the given securityContext.
  Parameters:
  health - the health to map
  securityContext - the security context
  Returns:
  the mapped response
- map
```
public WebEndpointResponse<Health> map(Health health,
                                       SecurityContext securityContext,
                                       ShowDetails showDetails)
```
  Maps the given health to a WebEndpointResponse, honouring the given showDetails using the given securityContext.
  Parameters:
  health - the health to map
  securityContext - the security context
  showDetails - when to show details in the response
  Returns:
  the mapped response

Class HealthWebEndpointResponseMapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HealthWebEndpointResponseMapper

Method Detail

mapDetails

map

map