Package com.atlassian.confluence.impl.health.checks.rules

Class AbstractHealthCheckRule

java.lang.Object

com.atlassian.confluence.impl.health.checks.rules.AbstractHealthCheckRule

All Implemented Interfaces:

HealthCheckRule

Direct Known Subclasses:

AbstractDatabaseCollationRule, AbstractDatabaseSetupRule, DataSourceSetupRule, DbConnectionPoolRule, HttpThreadsVsDbConnectionPoolRule, TomcatHttpMaxThreadsRule

public abstract class AbstractHealthCheckRule
extends Object
implements HealthCheckRule

Superclass for Health Check Rules.

Since:

6.13

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractHealthCheckRule(ErrorMessageProvider errorMessageProvider, URL kbUrl, String failureCause, JohnsonEventType johnsonEventType)

Method Summary

Modifier and Type	Method	Description
protected abstract Optional<String>	doValidation()
protected String	getErrorMessage(String key, Object... args)
protected com.atlassian.johnson.event.Event	getFailureEvent(String errorMessage)
List<HealthCheckResult>	validate(HealthCheck parent)	Checks whether the Health Check rule is satisfied.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractHealthCheckRule

protected AbstractHealthCheckRule(ErrorMessageProvider errorMessageProvider,
                                  URL kbUrl,
                                  String failureCause,
                                  JohnsonEventType johnsonEventType)

Method Detail

validate

public List<HealthCheckResult> validate(HealthCheck parent)

Description copied from interface: HealthCheckRule

Checks whether the Health Check rule is satisfied.

Specified by:

validate in interface HealthCheckRule

Parameters:

parent - the health check which is validating the rule.

Returns:

a list of Health Check results or empty if no failures.

doValidation

protected abstract Optional<String> doValidation()

getErrorMessage

protected String getErrorMessage(String key,
                                 Object... args)

getFailureEvent

protected com.atlassian.johnson.event.Event getFailureEvent(String errorMessage)