org.hawkular.agent.monitor.protocol.jmx

Class JMXLocationResolver

java.lang.Object

org.hawkular.agent.monitor.protocol.jmx.JMXLocationResolver

All Implemented Interfaces:

LocationResolver<JMXNodeLocation>

public class JMXLocationResolver
extends Object
implements LocationResolver<JMXNodeLocation>

Author:

Peter Palaga

See Also:

LocationResolver

Constructor Summary

Constructors

Constructor and Description
JMXLocationResolver()

Method Summary

Modifier and Type	Method and Description
JMXNodeLocation	absolutize(JMXNodeLocation base, JMXNodeLocation location) Resolves the given location relative to the given base and returns the resolved location.
String	applyTemplate(String nameTemplate, JMXNodeLocation location, String endpointName)
String	findWildcardMatch(JMXNodeLocation multiTargetLocation, JMXNodeLocation singleLocation) Given a multi-target location (e.g.
boolean	isMultiTarget(JMXNodeLocation location) Returns true if the location could refer to more than one target.
boolean	isParent(JMXNodeLocation parent, JMXNodeLocation child) Returns true if the child is anywhere under the parent.
boolean	matches(JMXNodeLocation query, JMXNodeLocation location)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hawkular.agent.monitor.protocol.LocationResolver

absolutize

Constructor Detail

JMXLocationResolver

public JMXLocationResolver()

Method Detail

findWildcardMatch

public String findWildcardMatch(JMXNodeLocation multiTargetLocation,
                                JMXNodeLocation singleLocation)
                         throws ProtocolException

Description copied from interface: LocationResolver

Given a multi-target location (e.g. a location with a wildcard) and a single location, this returns that portion of the single location that matches the multi-target wildcard.

Specified by:

findWildcardMatch in interface LocationResolver<JMXNodeLocation>

Parameters:

multiTargetLocation - a query that was used to find the given singleLocation

singleLocation - a single absolute location that has the multiTargetLocation wildcard resolved

Returns:

the portion of the single location that matches the multi-target location wildcard

Throws:

ProtocolException - if the single location doesn't have any matching portion

isMultiTarget

public boolean isMultiTarget(JMXNodeLocation location)

Description copied from interface: LocationResolver

Returns true if the location could refer to more than one target. For example, this typically will return true if the location has a wildcard in it. Note that just because this returns true does not mean there are multiple targets; there could be 0 or 1 or more. It depends on what the wildcard matches.

Specified by:

isMultiTarget in interface LocationResolver<JMXNodeLocation>

Parameters:

location - the location to test

Returns:

true if location can refer to multiple targets, false if it refers to a single location

absolutize

public JMXNodeLocation absolutize(JMXNodeLocation base,
                                  JMXNodeLocation location)

Description copied from interface: LocationResolver

Resolves the given location relative to the given base and returns the resolved location. Note that this method can eventually return location or base if the resolution would yield a Location equivalent to any of the two.

Specified by:

absolutize in interface LocationResolver<JMXNodeLocation>

Parameters:

base - the base location to resolve location against

location - the location to resolve

Returns:

possibly a new resolved absolute location

isParent

public boolean isParent(JMXNodeLocation parent,
                        JMXNodeLocation child)

Description copied from interface: LocationResolver

Returns true if the child is anywhere under the parent. That means if the child is a direct descendant, is a grandchild, great-grandchild, etc, this will return true.

Specified by:

isParent in interface LocationResolver<JMXNodeLocation>

Parameters:

parent - parent resource

child - child resource

Returns:

true if child is a descendant of the parent

matches

public boolean matches(JMXNodeLocation query,
                       JMXNodeLocation location)

Specified by:

matches in interface LocationResolver<JMXNodeLocation>

applyTemplate

public String applyTemplate(String nameTemplate,
                            JMXNodeLocation location,
                            String endpointName)

Specified by:

applyTemplate in interface LocationResolver<JMXNodeLocation>