com.vordel.reporting.rtm.api
Class MetricGroupTypeRegistry

java.lang.Object
  com.vordel.reporting.rtm.api.MetricGroupTypeRegistry

public class MetricGroupTypeRegistry
extends java.lang.Object

The registry of all MetricGroupTypes. The Gateway will load all the MetricGroupTypes defined in the configuration store at startup into this registry.

A MetricGroupType can be registered by one of the following mechanisms:-

• Auto-registration via definition in the configuration store.
• Auto-registration via MetricGroup constructor which takes the MetricGroupType as a parameter.
• Explicit registration via the the registerMetricGroupType(String) method on MetricGroupTypeRegistry.

See MetricGroup for code examples.

It is not possible to update the definition of a MetricGroupType. If you need to change the definition of a MetricGroupType the Gateway must be restarted.

See Also:

MetricGroupType, MetricGroup

Method Summary

java.util.Collection<MetricGroupType>	getAllMetricGroupTypes() Gets a list of all metric group types.
static MetricGroupTypeRegistry	getInstance() Returns the MetricGroupTypeRegistry singleton object.
MetricGroupType	getMetricGroupType(java.lang.String name) Get the MetricGroupType for a given name, i.e.
MetricType	getMetricType(java.lang.String name) Get the MetricType for a given name, i.e.
void	registerMetricGroupType(MetricGroupType type) Register a new MetricGroupType.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static MetricGroupTypeRegistry getInstance()

Returns the MetricGroupTypeRegistry singleton object.

Returns:

the registry.

getMetricType

public MetricType getMetricType(java.lang.String name)

Get the MetricType for a given name, i.e. string id.

Parameters:

name - The name of the MetricType

Returns:

The MetricType.

getAllMetricGroupTypes

public java.util.Collection<MetricGroupType> getAllMetricGroupTypes()

Gets a list of all metric group types.

Returns:

A Collection of MetricGroupType.

getMetricGroupType

public MetricGroupType getMetricGroupType(java.lang.String name)

Get the MetricGroupType for a given name, i.e. string id.

Parameters:

name - The name of the MetricGroupType

Returns:

The MetricGroupType.

registerMetricGroupType

public void registerMetricGroupType(MetricGroupType type)

Register a new MetricGroupType. This method allows the Metrics API user to create and register their own MetricGroupTypes that are not defined in the configuration store of the Gateway. It is not possible to update the definition by invoking this method a second time. If you need to change the definition of a MetricGroupType the Gateway must be restarted.

Parameters:

type - The new The MetricGroupType to register.