Package org.springframework.boot.actuate.health

Interface HealthEndpointGroup

public interface HealthEndpointGroup
A logical grouping of health contributors that can be exposed by the HealthEndpoint.
Since:
2.2.0
Author:
Phillip Webb, Madhura Bhave

  • Method Details

    • isMember

      boolean isMember(String name)
      Returns true if the given contributor is a member of this group.
      Parameters:
      name - the contributor name
      Returns:
      true if the contributor is a member of this group

    • showComponents

      boolean showComponents(SecurityContext securityContext)
      Returns if health components should be shown in the response.
      Parameters:
      securityContext - the endpoint security context
      Returns:
      true to shown details or false to hide them

    • showDetails

      boolean showDetails(SecurityContext securityContext)
      Returns if health details should be shown in the response.
      Parameters:
      securityContext - the endpoint security context
      Returns:
      true to shown details or false to hide them

    • getStatusAggregator

      StatusAggregator getStatusAggregator()
      Returns the status aggregator that should be used for this group.
      Returns:
      the status aggregator for this group

    • getHttpCodeStatusMapper

      HttpCodeStatusMapper getHttpCodeStatusMapper()
      Returns the HttpCodeStatusMapper that should be used for this group.
      Returns:
      the HTTP code status mapper

    • getAdditionalPath

      AdditionalHealthEndpointPath getAdditionalPath()
      Return an additional path that can be used to map the health group to an alternative location.
      Returns:
      the additional health path or null
      Since:
      2.6.0