com.ryantenney.metrics.spring.config.annotation

Class MetricsConfigurerAdapter

java.lang.Object

com.ryantenney.metrics.spring.config.annotation.MetricsConfigurerAdapter

All Implemented Interfaces:

MetricsConfigurer, org.springframework.beans.factory.DisposableBean

public abstract class MetricsConfigurerAdapter
extends Object
implements MetricsConfigurer, org.springframework.beans.factory.DisposableBean

An implementation of MetricsConfigurer with empty methods allowing sub-classes to override only the methods they're interested in.

Since:

3.0

Author:

Ryan Tenney

See Also:

EnableMetrics, MetricsConfigurer

Constructor Summary

Constructors

Constructor and Description
MetricsConfigurerAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	configureReporters(com.codahale.metrics.MetricRegistry metricRegistry) Configure reporters.
void	destroy() Called when the Spring context is closed, this method stops reporters.
com.codahale.metrics.health.HealthCheckRegistry	getHealthCheckRegistry() Override this method to provide a custom HealthCheckRegistry.
com.codahale.metrics.MetricRegistry	getMetricRegistry() Override this method to provide a custom MetricRegistry.
protected <R extends Closeable> R	registerReporter(R reporter) Registers a reporter for destruction on Spring context close

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsConfigurerAdapter

public MetricsConfigurerAdapter()

Method Detail

configureReporters

public void configureReporters(com.codahale.metrics.MetricRegistry metricRegistry)

Configure reporters.

This implementation is empty.

Specified by:

configureReporters in interface MetricsConfigurer

getMetricRegistry

public com.codahale.metrics.MetricRegistry getMetricRegistry()

Override this method to provide a custom MetricRegistry.

This implementation returns null.

Specified by:

getMetricRegistry in interface MetricsConfigurer

Returns:

getHealthCheckRegistry

public com.codahale.metrics.health.HealthCheckRegistry getHealthCheckRegistry()

Override this method to provide a custom HealthCheckRegistry.

This implementation returns null.

Specified by:

getHealthCheckRegistry in interface MetricsConfigurer

Returns:

destroy

public void destroy()
             throws Exception

Called when the Spring context is closed, this method stops reporters.

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

registerReporter

protected <R extends Closeable> R registerReporter(R reporter)

Registers a reporter for destruction on Spring context close

Parameters:

reporter - a reporter which implements Closeable

Returns:

the reporter