org.hawkular.agent.monitor.protocol

Interface LocationResolver<L>

Type Parameters:

L - the type of the protocol specific location, typically a subclass of NodeLocation

All Known Implementing Classes:

DMRLocationResolver, JMXLocationResolver, PlatformLocationResolver

public interface LocationResolver<L>

A bunch of methods to manipulate with protocol specific locations. Note that all of the provided operations should be available offline.

Author:

Peter Palaga

Method Summary

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

Method Detail

findWildcardMatch

String findWildcardMatch(L multiTargetLocation,
                         L singleLocation)
                  throws ProtocolException

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.

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

boolean isMultiTarget(L location)

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.

Parameters:

location - the location to test

Returns:

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

absolutize

L absolutize(L base,
             L location)

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.

Parameters:

base - the base location to resolve location against

location - the location to resolve

Returns:

possibly a new resolved absolute location

absolutize

default AttributeLocation<L> absolutize(L base,
                                        AttributeLocation<L> attributeLocation)

isParent

boolean isParent(L parent,
                 L child)

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.

Parameters:

parent - parent resource

child - child resource

Returns:

true if child is a descendant of the parent

matches

boolean matches(L query,
                L location)

applyTemplate

String applyTemplate(String nameTemplate,
                     L location,
                     String endpointName)