X

Class HealthEndpoint

Inheritance
System.Object
AbstractEndpoint
AbstractEndpoint<HealthEndpointResponse, ISecurityContext>
HealthEndpoint
HealthEndpointCore
Implements
Inherited Members
Namespace: Steeltoe.Management.Endpoint.Health
Assembly: Steeltoe.Management.EndpointBase.dll
Syntax
public class HealthEndpoint : AbstractEndpoint<HealthEndpointResponse, ISecurityContext>, IEndpoint<HealthEndpointResponse, ISecurityContext>, IEndpoint, IHealthEndpoint

Constructors

| Edit this page View Source

HealthEndpoint(IHealthOptions, IHealthAggregator, IEnumerable<IHealthContributor>, ILogger<HealthEndpoint>)

Declaration
public HealthEndpoint(IHealthOptions options, IHealthAggregator aggregator, IEnumerable<IHealthContributor> contributors, ILogger<HealthEndpoint> logger = null)
Parameters
Type Name Description
IHealthOptions options
IHealthAggregator aggregator
IEnumerable<IHealthContributor> contributors
ILogger<HealthEndpoint> logger

Properties

| Edit this page View Source

Options

Declaration
public IHealthOptions Options { get; }
Property Value
Type Description
IHealthOptions

Methods

| Edit this page View Source

BuildHealth(ISecurityContext)

Declaration
protected virtual HealthEndpointResponse BuildHealth(ISecurityContext securityContext)
Parameters
Type Name Description
ISecurityContext securityContext
Returns
Type Description
HealthEndpointResponse
| Edit this page View Source

GetFilteredContributorList(String, IList<IHealthContributor>)

Filter out health contributors that do not belong to the requested group

Declaration
protected IList<IHealthContributor> GetFilteredContributorList(string requestedGroup, IList<IHealthContributor> contributors)
Parameters
Type Name Description
System.String requestedGroup

Name of group from request
IList<IHealthContributor> contributors

Full list of IHealthContributors
Returns
Type Description
IList<IHealthContributor>

If the group is configured, returns health contributors that belong to the group.

If group can't be parsed or is not configured, returns all health contributors.
| Edit this page View Source

GetRequestedHealthGroup(ISecurityContext)

Returns the last value returned by GetRequestComponents(), expected to be the name of a configured health group

Declaration
protected string GetRequestedHealthGroup(ISecurityContext securityContext)
Parameters
Type Name Description
ISecurityContext securityContext

Last value of GetRequestComponents() is used as group name
Returns
Type Description
System.String
| Edit this page View Source

GetStatusCode(HealthCheckResult)

Declaration
public int GetStatusCode(HealthCheckResult health)
Parameters
Type Name Description
HealthCheckResult health
Returns
Type Description
System.Int32
| Edit this page View Source

Invoke(ISecurityContext)

Declaration
public override HealthEndpointResponse Invoke(ISecurityContext securityContext)
Parameters
Type Name Description
ISecurityContext securityContext
Returns
Type Description
HealthEndpointResponse
Overrides
Steeltoe.Management.AbstractEndpoint<Steeltoe.Management.Endpoint.Health.HealthEndpointResponse, Steeltoe.Management.Endpoint.Security.ISecurityContext>.Invoke(Steeltoe.Management.Endpoint.Security.ISecurityContext)

Implements