public class MetricGroupTypeRegistry
extends java.lang.Object
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:-
MetricGroup
constructor which takes the MetricGroupType
as a parameter.registerMetricGroupType(String)
method on MetricGroupTypeRegistry
.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.
MetricGroupType
,
MetricGroup
Modifier and Type | Method and Description |
---|---|
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 . |
public static MetricGroupTypeRegistry getInstance()
MetricGroupTypeRegistry
singleton object.public MetricType getMetricType(java.lang.String name)
MetricType
for a given name, i.e. string id.name
- The name of the MetricType
MetricType
.public java.util.Collection<MetricGroupType> getAllMetricGroupTypes()
Collection
of MetricGroupType
.public MetricGroupType getMetricGroupType(java.lang.String name)
MetricGroupType
for a given name, i.e. string id.name
- The name of the MetricGroupType
MetricGroupType
.public void registerMetricGroupType(MetricGroupType type)
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.type
- The new The MetricGroupType
to register.
This documentation and all its contents and graphics, copyright © 1999 - 2011 Vordel