com.bigdata.ganglia

Class AbstractGangliaMessage

java.lang.Object

com.bigdata.ganglia.AbstractGangliaMessage

All Implemented Interfaces:

IGangliaMessage

Direct Known Subclasses:

GangliaMetadataMessage, GangliaMetricMessage, GangliaRequestMessage

public abstract class AbstractGangliaMessage
extends Object
implements IGangliaMessage

Base class for ganglia 3.1 wire format messages.

Constructor Summary

Constructors

Constructor and Description
AbstractGangliaMessage(GangliaMessageTypeEnum recordType, String hostName, String metricName, boolean spoof)

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	equals(Object o)
String	getHostName() The name of the host for which the metric was reported.
String	getMetricName() The name of the metric (this needs to be clean for use in a file system so the application name of the metric needs to be munged before it is saved here).
GangliaMessageTypeEnum	getRecordType() The code for the type of message.
abstract int	hashCode()
boolean	isSpoof() true iff this is a spoofed message.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bigdata.ganglia.IGangliaMessage

isMetricMetadata, isMetricRequest, isMetricValue

Constructor Detail

AbstractGangliaMessage

public AbstractGangliaMessage(GangliaMessageTypeEnum recordType,
                      String hostName,
                      String metricName,
                      boolean spoof)

Method Detail

getRecordType

public GangliaMessageTypeEnum getRecordType()

Description copied from interface: IGangliaMessage

The code for the type of message.

Specified by:

getRecordType in interface IGangliaMessage

getHostName

public String getHostName()

Description copied from interface: IGangliaMessage

The name of the host for which the metric was reported.

Note: When IGangliaMessage.isSpoof() reports true this will be ip:host.

Specified by:

getHostName in interface IGangliaMessage

getMetricName

public String getMetricName()

Description copied from interface: IGangliaMessage

The name of the metric (this needs to be clean for use in a file system so the application name of the metric needs to be munged before it is saved here).

Specified by:

getMetricName in interface IGangliaMessage

isSpoof

public boolean isSpoof()

Description copied from interface: IGangliaMessage

true iff this is a spoofed message.

Note: Spoof messages format IGangliaMessage.getHostName() as ip:host and provide a means to fake metrics for a host which is down (or which is not running ganglia).

Specified by:

isSpoof in interface IGangliaMessage

equals

public abstract boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object