View Source

Class BaseHttpHeaderCheck

Provides a base class for health checks of http header values.

Inheritance
System.Object
HealthCheck
Namespace: Umbraco.Cms.Core.HealthChecks.Checks.Security
Assembly: Umbraco.Core.dll
Syntax
public abstract class BaseHttpHeaderCheck : HealthCheck, IDiscoverable

Constructors

View Source

BaseHttpHeaderCheck(IHostingEnvironment, ILocalizedTextService, String, String, Boolean)

Initializes a new instance of the BaseHttpHeaderCheck class.

Declaration
protected BaseHttpHeaderCheck(IHostingEnvironment hostingEnvironment, ILocalizedTextService textService, string header, string localizedTextPrefix, bool metaTagOptionAvailable)
Parameters
Type Name Description
IHostingEnvironment hostingEnvironment
ILocalizedTextService textService
System.String header
System.String localizedTextPrefix
System.Boolean metaTagOptionAvailable
View Source

BaseHttpHeaderCheck(IHostingEnvironment, ILocalizedTextService, String, String, Boolean, Boolean)

Declaration
protected BaseHttpHeaderCheck(IHostingEnvironment hostingEnvironment, ILocalizedTextService textService, string header, string localizedTextPrefix, bool metaTagOptionAvailable, bool shouldNotExist)
Parameters
Type Name Description
IHostingEnvironment hostingEnvironment
ILocalizedTextService textService
System.String header
System.String localizedTextPrefix
System.Boolean metaTagOptionAvailable
System.Boolean shouldNotExist

Properties

View Source

LocalizedTextService

Declaration
protected ILocalizedTextService LocalizedTextService { get; }
Property Value
Type Description
ILocalizedTextService
View Source

Gets a link to an external read more page.

Declaration
protected abstract string ReadMoreLink { get; }
Property Value
Type Description
System.String

Methods

View Source

CheckForHeader()

The actual health check method.

Declaration
protected async Task<HealthCheckStatus> CheckForHeader()
Returns
Type Description
Task<HealthCheckStatus>
View Source

ExecuteAction(HealthCheckAction)

Executes the action and returns it's status

Declaration
public override HealthCheckStatus ExecuteAction(HealthCheckAction action)
Parameters
Type Name Description
HealthCheckAction action
Returns
Type Description
HealthCheckStatus
View Source

GetStatus()

Get the status for this health check

Declaration
public override async Task<IEnumerable<HealthCheckStatus>> GetStatus()
Returns
Type Description
Task<IEnumerable<HealthCheckStatus>>