org.eclipse.hyades.execution.local.util
Class AgentControllerDescriptor

java.lang.Object
  org.eclipse.hyades.execution.local.util.AgentControllerDescriptor

All Implemented Interfaces:

IAgentControllerDescriptor

public class AgentControllerDescriptor

extends java.lang.Object

implements IAgentControllerDescriptor

The agent controller descriptor class wraps a node instance and queries it for agent controller metadata as required. Information such as agent controller version can be discovered.

Constructor Summary

AgentControllerDescriptor(org.eclipse.hyades.internal.execution.local.control.Node node)
Constructs an agent controller descriptor object, used to gather metdata about the agent controller such as version

Method Summary

java.lang.String	getProperty(java.lang.String name, java.lang.String type) Retrieves a general property from the agent controller, given the name and type
java.lang.String	getVersion() Retrieves the version of the agent controller identified by the node instance argument
boolean	isVersionAtLeast(java.lang.String lowerLimitInclusive) Determines if the agent controller version is at least the specified lower limit inclusive value
boolean	isVersionAtMost(java.lang.String upperLimitInclusive) Determines if version is less than or equal to the upper limit inclusive value
boolean	isVersionEqual(java.lang.String version) Indicates if the version of the agent controller is exactly equal to the version passed in as an argument
boolean	isVersionWithin(java.lang.String lowerLimitInclusive, java.lang.String upperLimitInclusive) Indicates if the version of the agent controller is at least the lower limit version and at most the upper limit version inclusive

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentControllerDescriptor

public AgentControllerDescriptor(org.eclipse.hyades.internal.execution.local.control.Node node)

Constructs an agent controller descriptor object, used to gather metdata about the agent controller such as version

Parameters:

node - the node to query

Method Detail

getProperty

public java.lang.String getProperty(java.lang.String name,
                                    java.lang.String type)

Description copied from interface: IAgentControllerDescriptor

Retrieves a general property from the agent controller, given the name and type

Specified by:

getProperty in interface IAgentControllerDescriptor

Parameters:

name - the name of the property such as 'version'

type - the type of the value

Returns:

the property value returned as a string

getVersion

public java.lang.String getVersion()

Description copied from interface: IAgentControllerDescriptor

Retrieves the version of the agent controller identified by the node instance argument

Specified by:

getVersion in interface IAgentControllerDescriptor

Returns:

the version of the agent controller

isVersionAtLeast

public boolean isVersionAtLeast(java.lang.String lowerLimitInclusive)

Description copied from interface: IAgentControllerDescriptor

Determines if the agent controller version is at least the specified lower limit inclusive value

Specified by:

isVersionAtLeast in interface IAgentControllerDescriptor

Parameters:

lowerLimitInclusive - the version is must at least be

Returns:

true if the version is at least the given version

isVersionAtMost

public boolean isVersionAtMost(java.lang.String upperLimitInclusive)

Description copied from interface: IAgentControllerDescriptor

Determines if version is less than or equal to the upper limit inclusive value

Specified by:

isVersionAtMost in interface IAgentControllerDescriptor

Parameters:

upperLimitInclusive - the maximum version

Returns:

true if the version is at most the version specified

isVersionEqual

public boolean isVersionEqual(java.lang.String version)

Description copied from interface: IAgentControllerDescriptor

Indicates if the version of the agent controller is exactly equal to the version passed in as an argument

Specified by:

isVersionEqual in interface IAgentControllerDescriptor

Parameters:

version - the version that the agent controller must match

Returns:

true if the version matches precisely

isVersionWithin

public boolean isVersionWithin(java.lang.String lowerLimitInclusive,
                               java.lang.String upperLimitInclusive)

Description copied from interface: IAgentControllerDescriptor

Indicates if the version of the agent controller is at least the lower limit version and at most the upper limit version inclusive

Specified by:

isVersionWithin in interface IAgentControllerDescriptor

Parameters:

lowerLimitInclusive - the minimum version

upperLimitInclusive - the maximum version