com.bigdata.ganglia

Interface IGangliaMetadataFactory

All Known Implementing Classes:

BigdataMetadataFactory, DefaultMetadataFactory, GangliaMetadataFactory, NOPMetadataFactory

public interface IGangliaMetadataFactory

A factory for registering application metrics dynamically.

Method Summary

Methods

Modifier and Type	Method and Description
IGangliaMetadataMessage	newDecl(String hostName, String metricName, Object value) Factory for new declarations.
IGangliaMetadataMessage	resolve(IGangliaMetadataMessage decl) Resolve a declaration received over the wire into a declaration with a richer object behavior.

Method Detail

newDecl

IGangliaMetadataMessage newDecl(String hostName,
                              String metricName,
                              Object value)

Factory for new declarations.

Parameters:

hostName - The name of this host.

metricName - The ganglia metric name (suitably munged if necessary for use by ganglia).

value - The metric value (NOT null).

Returns:

The metric declaration -or- null if this factory does not know how to declare this metric.

resolve

IGangliaMetadataMessage resolve(IGangliaMetadataMessage decl)

Resolve a declaration received over the wire into a declaration with a richer object behavior. This allows the application to substitute its own versions of an IGangliaMetadataMessage.

Parameters:

decl - A declaration (typically received over the wire).

Returns:

The declaration to be used.