net.shibboleth.idp.metrics

Class ReloadableServiceGaugeSet

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.metrics.ReloadableServiceGaugeSet

All Implemented Interfaces:

com.codahale.metrics.Metric, com.codahale.metrics.MetricFilter, com.codahale.metrics.MetricSet, Component, DestructableComponent, InitializableComponent

public class ReloadableServiceGaugeSet
extends AbstractInitializableComponent
implements com.codahale.metrics.MetricSet, com.codahale.metrics.MetricFilter

A set of gauges for a reloadable service.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_METRIC_NAME Default prefix for metrics.
private Map<String,com.codahale.metrics.Metric>	gauges The map of gauges.
private ReloadableService	service The service to report on.

Fields inherited from interface com.codahale.metrics.MetricFilter

ALL

Constructor Summary

Constructors

Constructor and Description
ReloadableServiceGaugeSet(String metricName) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
protected Map<String,com.codahale.metrics.Metric>	getMetricMap() Get the underlying map of metrics.
Map<String,com.codahale.metrics.Metric>	getMetrics()
ReloadableService	getService() Get the service to report on.
boolean	matches(String name, com.codahale.metrics.Metric metric)
void	setService(ReloadableService svc) Set the service to report on.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_METRIC_NAME

@Nonnull
@NotEmpty
protected static final String DEFAULT_METRIC_NAME

Default prefix for metrics.

See Also:

Constant Field Values

gauges

@Nonnull
@NonnullElements
private final Map<String,com.codahale.metrics.Metric> gauges

The map of gauges.

service

@NonnullAfterInit
private ReloadableService service

The service to report on.

Constructor Detail

ReloadableServiceGaugeSet

public ReloadableServiceGaugeSet(@Nonnull@NotEmpty@ParameterName(name="metricName")
                         String metricName)

Constructor.

Parameters:

metricName - name to include in metric names produced by this set

Method Detail

getService

@NonnullAfterInit
public ReloadableService getService()

Get the service to report on.

Returns:

service to report on

setService

public void setService(@Nonnull
              ReloadableService svc)

Set the service to report on.

Parameters:

svc - service instance

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

getMetrics

public Map<String,com.codahale.metrics.Metric> getMetrics()

Specified by:

getMetrics in interface com.codahale.metrics.MetricSet

matches

public boolean matches(String name,
              com.codahale.metrics.Metric metric)

Specified by:

matches in interface com.codahale.metrics.MetricFilter

getMetricMap

@Nonnull
@NonnullElements
@Live
protected Map<String,com.codahale.metrics.Metric> getMetricMap()

Get the underlying map of metrics.

Returns:

map of metrics