org.eclipse.ditto.services.gateway.health.config

Class DefaultClusterRolesConfig

java.lang.Object

org.eclipse.ditto.services.gateway.health.config.DefaultClusterRolesConfig

All Implemented Interfaces:

HealthCheckConfig.ClusterRolesConfig

@Immutable
public final class DefaultClusterRolesConfig
extends Object
implements HealthCheckConfig.ClusterRolesConfig

This class is the default implementation of the cluster roles config of the Gateway health check.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ditto.services.gateway.health.config.HealthCheckConfig.ClusterRolesConfig

HealthCheckConfig.ClusterRolesConfig.ClusterRolesConfigValue

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Set<String>	getExpectedClusterRoles() Returns the roles the health check expected to be present in the running cluster.
int	hashCode()
boolean	isEnabled() Indicates whether the health check for presence of all cluster roles should be enabled or not.
static DefaultClusterRolesConfig	of(com.typesafe.config.Config config) Returns an instance of DefaultClusterRolesConfig 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 Detail

of

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

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

Parameters:

config - is supposed to provide the settings of the cluster roles config at .

Returns:

the instance.

Throws:

org.eclipse.ditto.services.utils.config.DittoConfigError - if config is invalid.

isEnabled

public boolean isEnabled()

Description copied from interface: HealthCheckConfig.ClusterRolesConfig

Indicates whether the health check for presence of all cluster roles should be enabled or not.

Specified by:

isEnabled in interface HealthCheckConfig.ClusterRolesConfig

Returns:

true if the health check for presence of all cluster roles should be enabled, false else.

getExpectedClusterRoles

public Set<String> getExpectedClusterRoles()

Description copied from interface: HealthCheckConfig.ClusterRolesConfig

Returns the roles the health check expected to be present in the running cluster.

Specified by:

getExpectedClusterRoles in interface HealthCheckConfig.ClusterRolesConfig

Returns:

an unmodifiable unsorted Set containing the expected cluster roles.

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