org.jolokia.history

Class HistoryKey

java.lang.Object

org.jolokia.history.HistoryKey

All Implemented Interfaces:

Serializable

public class HistoryKey
extends Object
implements Serializable

Key used in the HistoryStore for indexing historical values. The key has a type reflecting the kind of JMX operataion (attribute or operation) and can be used in proxy mode for different targets.

Since:

Jun 12, 2009

Author:

roland

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HistoryKey(String pMBean, String pOperation, String pTarget) Constructor for type operation
HistoryKey(String pMBean, String pAttribute, String pPath, String pTarget) Constructor for type attribute

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
boolean	isMBeanPattern() Whether this key embraces a MBean pattern
boolean	matches(HistoryKey pKey) Whether the key matches the given MBean name
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryKey

public HistoryKey(String pMBean,
                  String pOperation,
                  String pTarget)
           throws MalformedObjectNameException

Constructor for type operation

Parameters:

pMBean - MBean name

pOperation - operation name

pTarget - optional target if used in proxy mode

Throws:

MalformedObjectNameException - if the mbean name is invalid

HistoryKey

public HistoryKey(String pMBean,
                  String pAttribute,
                  String pPath,
                  String pTarget)
           throws MalformedObjectNameException

Constructor for type attribute

Parameters:

pMBean - MBean name

pAttribute - attribute

pPath - optional path

pTarget - optional proxy target

Throws:

MalformedObjectNameException - if the mbean name is invalid

Method Detail

isMBeanPattern

public boolean isMBeanPattern()

Whether this key embraces a MBean pattern

Returns:

true if the the included MBean is a pattern

matches

public boolean matches(HistoryKey pKey)

Whether the key matches the given MBean name

Parameters:

pKey - to match

Returns:

true if the given mbean matches the Mbean encapsulated by this key

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object