org.hawkular.agent.monitor.protocol.jmx

Class JolokiaJMXDriver

java.lang.Object

org.hawkular.agent.monitor.protocol.jmx.JMXDriver

org.hawkular.agent.monitor.protocol.jmx.JolokiaJMXDriver

All Implemented Interfaces:

Driver<JMXNodeLocation>

public class JolokiaJMXDriver
extends JMXDriver

The driver that will access a remote MBeanServer via the Jolokia REST API.

See Also:

Driver

Constructor Summary

Constructors

Constructor and Description
JolokiaJMXDriver(ProtocolDiagnostics diagnostics, org.jolokia.client.J4pClient client) Creates the JMX driver.

Method Summary

Modifier and Type	Method and Description
boolean	attributeExists(AttributeLocation<JMXNodeLocation> location) Returns true if the given attributeLocation exists on a MonitoredEndpoint or false otherwise.
Object	fetchAttribute(AttributeLocation<JMXNodeLocation> location) Fetches the attribute value specified by the given attributeLocation from a MonitoredEndpoint and returns it.
Map<JMXNodeLocation,Object>	fetchAttributeAsMap(AttributeLocation<JMXNodeLocation> location) Fetches the attribute value specified by the given attributeLocation from a MonitoredEndpoint and returns it as the values in the given map.
Map<JMXNodeLocation,ObjectName>	fetchNodes(JMXNodeLocation query) Fetches nodes that match the given query from a MonitoredEndpoint and returns them as an immutable Map.
org.jolokia.client.J4pClient	getClient()

Methods inherited from class org.hawkular.agent.monitor.protocol.jmx.JMXDriver

getDiagnostics

Methods inherited from class java.lang.Object

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

Constructor Detail

JolokiaJMXDriver

public JolokiaJMXDriver(ProtocolDiagnostics diagnostics,
                        org.jolokia.client.J4pClient client)

Creates the JMX driver.

Parameters:

diagnostics -

client - the client used to connect to the JMX MBeanServer

Method Detail

fetchNodes

public Map<JMXNodeLocation,ObjectName> fetchNodes(JMXNodeLocation query)
                                           throws ProtocolException

Description copied from interface: Driver

Fetches nodes that match the given query from a MonitoredEndpoint and returns them as an immutable Map. In a given entry in the returned map, the key is the location of the protocol specific node object that is stored in the value of the entry.

Parameters:

query - a pattern location to query for native resource nodes

Returns:

an immutable Map from locations to native resource nodes

Throws:

ProtocolException - on any problems related to the retrieval

attributeExists

public boolean attributeExists(AttributeLocation<JMXNodeLocation> location)
                        throws ProtocolException

Description copied from interface: Driver

Returns true if the given attributeLocation exists on a MonitoredEndpoint or false otherwise. This method should return true for attributes that exist but are unset.

Parameters:

location - the AttributeLocation to check

Returns:

true or false

Throws:

ProtocolException - on any problems related to the retrieval

fetchAttribute

public Object fetchAttribute(AttributeLocation<JMXNodeLocation> location)
                      throws ProtocolException

Description copied from interface: Driver

Fetches the attribute value specified by the given attributeLocation from a MonitoredEndpoint and returns it. If AttributeLocation.getLocation() is a path pattern containing wildcards, then this method MAY return a List of objects that contains the attribute values of matching attributes.

Parameters:

location - the attribute to retrieve

Returns:

the attribute value or null if there is no such attribute or if the attribute is unset.

Throws:

ProtocolException - on any problems related to the retrieval

fetchAttributeAsMap

public Map<JMXNodeLocation,Object> fetchAttributeAsMap(AttributeLocation<JMXNodeLocation> location)
                                                throws ProtocolException

Description copied from interface: Driver

Fetches the attribute value specified by the given attributeLocation from a MonitoredEndpoint and returns it as the values in the given map. Assumes the AttributeLocation.getLocation() is a multi-target path (e.g. it contains wildcards) and returns a map of all attribute values keyed on the resource location. If attributeLocation is not multi-targeted the map will just contain a single entry. Use this method (as opposed to Driver.fetchAttribute(AttributeLocation)) if you need to know which resource locations returned which attribute values. The values returned are the same in both methods, this just allows you to correlate which location returned which value.

Parameters:

location - the attribute to retrieve

Returns:

the attribute value or null if there is no such attribute or if the attribute is unset.

Throws:

ProtocolException - on any problems related to the retrieval

getClient

public org.jolokia.client.J4pClient getClient()