org.hawkular.agent.monitor.protocol.platform

Class PlatformDriver

java.lang.Object

org.hawkular.agent.monitor.protocol.platform.PlatformDriver

All Implemented Interfaces:

Driver<PlatformNodeLocation>

public class PlatformDriver
extends Object
implements Driver<PlatformNodeLocation>

Author:

Peter Palaga

See Also:

Driver

Constructor Summary

Constructors

Constructor and Description
PlatformDriver(OshiPlatformCache platform, ProtocolDiagnostics diagnostics)

Method Summary

Modifier and Type	Method and Description
boolean	attributeExists(AttributeLocation<PlatformNodeLocation> location) Returns true if the given attributeLocation exists on a MonitoredEndpoint or false otherwise.
Object	fetchAttribute(AttributeLocation<PlatformNodeLocation> location) Fetches the attribute value specified by the given attributeLocation from a MonitoredEndpoint and returns it.
Map<PlatformNodeLocation,PlatformResourceNode>	fetchNodes(PlatformNodeLocation location) Fetches nodes that match the given query from a MonitoredEndpoint and returns them as an immutable Map.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlatformDriver

public PlatformDriver(OshiPlatformCache platform,
                      ProtocolDiagnostics diagnostics)

Method Detail

fetchNodes

public Map<PlatformNodeLocation,PlatformResourceNode> fetchNodes(PlatformNodeLocation location)
                                                          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.

Specified by:

fetchNodes in interface Driver<PlatformNodeLocation>

Parameters:

location - 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<PlatformNodeLocation> 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.

Specified by:

attributeExists in interface Driver<PlatformNodeLocation>

Parameters:

location - the AttributeLocation to check

Returns:

true or false

Throws:

ProtocolException - on any problems related to the retrieval

fetchAttribute

public Object fetchAttribute(AttributeLocation<PlatformNodeLocation> 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.

Specified by:

fetchAttribute in interface Driver<PlatformNodeLocation>

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