Package io.dropwizard.metrics5.health

Class SharedHealthCheckRegistries

java.lang.Object

io.dropwizard.metrics5.health.SharedHealthCheckRegistries

public class SharedHealthCheckRegistries
extends Object

A map of shared, named health registries.

Method Summary

Modifier and Type	Method	Description
static HealthCheckRegistry	add(String name, HealthCheckRegistry registry)
static void	clear()
static HealthCheckRegistry	getDefault()	Gets the name of the default registry, if it has been set
static HealthCheckRegistry	getOrCreate(String name)
static Set<String>	names()
static void	remove(String key)
static HealthCheckRegistry	setDefault(String name)	Creates a new registry and sets it as the default one under the provided name.
static HealthCheckRegistry	setDefault(String name, HealthCheckRegistry healthCheckRegistry)	Sets the provided registry as the default one under the provided name
static HealthCheckRegistry	tryGetDefault()	Same as getDefault() except returns null when the default registry has not been set.

Methods inherited from class java.lang.Object

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

Method Details

clear

public static void clear()

names

public static Set<String> names()

remove

public static void remove(String key)

add

public static HealthCheckRegistry add(String name,
 HealthCheckRegistry registry)

getOrCreate

public static HealthCheckRegistry getOrCreate(String name)

setDefault

public static HealthCheckRegistry setDefault(String name)

Creates a new registry and sets it as the default one under the provided name.

Parameters:

name - the registry name

Returns:

the default registry

Throws:

IllegalStateException - if the name has already been set

setDefault

public static HealthCheckRegistry setDefault(String name,
 HealthCheckRegistry healthCheckRegistry)

Sets the provided registry as the default one under the provided name

Parameters:

name - the default registry name

healthCheckRegistry - the default registry

Throws:

IllegalStateException - if the default registry has already been set

getDefault

public static HealthCheckRegistry getDefault()

Gets the name of the default registry, if it has been set

Returns:

the default registry

Throws:

IllegalStateException - if the default has not been set

tryGetDefault

public static HealthCheckRegistry tryGetDefault()

Same as getDefault() except returns null when the default registry has not been set.

Returns:

the default registry or null