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

Class HomeHealthCheckMessageFactory

java.lang.Object

com.atlassian.confluence.impl.health.checks.HomeHealthCheckMessageFactory

public class HomeHealthCheckMessageFactory
extends Object

Creates human readable messages from a given HomeHealthCheckFailure. Used for clear and helpful error messaging in HomeHealthCheck

Since:

6.6.0

Constructor Summary

Constructors

Constructor	Description
HomeHealthCheckMessageFactory()

Method Summary

Modifier and Type	Method	Description
@NonNull HealthCheckMessage	getMessage(HomeHealthCheckFailure failure)	Formats a HomeHealthCheckFailure to a readable helpful message used in HomeHealthCheck

Methods inherited from class java.lang.Object

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

Constructor Detail

HomeHealthCheckMessageFactory

public HomeHealthCheckMessageFactory()

Method Detail

getMessage

public @NonNull HealthCheckMessage getMessage(HomeHealthCheckFailure failure)

Formats a HomeHealthCheckFailure to a readable helpful message used in HomeHealthCheck

Parameters:

failure - reason why the Confluence home check failed.

Returns:

a formatted HealthCheckMessage containing a headline and a message to communicate what failed during the home check.