Package org.eclipse.ditto.internal.utils.health.config

Class DefaultBasicHealthCheckConfig

java.lang.Object

org.eclipse.ditto.internal.utils.health.config.DefaultBasicHealthCheckConfig

All Implemented Interfaces:

WithConfigPath, BasicHealthCheckConfig

@Immutable
public final class DefaultBasicHealthCheckConfig
extends Object
implements BasicHealthCheckConfig, WithConfigPath

This class is the default implementation which provides the basic settings of health checking.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ditto.internal.utils.health.config.BasicHealthCheckConfig

BasicHealthCheckConfig.HealthCheckConfigValue

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getConfigPath()
Duration	getInterval()	Returns the interval of health check.
int	hashCode()
boolean	isEnabled()	Indicates whether global health checking should be enabled.
static DefaultBasicHealthCheckConfig	of(com.typesafe.config.Config config)	Returns an instance of DefaultBasicHealthCheckConfig based on the settings of the specified Config.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

of

public static DefaultBasicHealthCheckConfig of(com.typesafe.config.Config config)

Returns an instance of DefaultBasicHealthCheckConfig based on the settings of the specified Config.

Parameters:

config - is supposed to provide the settings of the basic health check config at "health-check".

Returns:

the instance.

Throws:

DittoConfigError - if config is invalid.

isEnabled

public boolean isEnabled()

Description copied from interface: BasicHealthCheckConfig

Indicates whether global health checking should be enabled.

Specified by:

isEnabled in interface BasicHealthCheckConfig

Returns:

true if health checking should be enabled, false else.

getInterval

public Duration getInterval()

Description copied from interface: BasicHealthCheckConfig

Returns the interval of health check.

Specified by:

getInterval in interface BasicHealthCheckConfig

Returns:

the interval.

See Also:

• BasicHealthCheckConfig.isEnabled()

getConfigPath

public String getConfigPath()

Specified by:

getConfigPath in interface WithConfigPath

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object