ru.vyarus.dropwizard.guice.module.installer.feature.health

Class HealthCheckInstaller

java.lang.Object

ru.vyarus.dropwizard.guice.module.installer.feature.health.HealthCheckInstaller

All Implemented Interfaces:

FeatureInstaller<NamedHealthCheck>, InstanceInstaller<NamedHealthCheck>

public class HealthCheckInstaller
extends java.lang.Object
implements FeatureInstaller<NamedHealthCheck>, InstanceInstaller<NamedHealthCheck>

Health check installer. Looks for classes extending ru.vyarus.dropwizard.guice.module.installer.installer.health.NamedHealthCheck and register in environment.

Since:

01.09.2014

Constructor Summary

Constructors

Constructor and Description
HealthCheckInstaller()

Method Summary

Modifier and Type	Method and Description
void	install(io.dropwizard.setup.Environment environment, NamedHealthCheck instance) Use FeatureUtils.getInstanceClass(instance) to overcome proxies and get correct type.
boolean	matches(java.lang.Class<?> type) NOTE: consider using ru.vyarus.dropwizard.guice.module.installer.util.FeatureUtils to simplify checks (for example, types most likely must be checks to be not abstract).
void	report() Called to log registered endpoints in dropwizard log fashion.

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheckInstaller

public HealthCheckInstaller()

Method Detail

matches

public boolean matches(java.lang.Class<?> type)

Description copied from interface: FeatureInstaller

NOTE: consider using ru.vyarus.dropwizard.guice.module.installer.util.FeatureUtils to simplify checks (for example, types most likely must be checks to be not abstract).

When type accepted by any extension it's registered in guice module.

Specified by:

matches in interface FeatureInstaller<NamedHealthCheck>

Parameters:

type - type to check

Returns:

true if extension recognized, false otherwise

install

public void install(io.dropwizard.setup.Environment environment,
                    NamedHealthCheck instance)

Description copied from interface: InstanceInstaller

Use FeatureUtils.getInstanceClass(instance) to overcome proxies and get correct type.

Specified by:

install in interface InstanceInstaller<NamedHealthCheck>

Parameters:

environment - environment object

instance - extension instance

report

public void report()

Description copied from interface: FeatureInstaller

Called to log registered endpoints in dropwizard log fashion. It's important to naturally show all dynamically resolved classes to easily catch errors. Use Reporter to simplify reporting.

Method may do nothing if reporting not required

Specified by:

report in interface FeatureInstaller<NamedHealthCheck>